Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Field

Represents an attribute of a spatial layer, as configured by Essentials.

Hierarchy

  • Field

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Field(fieldInfo: object): Field

  • Initializes a new instance of the Field class.

    Parameters

    • fieldInfo: object
      • alias: string
      • dataType: string
      • displayName: string
      • Optional editable?: boolean
      • Optional focusField?: boolean
      • Optional format?: string
      • hyperlinkLabel: string
      • layer: Layer
      • name: string
      • Optional searchable?: boolean
      • Optional visible?: boolean

    Returns Field

Properties

alias

alias: string

The field alias.

dataType

dataType: string

The type of data the field contains.

displayName

displayName: string

Alias to use when displaying the field's name.

editable

editable: boolean

Whether the field is presented as editable in the user interface.

focusField

focusField: boolean

Whether this field is a focus field or not.

format

format: string

A custom format string for displaying the field's value.

hyperlinkLabel

hyperlinkLabel: string

The label, when used in a hyperlink.

layer

layer: Layer

The Layer that this field belongs to.

name

name: string

Name of the field.

searchable

searchable: boolean

Whether the field will be searched as part of the layer search.

visible

visible: boolean

Whether the field is visible in reports.

Methods

toJson

  • toJson(): any

  • Exports the state of the field as a JSON object. This can be used to recreate the field again via the constructor.

    Returns any

Static convertFromEsriType

  • convertFromEsriType(esriFieldType: string): string

  • Converts an ESRI field type to a Geocortex Essentials type which is a .NET type name.

    Parameters

    • esriFieldType: string

      Name of the ESRI field type to convert.

    Returns string

    esriFieldType Name of the system type that corresponds to ESRI field type.

Static convertToEsriFieldType

  • convertToEsriFieldType(geocortexType: string): string

  • Converts a Geocortex Essentials field type (which is a .NET type name) to an esri field type.

    Parameters

    • geocortexType: string

      Name of the Geocortex Essentials field type to convert.

    Returns string

    Name of the esri field type that corresponds to the Essentials type.