FieldGroupConfig

AMD: require(["geoscene/widgets/FeatureForm/FieldGroupConfig"], (FieldGroupConfig) => { /* code goes here */ });
ESM: import FieldGroupConfig from "@geoscene/core/widgets/FeatureForm/FieldGroupConfig";
类: geoscene/widgets/FeatureForm/FieldGroupConfig
继承于:FieldGroupConfig Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.10
已弃用从 4.23 版开始。通过 GroupElement 设置字段分组。

用于配置分组字段的配置选项。

构造函数

new FieldGroupConfig(properties)
参数
properties Object
optional

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

属性概述

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

类的名称。

更多详情
Accessor
String

字段的说明。

更多详情
FieldGroupConfig
FieldConfig[]

属于一个组的字段配置数组。

更多详情
FieldGroupConfig
String

字段的标注。

更多详情
FieldGroupConfig
String

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

更多详情
FieldGroupConfig

属性详细信息

declaredClass Stringreadonly inherited

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

description String

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

属于一个组的字段配置数组。

如果在 FeatureFormEditor 微件中工作,请在表单的模板元素中通过 FieldElement(s)GroupElement(s) 设置字段配置。

label String

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

visibilityExpression String
起始版本:GeoScene Maps SDK for JavaScript 4.11
已弃用从 4.23 版开始。通过 GroupElement.visibilityExpression 设置字段

遵循约束 Arcade 配置文件定义的规范的 Arcade 表达式 表达式。表达式可以使用 $feature 配置变量来引用字段值,并且必须返回 truefalse

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

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

默认值:null
示例
// 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)))"
}]

方法概述

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

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

更多详情
Accessor
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor

方法详细说明

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

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