Extends the capabilities of an Esri Field object.

Hierarchy (view full)

Constructors

Properties

_id: string

The unique ID for this entity. Once set, this should never change.

_itemType: string = ItemType.FIELD_EXTENSION

The item type for this entity when it participates in an App.

format: string = "{0}"

The field format specifier. This is a standard .NET-style format string containing as {0} placeholder that will be replaced by the actual field value.

formatSettings: FormatSettings = ...

Settings that affect how values are formatted. Depending on the type of field, some or all of these settings may not be applicable.

searchable: boolean = true

Whether the field is searchable or not.

Accessors

  • get field(): Field
  • The Esri Field object being extended.

    Returns Field

  • get fieldInfo(): FieldInfo
  • The corresponding esri field info object.

    Returns FieldInfo

  • get id(): string
  • The unique ID for this entity.

    Returns string

  • get itemType(): string
  • The item type for this entity when it participates in an App.

    Returns string

Methods

  • Called to perform cleanup. Subclasses should override this method rather than destroy() to perform custom cleanup.

    Returns Promise<void>

  • Called after normal initialization. Note: Child items are initialized before this is called.

    Returns Promise<void>

  • A clean-up function that should get called whenever the item is disposed of.

    Returns Promise<void>

  • Emits an event on the instance.

    Parameters

    Returns boolean

  • Initializes the item.

    Returns Promise<void>

  • Registers an event handler on the instance.

    Parameters

    Returns IHandle

  • Creates an item:// URI reference to this entity.

    Returns string

  • Checks to see if a field matches a field reference.

    Parameters

    • fieldX: Field | FieldExtension

      The field or FieldExtension to match with a reference.

    • fieldRef: FieldProperties

      The field reference to match with a field.

    Returns boolean