Field

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

有关图层中每个字段的信息。从客户端图形创建要素图层时,必须构造字段对象。此类允许您定义要素图层中每个字段的方案。请注意,您不需要将字段添加到从服务加载的 FeatureLayer 的构造函数中,因为这些字段已由服务定义。有关使用此模块的详细信息,请参阅下面的示例。

示例:
示例代码:
// 此数组中的每个对象都自动转换为 geoscene/layers/support/Field 的实例
let fields = [
  {
    name: "ObjectID",
    alias: "ObjectID",
    type: "oid"
  }, {
    name: "title",
    alias: "title",
    type: "string"
  }, {
    name: "type",
    alias: "type",
    type: "string"
  }, {
    name: "mag",
    alias: "Magnitude",
    type: "double"
}];

// 将字段数组添加到从客户端图形创建的要素图层
featureLayer.set({
  fields: fields,
  objectIdField: "ObjectID"
});

构造函数

new Field(properties)
参数:
properties Object
optional

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

属性列表

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

字段的显示名称。

更多信息Field
String更多信息

类名。

更多信息Accessor
Number|String|null|undefined更多信息

为字段设置的默认值。

更多信息Field
String更多信息

包含描述每个字段的用途的信息。

更多信息Field
CodedValueDomain|RangeDomain|InheritedDomain更多信息

与字段关联的域。

更多信息Field
Boolean更多信息

指示字段是否可编辑。

更多信息Field
Number更多信息

字段长度。

更多信息Field
String更多信息

字段的名称。

更多信息Field
Boolean更多信息

指示字段是否可以接受null 

更多信息Field
String更多信息

字段的数据类型。

更多信息Field
String更多信息

可以分配给字段的值的类型。

更多信息Field

属性详细说明

alias String

字段的显示名称。

默认值:null
declaredClass Stringreadonly inherited
起始版本: GeoScene API for JavaScript 4.22

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

defaultValue Number|String|null|undefined
起始版本: GeoScene API for JavaScript 4.22

为字段设置的默认值。

默认值:undefined
description String
起始版本: GeoScene API for JavaScript 4.22

包含描述每个字段的用途的信息。

与字段关联的域。属性域用于约束字段中允许的值。有两种类型的域:RangeDomain 和 CodedValueDomain

默认值:null
示例代码:
// 加载图层时打印出编码域值
view.whenLayerView(featureLayer).then(function(layerView) { layerView.watch("updating", function(value) { if (!value) { featureLayer.fields.forEach(function(field){ if (field.domain){ let domain = field.domain console.log(field.name, domain.type, domain.name); if (domain.type === "coded-value"){ domain.codedValues.forEach(function(codeValue){ console.log("name:", codeValue.name, "code:", codeValue.code); }); } } }); } }); });
editable Boolean

指示字段是否可编辑。

默认值:true
length Number

字段长度。

默认值:-1
name String

字段的名称。

默认值:null
nullable Boolean

指示字段是否可以接受 null 空值。

默认值:true
type String

字段的数据类型。

可选值:"small-integer"|"integer"|"single"|"double"|"long"|"string"|"date"|"oid"|"geometry"|"blob"|"raster"|"guid"|"global-id"|"xml"

默认值:null
valueType String
起始版本: GeoScene API for JavaScript 4.22

可以分配给字段的值的类型。有关可能值的列表,请参阅下表。

模式 描述
name-or-title 表示每个要素的名称、标题、标注或关键字的文本。
description 提供较长功能描述的文本,而不仅仅是名称或标题。
type-or-category 根据共同特征对要素进行分组的类型或类别。
count-or-amount 整数(无小数),表示特定属性的数量或数量。
percentage-or-ratio 此字段中的数字值反映不同数量之间的关系。
measurement 反映可以精确测量的特征的数字。
unique-identifier 此字段中的值用于将一个要素或实体与另一个要素或实体相明确区分开来。
ordered-or-ranked 此字段中的值表示要素在有序或排名列表中的状态。 例如,要素可以是以下之一:Small, medium, large, First, second, third, fourth, 或者 Informational, warning, error, failure.
binary 此字段中的值表示要素在有序或排名列表中的状态。例如,功能可以是下列功能之一: On or off, Yes or no, True or false, 或者Inhabited or vacant.
location-or-place-name 此字段中的值表示地理位置。此类字段中的值的示例包括街道地址、城市名称、区域、建筑物名称(如 A.K. Smiley 公共图书馆)、景点名称(如阿拉米达县展览会场或凯恩戈姆国家公园)、邮政编码或国家/地区。
coordinate 这些字段存储地理坐标值,例如 x、y、z、纬度或经度。
date-and-time 此字段中的值存储显式日期和时间或日期引用,如星期几、月份或年。
none 未指定类型。

可选值:"binary"|"coordinate"|"count-or-amount"|"date-and-time"|"description"|"location-or-place-name"|"measurement"|"name-or-title"|"none"|"ordered-or-ranked"|"percentage-or-ratio"|"type-or-category"|"unique-identifier"


方法列表

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

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

更多信息Field
Object更多信息

将此类的实例转换为其 GeoScene portal JSON 格式。

更多信息Field

方法详细说明

fromJSON(json){*}static

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

参数:
json Object

实例的 json 表达式,以geoscene 格式显示。

返回值:
类型 描述
* 返回一个该类的新实例。
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.