• geoscene/form

FormTemplate

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

FormTemplate 可为特定图层图形设置和定义 FeatureForm 的内容。FormTemplate 允许用户在选择视图中的要素时访问要素属性中的值。

可直接在 FeatureLayerFeatureForm 或其视图模式上设置 FormTemplate。模板由显示特定类型的表单数据的各种元素组成。

另请参阅
示例
// Create the Form template and pass in elements
  const formTemplate = new FormTemplate({
  title: "Inspector report",
  description: "Enter all relevant information below",
  elements: [groupElement] // Add all elements to the template
});

// Add a new feature form with grouped fields
const form = new FeatureForm({
  container: "form",
  groupDisplay: "sequential", // only display one group at a time
  formTemplate: formTemplate // set it to template created above
});

构造函数

new FormTemplate(properties)
参数
properties Object
optional

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

属性概述

所有属性都可以设置、获取和监听。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
String

表单的描述。

更多详情
FormTemplate
Element[]

表单元素对象数组,表示表单元素的有序列表。

更多详情
FormTemplate
ExpressionInfo[]

对象数组或 ExpressionInfo[],引用遵循表单约束配置文件或表单计算配置文件定义的规范的 Arcade 表达式。

更多详情
FormTemplate
Boolean

指示是保留还是清除表单字段元素值。

更多详情
FormTemplate
String

字符串模板,用于定义如何格式化表单顶部显示的标题。

更多详情
FormTemplate

属性详细信息

declaredClass Stringreadonly inherited

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

description String

表单的描述。

表单元素对象数组,表示表单元素的有序列表。

元素旨在允许表单作者在收集和/或编辑数据时定义字段布局。

不支持嵌套的分组元素。

另请参阅
示例
// Create a new form template
const formTemplate = new FormTemplate({
  title: "Damage assessments",
  description: "Provide information for insurance",
  elements: [{ // Autocasts to new GroupElement
    type: "group",
    label: "Inspector Information",
    description: "Field inspector information",
    elements: [{
      // Autocasts to new FieldElement
      type: "field",
      fieldName: "inspector",
      label: "name"
    },{
      type: "field",
      fieldName: "inspemail",
      label: "Email address"
    },{
      type: "field",
      fieldName: "insp_date",
      label: "Date of inspection"
    }]
  }]
});
expressionInfos ExpressionInfo[]autocast

对象数组或 ExpressionInfo[],引用遵循表单约束配置文件或表单计算配置文件定义的规范的 Arcade 表达式。表单约束表达式必须返回 truefalse。表单计算表达式必须返回字符串、日期或数字。

另请参阅
preserveFieldValuesWhenHidden Boolean
起始版本:GeoScene Maps SDK for JavaScript 4.25

指示是保留还是清除表单字段元素值。当字段元素最初显示为可见,但由于应用了 visibilityExpression 而更新为不显示时,请使用此属性。

另请参阅
title String

字符串模板,用于定义如何格式化表单顶部显示的标题。

方法概述

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

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

更多详情
Accessor
FormTemplate

创建 FormTemplate 类的深度克隆。

更多详情
FormTemplate
*

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

更多详情
FormTemplate
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
FormTemplate

方法详细说明

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

this.addHandles(handle);

// Destroy the object
this.destroy();
参数
handleOrHandles WatchHandle|WatchHandle[]

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

groupKey *
optional

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

clone(){FormTemplate}

创建 FormTemplate 类的深度克隆。

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

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。

参数
json Object

GeoScene 格式实例的 JSON 表示。

返回
类型 描述
* 返回该类的新实例。
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 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。