Field QML Type

Information about a field for a feature table. More...

Import Statement:	import Esri.ArcGISRuntime 100.15
Since:	Esri.ArcGISRuntime 100.0
Inherits:	Object

List of all members, including inherited members

Properties

alias : string
domain : Domain
editable : bool
fieldType : Enums.FieldType
length : int
name : string
nullable : bool

Signals

aliasChanged()
domainChanged()
editableChanged()
fieldTypeChanged()
lengthChanged()
nameChanged()
nullableChanged()

Detailed Description

Example:

Create a ServiceFeatureTable and obtain one of its fields:

ServiceFeatureTable {
    id: serviceFeatureTable
    url: sampleServerDamageInspectionUrl

    onLoadStatusChanged:  {
        if (loadStatus === Enums.LoadStatusLoaded) {
            var field = serviceFeatureTable.field("PRIMCAUSE");
            var fieldName = field.name;
            var fieldAlias = field.alias;
        }
    }
}

Property Documentation

alias : string

The alias name of the field.

The alias name is usually more user-friendly than the actual field name, which may be constrained by the underlying data source's naming convention.

If there is no alias defined, this is an empty string.

domain : Domain

Returns the domain that limits valid field values to a range or to a set of coded values.

Note: This property is read-write starting with 100.14. It was read-only in prior releases.

editable : bool

Returns whether the field is editable.

Note: This property is read-write starting with 100.14. It was read-only in prior releases.

fieldType : Enums.FieldType

The type of value in the field.

See also Enums.FieldType.

length : int

The field length.

name : string

The name of the field.

nullable : bool

Returns whether the field can accept null values.

Note: This property is read-write starting with 100.14. It was read-only in prior releases.

Signal Documentation

aliasChanged()

Emitted when the alias property changes.

Note: The corresponding handler is onAliasChanged.

domainChanged()

Emitted when the domain property changes.

Note: The corresponding handler is onDomainChanged.

This signal was introduced in Esri::ArcGISRuntime 100.14.

editableChanged()

Emitted when the editable property changes.

Note: The corresponding handler is onEditableChanged.

This signal was introduced in Esri::ArcGISRuntime 100.14.

fieldTypeChanged()

Emitted when the fieldType property changes.

Note: The corresponding handler is onFieldTypeChanged.

lengthChanged()

Emitted when the length property changes.

Note: The corresponding handler is onLengthChanged.

nameChanged()

Emitted when the name property changes.

Note: The corresponding handler is onNameChanged.

nullableChanged()

Emitted when the nullable property changes.

Note: The corresponding handler is onNullableChanged.

This signal was introduced in Esri::ArcGISRuntime 100.14.