ArcGIS Runtime SDK for iOS: AGSTableDescription Class Reference
ArcGIS Runtime SDK for iOS  100.14
AGSTableDescription Class Reference

Description

An object that describes an AGSGeodatabaseFeatureTable to be created.

Creation of fields and tables is currently only supported on mobile geodatabases, either created in ArcGIS Pro or via createWithFileURL:completion: (AGSGeodatabase).

Since
100.14
Inheritance diagram for AGSTableDescription:
AGSObject

Instance Methods

(instancetype) - initWithName:
 
(instancetype) - initWithName:spatialReference:geometryType:
 

Class Methods

(instancetype) + tableDescriptionWithName:
 
(instancetype) + tableDescriptionWithName:spatialReference:geometryType:
 

Properties

NSMutableArray< AGSFieldDescription * > * fieldDescriptions
 
AGSGeometryType geometryType
 
BOOL hasAttachments
 
BOOL hasM
 
BOOL hasZ
 
AGSSpatialReferencespatialReference
 
NSString * tableName
 

Method Documentation

◆ initWithName:

- (instancetype) initWithName: (NSString *)  name

Creates a new table description object with the specified name.

Parameters
nameThe table's name.
Since
100.14

◆ initWithName:spatialReference:geometryType:

- (instancetype) initWithName: (NSString *)  name
spatialReference: (AGSSpatialReference *)  spatialReference
geometryType: (AGSGeometryType geometryType 

Creates a new table description object with the specified name, spatial reference, and geometry type.

Parameters
nameThe table's name.
spatialReferenceThe table's spatial reference.
geometryTypeThe table's geometry type.
Since
100.14

◆ tableDescriptionWithName:

+ (instancetype) tableDescriptionWithName: (NSString *)  name

Creates a new table description object with the specified name.

Parameters
nameThe table's name.
Since
100.14

◆ tableDescriptionWithName:spatialReference:geometryType:

+ (instancetype) tableDescriptionWithName: (NSString *)  name
spatialReference: (AGSSpatialReference *)  spatialReference
geometryType: (AGSGeometryType geometryType 

Creates a new table description object with the specified name, spatial reference, and geometry type.

Parameters
nameThe table's name.
spatialReferenceThe table's spatial reference.
geometryTypeThe table's geometry type.
Since
100.14

Property Documentation

◆ fieldDescriptions

- (NSMutableArray<AGSFieldDescription *>*) fieldDescriptions
readnonatomicstrong

An array of AGSFieldDescription objects that represent the descriptions of the fields to be created.

If no ObjectID field is provided, one will be automatically added.

Since
100.14

◆ geometryType

- (AGSGeometryType) geometryType
readwritenonatomicassign

The type of geometry to be used by features in the table.

The default geometry type is AGSGeometryTypeUnknown and represents a non-spatial table. When setting a known geometry type, the spatial reference also needs to be specified via the AGSTableDescription::spatialReference property.

Since
100.14

◆ hasAttachments

- (BOOL) hasAttachments
readwritenonatomicassign

YES if the features may have attachments.

The default value is NO. Enabling attachments requires a GlobalID field.

Since
100.14

◆ hasM

- (BOOL) hasM
readwritenonatomicassign

YES if the feature geometries may contain M values.

The default value is NO.

Since
100.14

◆ hasZ

- (BOOL) hasZ
readwritenonatomicassign

YES if the feature geometries may contain Z values.

The default value is NO.

Since
100.14

◆ spatialReference

- (AGSSpatialReference*) spatialReference
readwritenonatomicstrong

The spatial reference to be used by feature geometries in the table.

The default spatial reference is nil and represents a non-spatial table. When setting to a non-nil spatial reference, the geometry type also needs to be specified via the AGSTableDescription::geometryType property.

Since
100.14

◆ tableName

- (NSString*) tableName
readwritenonatomiccopy

The table's name.

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

Since
100.14