• geoscene/popup

ExpressionInfo

AMD: require(["geoscene/popup/ExpressionInfo"], (ExpressionInfo) => { /* code goes here */ });
ESM: import ExpressionInfo from "@geoscene/core/popup/ExpressionInfo";
类: geoscene/popup/ExpressionInfo
继承于:ExpressionInfo Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.11

ExpressionInfo 类引用 Arcade 表达式 表达式,这些表达式遵循 Arcade 弹出配置文件定义的规范。表达式必须返回字符串或数字,并可以使用 $feature$layer$map$datastore 配置变量访问地图或数据存储中的要素、其图层或其他图层的数据值。

表达式名称在图层的 PopupTemplate 中被引用,并在图层的弹出窗口打开时执行。这些值被视为字段值显示在视图的弹出窗口中。可以使用 popupTemplate 内容的 FieldInfo 将它们显示在一个表格中,或在简单字符串中进行引用。

另请参阅
示例
// Display a table in the popup's content referencing two values
// one from a field, and another returned from an Arcade expression
layer.popupTemplate = {
  title: "Population in {NAME}",
  content: [{
    type: "fields",
    fieldInfos: [{
      fieldName: "POP_2015",
      label: "Total population (2015)",
      format: {
        digitSeparator: true
      }
    }, {
      fieldName: "expression/per-asian"
    }]
  }]
};

构造函数

new ExpressionInfo(properties)
参数
properties Object
optional

有关可能传递给构造函数的所有属性的列表,请参见属性

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
String

遵循 Arcade 弹出配置文件定义的规范的 Arcade 表达式 表达式。

更多详情
ExpressionInfo
String

表达式的名称。

更多详情
ExpressionInfo
String

指示 Arcade 表达式的返回类型。

更多详情
ExpressionInfo
String

用于描述弹出窗口中表达式返回值的标题。

更多详情
ExpressionInfo

属性详细信息

declaredClass Stringreadonly inherited

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

expression String

遵循 Arcade 弹出配置文件定义的规范的 Arcade 表达式 表达式。表达式必须返回字符串或数字,并可以使用 $feature$layer$map$datastore 配置变量访问地图或数据存储中的要素、其图层或其他图层的数据值。

另请参阅
示例
// Calculates the percentage of the population that is Asian
expressionInfo.expression = "Text($feature.Asian / $feature.TOT_POP, '#.#%')";
name String

表达式的名称。可将其用于在 popupTemplate 的 content 属性中引用给定 expression 的值,方法为使用花括号括起来,并在前面加上 expression/ (例如,{expression/expressionName})。

示例
expressionInfo.name = "percent-asian";
returnType String

指示 Arcade 表达式的返回类型。

可能值"string"|"number"

title String

用于描述弹出窗口中表达式返回值的标题。如果该值在 FieldInfo 表中引用,则会显示该值。

示例
expressionInfo.title = "Percent Asian";

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象的生命周期相关联的句柄。

更多详情
Accessor
ExpressionInfo

创建 ExpressionInfo 类的深度克隆。

更多详情
ExpressionInfo
*

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

更多详情
ExpressionInfo
Boolean

如果存在指定的句柄组,则返回 true。

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

将此类的实例转换为 GeoScene Portal JSON 表示。

更多详情
ExpressionInfo

方法详细说明

addHandles(handleOrHandles, groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时,将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
参数
handleOrHandles WatchHandle|WatchHandle[]

对象销毁后,标记为要移除的句柄。

groupKey *
optional

标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键,则句柄将被添加到默认组。

创建 ExpressionInfo 类的深度克隆。

返回
类型 描述
ExpressionInfo ExpressionInfo 实例的深度克隆。
fromJSON(json){*}static

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

参数
json Object

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

返回
类型 描述
* 返回该类的新实例。
hasHandles(groupKey){Boolean}inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组,则返回 true。

参数
groupKey *
optional

组键。

返回
类型 描述
Boolean 如果存在指定的句柄组,则返回 true
示例
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数
groupKey *
optional

要移除的组键或组键的数组或集合。

示例
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。

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

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息