• geoscene/form

ExpressionInfo

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

ExpressionInfo 类定义了可见性表达式必需表达式可编辑表达式值表达式的组成。表达式是在字段元素上设置的,(可见性表达式组元素上也可用)。这些元素直接包含在 FeatureForm 或 FeatureLayer 上的 formTemplate 集合中。

上面提到的所有 Arcade 表达式 表达式 (不包括值表达式) 必须遵循约束配置文件中定义的规范。此配置文件可以使用 $feature 变量引用字段值,且表达式必须返回 truefalse

值表达式必须遵循表单计算配置文件中定义的规范。它可以在单个 $feature 或其他图层中引用字段值,并且必须返回日期、数字或字符串值。计算表达式后,表单的字段值将更新为表达式的结果。

在实例化 FeatureForm 微件并利用使用 $map 变量的表达式时,需要设置 view 属性。

另请参阅

构造函数

new ExpressionInfo(properties)
参数
properties Object
optional

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

属性概述

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

类的名称。

更多详情
Accessor
String

遵循约束表单计算配置文件定义的规范的 Arcade 表达式 表达式。

更多详情
ExpressionInfo
String

表达式的名称。

更多详情
ExpressionInfo
String

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

更多详情
ExpressionInfo
String

用于描述表达式返回值的标题。

更多详情
ExpressionInfo

属性详细信息

declaredClass Stringreadonly inherited

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

expression String

遵循约束表单计算配置文件定义的规范的 Arcade 表达式 表达式。可见性表达式必需表达式可编辑表达式遵循约束配置文件中定义的规范。这些表达式可以使用 $feature 配置变量引用字段值,并且必须返回 truefalse

值表达式遵循表单计算配置文件中定义的规范。当使用值表达式时,可用的配置文件变量不仅仅是 $feature,因为也可访问正在显示的单个要素以外的值。

另请参阅
示例
// Sets the visibility of a field in the form template only if the date is within the last 24 hours.
expressionInfo.expression = "IIF(DateDiff(Now(), $feature.incident_date, 'hours') < 24)";
name String

表达式的名称。将此名称设置为其各自元素的可见性表达式必需表达式可编辑表达式和/或值表达式属性。

示例
expressionInfo.name = "withinRange";
returnType String

指示 Arcade 表达式的返回类型。在 FeatureForm 表达式中,returnType 可以是 booleandatenumberstring。这取决于所使用的表达式类型。例如,可见性表达式必需表达式可编辑表达式仅返回布尔值,而值表达式则返回 datenumberstring

可能值"boolean"|"date"|"number"|"string"

另请参阅
title String

用于描述表达式返回值的标题。

示例
expressionInfo.title = "Did the incident occur within the last 24 hours?";

方法概述

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

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

更多详情
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 表示。

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