FieldConfig

属性概述

属性详细信息

declaredClass Stringreadonly inherited

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

description String

起始版本：GeoScene API for JavaScript 4.10

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

domain CodedValueDomain|RangeDomain

起始版本：GeoScene API for JavaScript 4.10

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

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

editable Boolean

起始版本：GeoScene API for JavaScript 4.10

指示是否可以编辑字段。

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

默认值：true

editorType String

起始版本：GeoScene API for JavaScript 4.10

已弃用自版本 4.16 起

用于 string 字段类型的编辑器类型。可能的值如下表所示。设置编辑器类型的首选方法是通过在 FeatureForm 的模板的字段元素中设置的 TextAreaInput 或 TextBoxInput 类。

值	说明
text-box	HTML 文本框将用于捕获输入。
text-area	HTML 文本区域将用于捕获输入。

可能的值："text-box"|"text-area"

默认值："text-box"

hint String

起始版本：GeoScene API for JavaScript 4.10

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

includeTime Boolean

起始版本：GeoScene API for JavaScript 4.17

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

默认值：true

label String

起始版本：GeoScene API for JavaScript 4.10

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

maxLength Number

起始版本：GeoScene API for JavaScript 4.10

限制输入长度。

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

默认值：-1

minLength Number

起始版本：GeoScene API for JavaScript 4.16

限制输入长度。

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

默认值：-1

name String

字段名称。

required Boolean

起始版本：GeoScene API for JavaScript 4.10

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

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

默认值：false

requiredExpression String

起始版本：GeoScene API for JavaScript 4.16

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

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

另请参阅：

• 约束 Arcade 配置文件

visibilityExpression String

起始版本：GeoScene API for JavaScript 4.11

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

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

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

默认值：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)))"
}]