Class EsriField

Hierarchy

  • Accessor
  • JSONSupport
    • EsriField

Constructors

constructor

Properties

alias declaredClass defaultValue description destroyed domain editable initialized length name nullable type valueType

Methods

_get _set addHandles destroy get hasHandles notifyChange own removeHandles set toJSON watch fromJSON

Constructors

constructor

  • Information about each field in a layer.

    Read more...

    Parameters

    • Optional properties: FieldProperties

    Returns EsriField

Properties

alias

alias: string

The display name for the field.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#alias)

declaredClass

declaredClass: string

defaultValue

defaultValue: undefined | null | string | number

The default value set for the field.

Default

undefined

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#defaultValue)

description

description: string

Contains information describing the purpose of each field.

Read more...

destroyed

destroyed: boolean

domain

domain: CodedValueDomain | RangeDomain | InheritedDomain

The domain associated with the field.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#domain)

editable

editable: boolean

Indicates whether the field is editable.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#editable)

initialized

initialized: boolean

length

length: number

The field length.

Default

-1

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#length)

name

name: string

The name of the field.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#name)

nullable

nullable: boolean

Indicates if the field can accept null values.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#nullable)

type

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

The data type of the field.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type)

valueType

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

The types of values that can be assigned to a field.

Read more...

Methods

Protected _get

  • _get(propertyName): any

  • Parameters

    • propertyName: string

    Returns any

  • _get<T>(propertyName): T

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName, value): EsriField

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriField

addHandles

  • Type Parameters

    • T

    Parameters

    • handles: IHandle | IHandle[]
    • Optional groupKey: Exclude<T, IHandle>

    Returns void

destroy

  • Returns void

get

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasHandles

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns boolean

Protected notifyChange

  • Parameters

    • propertyName: string

    Returns void

own

  • Deprecated

    Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.

    Parameters

    • handles: IHandle | IHandle[]

    Returns void

removeHandles

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns void

set

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriField

  • Parameters

    • props: HashMap<any>

    Returns EsriField

toJSON

  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Static fromJSON

  • Parameters

    • json: any

    Returns EsriField

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc