arcgis-maps-kotlin/com.arcgismaps.data/FieldDescription

FieldDescription

An object that describes a Field to be created. Creation of fields and tables is currently only supported on mobile geodatabases, either created in ArcGIS Pro or via Geodatabase.create(String).

Constructors

FieldDescription

fun FieldDescription(name: String, fieldType: FieldType)

Creates a new field description object with the specified name and type.

Properties

alias

var alias: String

The field's alias. The default value is an empty string.

domainName

var domainName: String

The name of the domain to use on this field. The domain must already exist in the geodatabase (see Geodatabase.createDomain(DomainDescription)). The default value of an empty string indicates that no domain should be used.

editable

var editable: Boolean

True if the field is editable. The default value is true.

fieldType

var fieldType: FieldType

The field's data type. The default is FieldType.Unknown, and must be set to a valid type.

length

var length: Int

The length of the field. The default value is 0. This only applies to text fields.

name

var name: String

The field's name. Field names must be non-empty, consist only of alphanumeric characters and underscores, and cannot start with a number or an underscore.

nullable

var nullable: Boolean

True if the field is nullable. The default value is true.