Feature

要素微件根据其弹出窗口模板显示图形。在您希望显示有关要素的信息但不使用弹出窗口的情况下，此微件非常有用。

当弹出窗口模板将 Arcade 表达式定义为在任何弹出窗口模板内容中引用的计算值或定义为表达式元素时，必须在要素微件中定义地图和 spatialReference 属性，以便 Arcade 执行。

另请参阅：

示例：

// Create graphic
let graphic = new Graphic({
  geometry: view.center,
  popupTemplate: {
    content: [{
      // add popupTemplate content
    }]
  }
});

// map and spatialReference must be set for Arcade
// expressions to execute and display content
let feature = new Feature({
  graphic: graphic,
  map: map,
  spatialReference: spatialReference
});

view.ui.add(feature, "top-right");

构造函数

new Feature(properties)

参数：

properties Object

optional

有关可能传递到构造函数中的所有属性的列表，请参阅属性。

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。

显示继承的属性

隐藏继承的属性

类型	描述	类：
String\|HTMLElement	更多详情表示包含微件的 DOM 元素的 ID 或节点。	更多详情	Widget
String	更多详情类的名称。	更多详情	Accessor
Boolean	更多详情允许为已启用弹出窗口但未定义弹出窗口模板的图层自动创建弹出窗口模板。	更多详情	Feature
Graphic	更多详情用于表示要素的图形。	更多详情	Feature
Number	更多详情指示要用于要素微件标题的标题级别。	更多详情	Feature
String	更多详情创建微件时分配给微件的唯一 ID。	更多详情	Widget
String	更多详情微件的默认标注。	更多详情	Feature
Map	更多详情对视图的地图的引用。	更多详情	Feature
SpatialReference	更多详情用于Arcade操作的空间参考。	更多详情	Feature
String	更多详情要素的标题。	更多详情	Feature
MapView\|SceneView	更多详情对 MapView 或 SceneView 的引用。	更多详情	Feature
FeatureViewModel	更多详情此微件的视图模型。	更多详情	Feature
Boolean	更多详情指示微件是否可见。	更多详情	Widget
VisibleElements	更多详情显示在微件的 graphic.popupTemplate.content 中的可见元素。	更多详情	Feature

属性详细信息

container String|HTMLElement inherited

表示包含微件的 DOM 元素的 ID 或节点。此属性只能设置一次。以下示例是使用微件时的所有有效用例。

示例：

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Stringreadonly inherited

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

defaultPopupTemplateEnabled Boolean 起始版本：GeoScene API for JavaScript 4.11

允许为已启用弹出窗口但未定义弹出窗口模板的图层自动创建弹出窗口模板。支持 createPopupTemplate 方法的图层支持自动弹出模板。（支持 FeatureLayer、GeoJSONLayer、SceneLayer、CSVLayer、OGCFeatureLayer PointCloudLayer、StreamLayer 和 ImageryLayer）。

默认值：false

graphic Graphic

用于表示要素的图形。

默认值：null

另请参阅：

PopupTemplate.content

示例：

let graphic = new Graphic({
  geometry: view.center,
  attributes: {
    "name": "Spruce",
    "family": "Pinaceae",
    "count": 126
  },
  symbol: new SimpleMarkerSymbol({
    style: "square",
    color: "blue",
    size: "8px"
  }),
  popupTemplate: {
    content: [
      {
        // Set popup template content
      }
    ]
  }
});

headingLevel Number 起始版本：GeoScene API for JavaScript 4.20

指示要用于要素微件标题的标题级别。默认情况下，标题呈现为 2 级标题（例如 <h2>Title of content</h2>）。根据微件在应用中的位置，您可能需要调整此标题以获得正确的语义。这对于满足辅助功能标准非常重要。

默认值：2

另请参阅：

Heading Elements

示例：

// feature title will render as an <h3>
feature.headingLevel = 3;

id String inherited

创建微件时分配给构件的唯一 ID。如果未由开发人员设置，它将默认为容器 ID，或者如果不存在，则将自动生成。

label String

微件的默认标注。

map Map 起始版本：GeoScene API for JavaScript 4.11

对视图的地图的引用。当需要访问地图中的基础图层时，请使用此属性。在要素微件或图层的弹出窗口模板中定义 Arcade表达式时，这是必需的。

