• geoscene/popup

FieldInfo

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

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

另请参阅
示例
let fieldInfo = new FieldInfo({
  fieldName: 'PROMINENCE_ft',
  label: 'Prominence (feet)',
  //autocasts to 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:manymany: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:manymany:many 关系中用于计算要在弹出窗口中显示的字段的统计信息。如果属性存在,则必须是以下值之一:

可能值"count"|"sum"|"min"|"max"|"avg"|"stddev"|"var"

stringFieldOption String

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

可能值"rich-text"|"text-area"|"text-box"

默认值:text-box
tooltip String

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

visible Boolean

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

从 4.16 版本开始,已改进默认 Popup,不再显示不包含重要值的系统字段,例如,Shape__AreaShape__Length 是两个不再显示的字段。

默认值:true

方法概述

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

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

更多详情
Accessor
FieldInfo

创建 FieldInfo 类的深度克隆。

更多详情
FieldInfo
*

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

更多详情
FieldInfo
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
FieldInfo

方法详细说明

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() 进行删除。如果未提供键,则句柄将被添加到默认组。

clone(){FieldInfo}

创建 FieldInfo 类的深度克隆。

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

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

参数
json Object

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

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

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