FormTemplate

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

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

可以直接在 FeatureLayerFeatureForm 或其 view model 上设置 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
可选

有关可能传递到构造函数中的所有属性的列表,请参阅属性

属性概述

可以设置、检索或收听任何属性。请查阅使用属性主题。
显示继承的属性 隐藏继承的属性
名称 类型 描述
String更多信息

类的名称。

更多信息Accessor
String更多信息

表单的描述。

更多信息FormTemplate
Element[]更多信息

一个表单元素对象数组,这些对象表示表单元素的有序列表。

更多信息FormTemplate
ExpressionInfo[]更多信息

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

更多信息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。表单计算表达式必须返回字符串、日期或数字

另请参阅:
title String

用于定义如何设置弹出窗口中使用的标题的格式的字符串模板。这将显示在窗体的顶部。

方法概述

名称 返回类型 描述
FormTemplate更多信息

创建 FormTemplate 类的深层克隆。

更多信息FormTemplate
*更多信息

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

更多信息FormTemplate
对象更多信息

将此类的实例转换为其 GeoScene portal JSON 表现形式。

更多信息FormTemplate

方法详情

clone(){FormTemplate}

创建 FormTemplate 类的深层克隆。

返回:
类型 说明
FormTemplate FormTemplate 类的深层克隆。
fromJSON(json){*}static

创建此类的新实例,并使用从 Geoscene 产品生成的 JSON 对象中的值对其进行初始化。传递到输入 json 数的对象通常来自对 REST API 中的查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。请参阅指南中的 fromJSON() 主题,了解有关何时以及如何使用此功能的详细信息和示例。

参数:
json Object

GeoScene 格式的实例的 JSON 表示形式。有关各种输入 JSON 对象的结构示例,请参阅 GeoScene REST API 文档

返回:
类型 说明
* 返回此类的新实例。
toJSON(){Object}

将此类的实例转换为其 GeoScene portal JSON 表现形式。有关更多信息,请参阅 fromJSON() 主题。

返回:
类型 说明
对象 此类实例的 GeoScene portal JSON 表现形式。

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.