默认值：null

另请参阅：

示例：

// The building footprints represent the buildings that intersect a clicked parcel
let buildingFootprints = Intersects($feature, FeatureSetByName($map, "Building Footprints"));

spatialReference SpatialReference 起始版本：GeoScene API for JavaScript 4.11

用于 Arcade 操作的空间参考。

默认值：null

另请参阅：

title Stringreadonly

要素的标题。您可以通过 visibleElements 属性禁用此功能。

默认值：null

另请参阅：

headingLevel

view MapView|SceneView

对 MapView 或 SceneView 的引用。设置此选项可将微件链接到特定视图。

viewModel FeatureViewModelautocast

此微件的视图模型。这是一个包含控制此微件行为的所有逻辑（属性和方法）的类。请参阅 FeatureViewModel 类以访问微件上的所有属性和方法。

visible Boolean inherited

指示微件是否可见。

如果 false，则该微件将不再呈现在 web 文档中。这可能会影响文档中其他元素或微件的布局。例如，如果此微件是与视图 UI 右上角关联的三个微件中的第一个，则当此微件变为不可见时，其他微件将重新定位。有关详细信息，请参阅 "none" 的 CSS 显示值。

默认值：true

示例：

// Hides the widget in the view
widget.visible = false;

visibleElements VisibleElementsautocast 起始版本：GeoScene API for JavaScript 4.11

显示在微件的 graphic.popupTemplate.content 中的可见元素。此属性提供了打开/关闭微件显示的各个元素的功能。有关这些元素如何工作的其他信息，请参阅 PopupTemplate.content 文档。

另请参阅：

PopupTemplate.content

方法概述

显示继承的方法

隐藏继承的方法

返回类型	描述	类：
String	更多详情用于为微件的 `class` 属性构建值的实用程序方法。	更多详情	Widget
	更多详情销毁微件实例。	更多详情	Widget
Boolean	更多详情在实例上发出事件。	更多详情	Widget
Boolean	更多详情指示实例上是否存在与提供的事件名称匹配的事件侦听器。	更多详情	Widget
Boolean	更多详情 `isFulfilled()` 可用于验证是否满足类的创建实例（已解决或已拒绝）。	更多详情	Widget
Boolean	更多详情 `isRejected()` 可用于验证创建类的实例是否被拒绝。	更多详情	Widget
Boolean	更多详情 `isResolved()` 可用于验证是否解析了类的创建实例。	更多详情	Widget
	更多详情分页到下一个媒体信息。	更多详情	Feature
Object	更多详情在实例上注册事件处理程序。	更多详情	Widget
	更多详情微件拆解助手。	更多详情	Widget
	更多详情此方法主要由开发人员在实现自定义微件时使用。	更多详情	Widget
	更多详情分页到指定媒体内容元素中的上一个媒体信息。	更多详情	Feature
Object	更多详情此方法主要由开发人员在实现自定义微件时使用。	更多详情	Widget
	更多详情立即将微件呈现到 DOM。	更多详情	Widget
	更多详情此方法主要由开发人员在实现自定义微件时使用。	更多详情	Widget
	更多详情分页到指定的媒体信息对象。	更多详情	Feature
Promise	更多详情 `when()` 可以在创建类的实例后利用。	更多详情	Widget

方法详细信息

classes(classNames){String}inherited

用于为微件的 class 属性构建值的实用程序方法。这有助于简化 CSS 类设置。

参数：

classNames String|String []|Object

repeatable

类名称

类型	说明
String	计算的类名。

另请参阅：

指南 - 微件开发（渲染）

示例：

// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

destroy()inherited

销毁微件实例。

emit(type, event){Boolean}inherited

在实例上发出事件。仅当创建此类的子类时，才应使用此方法。

参数：

type String

事件的名称。

event Object

optional

事件负载。

类型	说明
Boolean	`true` 如果听取了侦听者的通知

hasEventListener(type){Boolean}inherited

指示实例上是否存在与提供的事件名称匹配的事件侦听器。

参数：

type String

事件的名称。

类型	说明
Boolean	如果类支持输入事件，则返回 true。

isFulfilled(){Boolean}inherited 起始版本：GeoScene API for JavaScript 4.19

