FieldInfo

AMD: require(["geoscene/popup/FieldInfo"], (FieldInfo) => { /* 代码 */ });
ESM: import FieldInfo from "@geoscene/core/popup/FieldInfo";
类: geoscene/popup/FieldInfo
继承于: FieldInfo Accessor
起始版本: GeoScene API for JavaScript 4.22

FieldInfo定义 Field 如何参与或在某些情况下不参与 PopupTemplate

示例:
示例代码:
let fieldInfo = new FieldInfo({
  fieldName: 'PROMINENCE_ft',
  label: 'Prominence (feet)',
  //自动转换为 FieldInfo.Format
  format: {
    places: 0,
    digitSeparator: true
  }
};

构造函数

new FieldInfo(properties)
参数:
properties Object
optional

所有可传入构造函数的属性,请参见属性列表

属性列表

可以设置、检索或监听的属性。参见 使用属性
展示继承属性 隐藏继承属性
属性 类型 描述
String更多信息

类名。

更多信息Accessor
String更多信息

服务定义的字段名称或 Arcade 表达式的名称。

更多信息FieldInfo
FieldInfoFormat更多信息

为数字或日期字段提供格式选项以及决定它们应如何在弹出窗口中显示。

更多信息FieldInfo
Boolean更多信息

用户是否可以编辑。

更多信息FieldInfo
String更多信息

字段别名。

更多信息FieldInfo
String更多信息

在 one:many(一对多) 或者 many:many(多对多) 关系中用于计算要在弹出窗口中显示的字段的统计信息。

更多信息FieldInfo
String更多信息

编辑字段时的输入框类型

更多信息FieldInfo
String更多信息

为字段编辑器提供编辑提示的字符串。

更多信息FieldInfo
Boolean更多信息

指示该字段是否在弹出窗口中可见。

更多信息FieldInfo

属性详细说明

declaredClass Stringreadonly inherited

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

fieldName String

服务定义的字段名称或 Arcade 表达式的名称。Arcade 表达式名称在 PopupTemplate 的 expressionInfos 被定义。 引用 Arcade 表达式时,必须在名称前加上expression/,例如 expression/percent-total

示例:

为数字或日期字段提供格式选项以及它们应如何在弹出窗口中显示的类。

为需要为图表/文本元素设置数字格式的任何字段设置 popupTemplate.fieldInfos 属性。

isEditable Boolean

确定用户是否可以编辑此字段的布尔值。这不适用于 Arcade 表达式。

默认值:false
label String

包含字段别名的字符串。当使用了标题时,不适用于 Arcade 表达式。

statisticType String

在 one:many(一对多) 或者 many:many(多对多) 关系中用于计算要在弹出窗口中显示的字段的统计信息。 如果该属性存在,则必须是以下值之一:

可选值:"count"|"sum"|"min"|"max"|"avg"|"stddev"|"var"

stringFieldOption String

确定编辑者在编辑字段时看到的输入框类型。仅适用于字符串字段,并不适用于 Arcade 表达式。如果此属性存在,则它必须是以下值之一:

可选值:"rich-text"|"text-area"|"text-box"

默认值:text-box
tooltip String

为字段编辑器提供编辑提示的字符串。这不适用于 Arcade 表达式。

visible Boolean

指示该字段是否在弹出窗口中可见。

目前,默认 Popup 不再显示不具有重要价值的系统字段,例如Shape__AreaShape__Length

默认值:true

方法列表

属性 返回值类型 描述
FieldInfo更多信息

创建 FieldInfo 类的深拷贝。

更多信息FieldInfo
*更多信息

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

更多信息FieldInfo
Object更多信息

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

更多信息FieldInfo

方法详细说明

clone(){FieldInfo}

创建 FieldInfo 类的深拷贝。

返回值:
类型 描述
FieldInfo FieldInfo 实例的深拷贝
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()

返回值:
类型 描述
Object 此类实例的 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.