Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: Field
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/Field"], function(Field) { /* code goes here */ });
Description
(Added at v2.0)
Information about each field in a layer. Field objects must be constructed when creating a FeatureLayer from a client-side feature collection. See the documentation of the FeatureLayer constructor for more details. This class allows you to define the schema of each field in the FeatureLayer. Note that you do not need to add fields to the constructor of a FeatureLayer loaded from a service since they are already defined by the service. See the FeatureCollection sample for an example of working with this class.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| alias | String | The alias name for the field. |
| defaultValue | String | A string that describes the default value set for a field. |
| description | Object | Contains information describing the purpose of each field and the various types of data each field contains. |
| domain | Domain | Domain associated with the field. |
| editable | Boolean | Indicates whether the field is editable. |
| length | Number | The field length. |
| name | String | The name of the field. |
| nullable | Boolean | Indicates if the field can accept null values. |
| type | String | The data type of the field. |
Property Details
<String
StringThe alias name for the field.
<String
StringA string that describes the default value set for a field. (Added at v3.28)
<Object
ObjectContains information describing the purpose of each field and the various types of data each field contains. See the object specification below. (Added at v3.28)
Object Specifications:
<
description>< |
Required | The various types of values that can be assigned to a field. There are 12 possible types:
|
< |
Required | The string value that describes the field. |
Sample: {"value":"State FIPS code. Federal Information Processing Standards (FIPS) are numeric codes assigned by the National Institute of Standards and Technology (NIST). FIPS codes identify US states by a 2-digit number, and US counties by a 3-digit number.","fieldValueType":"typeOrCategory"}
<Domain
DomainDomain associated with the field.
<Number
NumberThe field length
<String
StringThe name of the field.
<Boolean
BooleanIndicates if the field can accept null values. Requires ArcGIS Server version 10.1 or greater. (Added at v2.6)
Known values:
true | false<String
StringThe data type of the field.
Can be one of the following: "esriFieldTypeSmallInteger", "esriFieldTypeInteger", "esriFieldTypeSingle", "esriFieldTypeDouble", "esriFieldTypeString", "esriFieldTypeDate", "esriFieldTypeOID", "esriFieldTypeGeometry", "esriFieldTypeBlob", "esriFieldTypeRaster", "esriFieldTypeGUID", "esriFieldTypeGlobalID", "esriFieldTypeXML"