isFulfilled() 可用于验证是否满足类的创建实例（已解决或已拒绝）。如果已完成，将返回 true。

类型	说明
布尔值	指示是否已完成创建类的实例（已解决或已拒绝）。

isRejected(){Boolean}inherited 起始版本：GeoScene API for JavaScript 4.19

isRejected() 可用于验证创建类的实例是否被拒绝。如果被拒绝，将返回 true。

类型	说明
布尔值	指示创建类的实例是否已被拒绝。

isResolved(){Boolean}inherited 起始版本：GeoScene API for JavaScript 4.19

isResolved() 可用于验证是否解析了类的创建实例。如果被解析，将返回 true。

类型	说明
布尔值	指示是否已解析创建类的实例。

nextMedia(contentElementIndex)

分页到下一个媒体信息。

参数：

contentElementIndex Number

媒体内容元素的索引位置。

on(type, listener){Object}inherited

在实例上注册事件处理程序。调用此方法将事件与侦听器挂钩。

参数：

type String|String []

要侦听的事件或事件数组。

listener Function

事件激发时要调用的函数。

类型说明

Object

返回具有 remove() 方法的事件处理程序，应调用该方法以停止侦听事件。

属性	类型	说明
remove	函数	调用时，从事件中删除侦听器。

示例：

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handles)inherited

微件拆解助手。当微件被销毁时，添加到其中的任何句柄都将自动删除。

参数：

handles WatchHandle|WatchHandle []

在微件被销毁后标记为删除的句柄。

postInitialize()inherited

此方法主要由开发人员在实现自定义微件时使用。在微件准备好进行渲染后执行。

previousMedia(contentElementIndex)

分页到指定媒体内容元素中的上一个媒体信息。

参数：

contentElementIndex Number

媒体内容元素的索引位置。

render(){Object}inherited

此方法主要由开发人员在实现自定义微件时使用。它必须由子类实现以进行渲染。

类型	说明
Object	渲染的虚拟节点。

renderNow()inherited

立即将微件呈现到 DOM。

scheduleRender()inherited

此方法主要由开发人员在实现自定义微件时使用。计划微件渲染。此方法对于影响 UI 的更改很有用。

setActiveMedia(contentElementIndex, mediaInfoIndex)

分页到指定的媒体信息对象。例如，您可能具有包含多个 mediaInfos 的媒体内容。此方法允许您指定要显示的 mediaInfos 的索引。

在版本 4.17 之前，此方法被命名为 goToMedia。

参数：

contentElementIndex Number

要更新的媒体内容元素的索引位置。

mediaInfoIndex Number

要显示的媒体信息对象的索引位置。

when(callback, errback){Promise}inherited 起始版本：GeoScene API for JavaScript 4.19

when() 可以在创建类的实例后利用。此方法采用两个输入参数：callback 函数和 errback 函数。在类的实例加载时执行 callback。如果类的实例无法加载，则执行 errback。

参数：

callback Function

optional

解析 promise 时要调用的函数。

errback Function

optional

promise 失败时要执行的函数。

类型	说明
Promise	返回回调结果的新 promise，`callback` 结果可用于链接其他函数。

示例：

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

类型定义

VisibleContentElements

属性：

attachments Boolean

optional

默认值：true

指示是否显示任何 AttachmentsContent 元素。

fields Boolean

optional

默认值：true

指示是否显示任何 FieldsContent 元素。

media Boolean

optional

默认值：true

指示是否显示任何 MediaContent 元素。

text Boolean

optional

默认值：true

指示是否显示任何 TextContent 元素。

expression Boolean

optional

默认值：true

指示是否显示任何 ExpressionContent 元素。定义表达式元素的内容时，必须定义 map 和 spatialReference 属性，以便表达式在微件中执行和渲染内容。

VisibleElements

属性：

title Boolean

optional

默认值：true

指示是否显示与要素关联的标题。

content Boolean|VisibleContentElements

optional

默认值：true

指示是否显示要素的内容，也可以通过 VisibleContentElements 设置来指示特定类型的内容元素。

lastEditInfo Boolean

optional

默认值：true

指示是否在要素中显示 lastEditInfo。

GeoScene API for JavaScript参考手册

构造函数

属性概述

属性详细信息

方法概述

方法详细信息

类型定义