FieldConfig

属性概述

属性详细信息

declaredClass Stringreadonly inherited

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

description String

起始版本：GeoScene Maps SDK for JavaScript 4.10

字段的说明。说明显示在字段下方。

domain CodedValueDomain|RangeDomain

起始版本：GeoScene Maps SDK for JavaScript 4.10

字段的域。这用于约束图层的允许值。

这仅适用于相关字段类型。例如，RangeDomain 仅适用于 numeric 和 date 字段类型。

editable Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.10

指示是否可以编辑字段。

这不会更改基础服务的字段以及是否可以编辑它。

默认值：true

hint String

起始版本：GeoScene Maps SDK for JavaScript 4.10

此属性在 FeatureForm 微件中渲染为工具提示。它显示属性字段值的提示。

includeTime Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.17

指示日期字段是否应显示编辑时间的输入。

默认值：true

label String

起始版本：GeoScene Maps SDK for JavaScript 4.10

字段的标注。标注显示在字段上方。

maxLength Number

起始版本：GeoScene Maps SDK for JavaScript 4.10

限制输入长度。

这仅适用于 numeric 和 text 字段类型。

默认值：-1

minLength Number

起始版本：GeoScene Maps SDK for JavaScript 4.16

限制输入长度。

这仅适用于 numeric 和 text 字段类型。

默认值：-1

name String

字段名称。

required Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.10

指示该字段是否为必填字段。

这无法更改基础服务的字段要求。

默认值：false

requiredExpression String

起始版本：GeoScene Maps SDK for JavaScript 4.16

对在 FeatureForm 的 expressionInfos 中定义的 Arcade 表达式 表达式的名称的引用。表达式必须遵循约束 Arcade 配置文件定义的规范。表达式可以使用 $feature 配置变量来引用字段值，并且必须返回 true 或 false。

当此表达式的计算结果为 true 并且元素可见时，元素必须具有有效值才能创建或编辑要素。当表达式的计算结果为 false 时，不需要该元素。如果未提供表达式，则默认行为是不需要该元素。如果引用的字段不可为空，则忽略所需的表达式并且始终需要该元素。

另请参阅

• 约束 Arcade 配置文件

visibilityExpression String

起始版本：GeoScene Maps SDK for JavaScript 4.11

对在 FeatureForm 的 expressionInfos 中定义的 Arcade 表达式 表达式的名称的引用。表达式必须遵循约束 Arcade 配置文件定义的规范。表达式可以使用 $feature 配置变量来引用字段值，并且必须返回 true 或 false。

当此表达式的计算结果为 true 时，将显示该元素。当表达式的计算结果为 false 时，不显示该元素。如果未提供表达式，则默认行为是显示元素。在定义非空字段的可见性表达式时必须小心，即，确保此类字段具有默认值或对用户可见，以便他们可以在提交表单之前提供值。

这仅影响字段的渲染方式。它对属性的值没有任何影响。

默认值：null

另请参阅

• 约束 Arcade 配置文件

示例

// Array of two field configurations.
// The first one displays the feature's status whereas
// the second one only displays if the resolution of
// the issue if the status is "Completed"
// and the resolution value is not null.

fieldConfig: [{
  name: "status",
  editable: false, // not an editable field
  label: "Issue status",
  description: "E.g. submitted, received, in progress, or completed."
},{
  name: "resolution",
  label: "Resolution",
  editable: false,
  description: "Resolution if status is 'Completed'",
  visibilityExpression: "($feature.status == 'Completed') && (!(IsEmpty($feature.resolution)))"
}]

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

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");