CustomContent

AMD: require(["geoscene/popup/content/CustomContent"], (CustomContent) => { /* 代码 */ });
ESM: import CustomContent from "@geoscene/core/popup/content/CustomContent";
类: geoscene/popup/content/CustomContent
继承于: CustomContent Content Accessor
起始版本: GeoScene API for JavaScript 4.22

CustomContent 提供一种自定义 popup 内容的方法。 这些内容可以是诸如 String, HTMLElement, Widget和 Promise或这些元素的组合。

示例:
示例代码:
// 为CustomContent弹出元素创建自定义内容 
// 创建一些自定义内容 
let customContentWidget = new CustomContent({ outFields: ["*"], creator: (function(graphic)) { // creator返回函数字符串、HtmleElement 、WidgetPromise });

构造函数

new CustomContent(properties)
参数:
properties Object
optional

所有可传入构造函数的属性,请参见属性列表

属性列表

可以设置、检索或监听的属性。参见 使用属性
展示继承属性 隐藏继承属性
属性 类型 描述
PopupTemplateContentCreator更多信息

为创建自定义内容元素而调用的函数。

更多信息CustomContent
String更多信息

类名。

更多信息Accessor
PopupTemplateContentDestroyer更多信息

不再需要时清理自定义内容的调用函数。

更多信息CustomContent
String[]更多信息

PopupTemplate 中使用的字段名称数组

更多信息CustomContent
String更多信息

显示的弹出元素的类型。

更多信息CustomContent

属性详细说明

为创建自定义内容元素而调用的函数。确保outFields在此自定义内容中指定。

示例:
示例代码:
// 包含 widget 的自定义元素
let customContentWidget = new CustomContent({
  outFields: ["*"],
  creator: function() {
    home = new Home({
      view: view
    });
  return home;
  }
});
// 返回一个 promise 对象的自定义元素
let customContentWidget = new CustomContent({
  outFields: ["*"],
  creator: function() {
    promiseUtils.after(5).then(() => {
      const image = document.createElement("img");
      image.src = "<url to image>";
      image.width = 100;
      return image;
   });
  }
});
declaredClass Stringreadonly inherited

类名。类的名称声明格式为 geoscene.folder.className

不再需要时清理自定义内容的调用函数。

示例代码:
// 销毁自定义内容
let customContent = new CustomContent({
  ...
  destroyer: function() {
    // 销毁
  }
});
outFields String[]

PopupTemplate 中使用的字段名称数组使用此属性来指定完全呈现模板的自定义内容所需的字段。 如果需要通过函数来设置 content ,您必须在此处指定成功渲染所需的任何字段。 

使用 ["*"]从所有字段中获取值。

type Stringreadonly

显示的弹出元素的类型。

对于 CustomContent ,类型始终为 "custom"。

默认值:custom

方法列表

属性 返回值类型 描述
CustomContent更多信息

创建 CustomContent 类的深拷贝。

更多信息CustomContent
*更多信息

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象的值对其进行初始化。

更多信息CustomContent
Object更多信息

将此类的实例转换为其 GeoScene portal JSON 表示

更多信息CustomContent

方法详细说明

clone(){CustomContent}

创建 CustomContent 类的深拷贝。

返回值:
类型 描述
CustomContent 创建 CustomContent 实例的深拷贝。
fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象的值对其进行初始化。 传入的 json 对象通常来自对 REST API 中的查询操作的响应或另一个 GeoScene 产品的 toJSON() 方法。 有关如何使用此函数的详细信息请参阅指南中的 fromJSON() 主题。

参数:
json Object

GeoScene 格式的实例的 JSON 表示。有关各种输入JSON对象的结构示例,请参阅 GeoScene REST API 文档 。

返回值:
类型 描述
* 返回一个该类的新实例。
toJSON(){Object}

将此类的实例转换为其  GeoScene portal JSON 表示。 有关更多信息,请参阅 fromJSON() 。

返回值:
类型 描述
Object 此类实例的 GeoScene portal JSON 表示。

类型定义

PopupTemplateContentCreator(graphic){String|HTMLElement|Widget|Promise}

为创建自定义内容元素而调用的函数。

参数:
graphic Graphic

用于表示特征的 Graphic 。

返回值:
类型 描述
String | HTMLElement | Widget | Promise 创建自定义内容元素。
PopupTemplateContentDestroyer(graphic)

为销毁自定义内容元素而调用的函数。

参数:
graphic Graphic

用于表示特征的 Graphic 。

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.