InputField

属性概述

属性详细信息

declaredClass Stringreadonly inherited

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

description Stringreadonly

字段的说明。

domain CodedValueDomain|RangeDomainreadonly

输入值的域。这用于约束图层的允许值。

editable Booleanreadonly

如果为 true，则可以编辑字段。

editorType Stringreadonly

处理 string 字段时，使用的编辑器类型。下表列出了可能的值。

值	描述
text-box	用于捕获输入的 HTML 文本框。
text-area	用于捕获输入的 HTML 文本区域。

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

默认值：text-box

error Stringreadonly

如果输入字段的值无效，则此属性将返回验证错误代码。否则，它是 null。

errorMessage Stringreadonly

基于验证错误代码的用户友好型格式化的错误消息。

group InputFieldGroupreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.10

此输入字段所属的组。

hint Stringreadonly

字段值的提示。将此设置为 TextAreaInput 或 TextBoxInput 中文本/数字输入的临时占位符。

includeTime Stringreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.17

对于日期输入，这将启用时间输入部分。

默认值：{true}

label Stringreadonly

字段的标注。

maxLength Numberreadonly

限制输入长度。

minLength Numberreadonly

限制输入长度。

name Stringreadonly

关联的字段名称。

required Booleanreadonly

指示该字段是否为必填字段。

submittable Booleanreadonly

如果为 true，则可以在不引入数据验证问题的情况下提交此值。

type Stringreadonly

输入字段的类型。下面列出了可能的值。

值	描述
number	输入表示一个数字。
text	输入表示文本。
date	输入表示日期。
unsupported	该字段表示不受支持的值。blob 字段类型就是一个示例。

可能值："number"|"text"|"date"|"unsupported"

updating Booleanreadonly

如果此 InputField 具有为 valueExpression 或 editableExpression 定义的值，当其中一个或两个表达式当前正在执行时，此属性将为 true；否则，这将是 false。

valid Booleanreadonly

当为 true 时，输入值有效。否则，它将无效。

value Number|String|nullreadonly

输入值。

visible Booleanreadonly

当为 true 时，将显示该字段。否则，它将隐藏。

方法概述

方法详细说明

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