ArcGIS Runtime SDK for iOS: AGSFeatureCollectionTable Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSFeatureCollectionTable Class Reference

Description

An individual table that contains features belonging to a feature collection.

Instances of this class represent an individual table that contains features belonging to a feature collection. The tables help to organize features of the feature collection where features that share the same attribute schema (fields), geometry type, and spatial reference belong to the same table.

Since
100
See also
AGSFeatureCollection
Inheritance diagram for AGSFeatureCollectionTable:
AGSFeatureTable <AGSFeatureSet> AGSLoadableBase <AGSPopupSource> AGSObject <AGSLoadable>

Instance Methods

(id< AGSCancelable >) - addFeature:completion:
 
(id< AGSCancelable >) - addFeatures:completion:
 
(void) - cancelLoad
 
(BOOL) - canDeleteFeature:
 
(BOOL) - canUpdateFeature:
 
(AGSFeature *) - createFeature
 
(AGSFeature *) - createFeatureWithAttributes:geometry:
 
(id< AGSCancelable >) - deleteFeature:completion:
 
(id< AGSCancelable >) - deleteFeatures:completion:
 
(void) - doCancelLoading
 
(void) - doStartLoading:
 
(AGSFeatureEnumerator *) - featureEnumerator
 
(nullable AGSField *) - fieldForName:
 
(instancetype) - initWithFeatureSet:
 
(instancetype) - initWithFields:geometryType:spatialReference:
 
(instancetype) - initWithFields:geometryType:spatialReference:hasZ:hasM:
 
(instancetype) - initWithGeoElements:fields:
 
(void) - loadDidFinishWithError:
 
(void) - loadWithCompletion:
 
(void) - onLoadStatusChanged
 
(id< AGSCancelable >) - queryExtentWithParameters:completion:
 
(id< AGSCancelable >) - queryFeatureCountWithParameters:completion:
 
(id< AGSCancelable >) - queryFeaturesWithParameters:completion:
 
(id< AGSCancelable >) - queryStatisticsWithParameters:completion:
 
(void) - retryLoadWithCompletion:
 
(void) - setSymbolOverride:forFeature:
 
(nullable AGSSymbol *) - symbolOverrideForFeature:
 
(id< AGSCancelable >) - updateFeature:completion:
 
(id< AGSCancelable >) - updateFeatures:completion:
 

Class Methods

(instancetype) + featureCollectionTableWithFeatureSet:
 
(instancetype) + featureCollectionTableWithFields:geometryType:spatialReference:
 
(instancetype) + featureCollectionTableWithFields:geometryType:spatialReference:hasZ:hasM:
 
(instancetype) + featureCollectionTableWithGeoElements:fields:
 

Properties

BOOL canAddFeature
 
BOOL canEditGeometry
 
NSString * displayName
 
BOOL editable
 
AGSEnvelopeextent
 
AGSFeatureLayerfeatureLayer
 
NSArray< AGSField * > * fields
 
NSArray< AGSField * > * fields
 
AGSGeometryType geometryType
 
AGSGeometryType geometryType
 
BOOL hasGeometry
 
BOOL hasM
 
BOOL hasZ
 
AGSLayerlayer
 
AGSArcGISFeatureLayerInfolayerInfo
 
NSError * loadError
 
AGSLoadStatus loadStatus
 
NSInteger numberOfFeatures
 
AGSPopupDefinitionpopupDefinition
 
BOOL popupEnabled
 
AGSRendererrenderer
 
AGSSpatialReferencespatialReference
 
AGSSpatialReferencespatialReference
 
NSString * tableName
 
NSString * title
 

Method Documentation

◆ cancelLoad

- (void) cancelLoad
requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since
100

◆ canDeleteFeature:

- (BOOL) canDeleteFeature: (AGSFeature *)  feature

Indicates whether the source allows this particular feature to be deleted. The method first checks to verify if the source is capable of deleting any features in general. It also checks specific ownership-based access control policies of the source to see if the user attempting to perform the operation has persmissions to delete this particular feature.

Parameters
featureCan be nil, in which case, this method only checks if the source is capable of deleting any features in general
Returns
A boolean value
Since
100

◆ canUpdateFeature:

- (BOOL) canUpdateFeature: (AGSFeature *)  feature

Indicates whether the source allows updating this particular feature. The method first checks to verify if the source is capable of updating any features in general. It also checks specific ownership-based access control policies of the source to see if the user attempting to perform the operation has persmissions to edit this patricular feature.

Parameters
featureCan be nil, in which case, this method only checks if the source is capable of updating any features in general
Returns
A boolean value
Since
100

◆ createFeature

- (AGSFeature *) createFeature

Create a new, empty feature. Note, the new feature is only available in memory at this point, it is not commited to the dataset.

Returns
emtpy feature
Since
100
Note
The feature will need to be explicitly added to the dataset. See addFeature:completion:

◆ createFeatureWithAttributes:geometry:

- (AGSFeature *) createFeatureWithAttributes: (NSDictionary< NSString *, id > *)  attributes
geometry: (nullable AGSGeometry *)  geometry 

Create a new feature with the provided attribute values and, optionally, geometry. Note, the new feature is only available in memory at this point, it is not commited to the dataset.

Parameters
attributesfor the feature
geometryfor the feature
Returns
feature
Since
100
Note
The feature will need to be explicitly added to the dataset. See addFeature:completion:

◆ doCancelLoading

- (void) doCancelLoading

Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ doStartLoading:

- (void) doStartLoading: (BOOL)  retrying

Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.

Parameters
retryingflag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).
Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ featureCollectionTableWithFeatureSet:

+ (instancetype) featureCollectionTableWithFeatureSet: (id< AGSFeatureSet >)  featureSet

Initialize the table populated with the provided feature set. The geometry type and spatial reference will be inferred from the features in the feature set passed in. Be aware that this constructor may take some time to complete depending on how many features are in the feature set.

Parameters
featureSetcontaining the features that will be copied into this table.
Since
100

◆ featureCollectionTableWithFields:geometryType:spatialReference:

+ (instancetype) featureCollectionTableWithFields: (NSArray< AGSField * > *)  fields
geometryType: (AGSGeometryType geometryType
spatialReference: (nullable AGSSpatialReference *)  spatialReference 

Initialize the table with the provided parameters.

Parameters
fieldsThe attributes of features that will be held in this table.
geometryTypeThe type of feature geometry that will be held in this table.
spatialReferenceThe spatial reference of the features that will be held in this table.
Since
100

◆ featureCollectionTableWithFields:geometryType:spatialReference:hasZ:hasM:

+ (instancetype) featureCollectionTableWithFields: (NSArray< AGSField * > *)  fields
geometryType: (AGSGeometryType geometryType
spatialReference: (nullable AGSSpatialReference *)  spatialReference
hasZ: (BOOL)  hasZ
hasM: (BOOL)  hasM 

Initialize an empty table with the provided parameters.

Parameters
fieldsThe attributes of features that will be held in this table.
geometryTypeThe type of feature geometry that will be held in this table.
spatialReferenceThe spatial reference of the features that will be held in this table.
hasZBool specifying whether the table supports geometries with Z values.
hasMBool specifying whether the table supports geometries with M values.
Since
100.4

◆ featureCollectionTableWithGeoElements:fields:

+ (instancetype) featureCollectionTableWithGeoElements: (NSArray< id< AGSGeoElement >> *)  geoElements
fields: (nullable NSArray< AGSField * > *)  fields 

Initialize the table populated with the provided geoelements. The geometry type and spatial reference will be inferred from the geo-elements passed in. Be aware that this constructor may take some time to complete depending on how many geo-elements are passed in.

Parameters
geoElementsthat will be copied into the table as features. All geo-elements must support the fields specified next.
fieldsThe attributes of features that will be held in this table.
Since
100

◆ featureEnumerator

- (AGSFeatureEnumerator*) featureEnumerator

Returns an enumerator object that lets you access each feature.

Since
100

◆ fieldForName:

- (nullable AGSField *) fieldForName: (NSString *)  fieldName

Convenience method to getting a field object given its name

Parameters
fieldNameThe name of the field.
Returns
field
Since
100

◆ initWithFeatureSet:

- (instancetype) initWithFeatureSet: (id< AGSFeatureSet >)  featureSet

Initialize the table populated with the provided feature set. The geometry type and spatial reference will be inferred from the features in the feature set passed in. Be aware that this constructor may take some time to complete depending on how many features are in the feature set.

Parameters
featureSetcontaining the features that will be copied into this table.
Since
100

◆ initWithFields:geometryType:spatialReference:

- (instancetype) initWithFields: (NSArray< AGSField * > *)  fields
geometryType: (AGSGeometryType geometryType
spatialReference: (nullable AGSSpatialReference *)  spatialReference 

Initialize an empty table with the provided parameters.

Parameters
fieldsThe attributes of features that will be held in this table.
geometryTypeThe type of feature geometry that will be held in this table.
spatialReferenceThe spatial reference of the features that will be held in this table.
Since
100

◆ initWithFields:geometryType:spatialReference:hasZ:hasM:

- (instancetype) initWithFields: (NSArray< AGSField * > *)  fields
geometryType: (AGSGeometryType geometryType
spatialReference: (nullable AGSSpatialReference *)  spatialReference
hasZ: (BOOL)  hasZ
hasM: (BOOL)  hasM 

Initialize an empty table with the provided parameters.

Parameters
fieldsThe attributes of features that will be held in this table.
geometryTypeThe type of feature geometry that will be held in this table.
spatialReferenceThe spatial reference of the features that will be held in this table.
hasZBool specifying whether the table supports geometries with Z values.
hasMBool specifying whether the table supports geometries with M values.
Since
100.4

◆ initWithGeoElements:fields:

- (instancetype) initWithGeoElements: (NSArray< id< AGSGeoElement >> *)  geoElements
fields: (nullable NSArray< AGSField * > *)  fields 

Initialize the table populated with the provided geoelements. The geometry type and spatial reference will be inferred from the geo-elements passed in. Be aware that this constructor may take some time to complete depending on how many geo-elements are passed in.

Parameters
geoElementsthat will be copied into the table as features. All geo-elements must support the fields specified next.
fieldsThe attributes of features that will be held in this table.
Since
100

◆ loadDidFinishWithError:

- (void) loadDidFinishWithError: (nullable NSError *)  error

Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadWithCompletion:

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100
See also
- cancelLoad to cancel loading
- retryLoadWithCompletion: to force reload

◆ onLoadStatusChanged

- (void) onLoadStatusChanged

Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ queryExtentWithParameters:completion:

- (id<AGSCancelable>) queryExtentWithParameters: (AGSQueryParameters *)  parameters
completion: (void(^)(AGSEnvelope *__nullable extent, NSError *__nullable error))  completion 

Query the dataset to find the geographic extent covering matched features or records.

Parameters
parametersrepresenting the query criteria
completionThe block that is called when the query is complete
Returns
operation which can be canceled
See also
AGSFeatureServiceSessionType
Since
100.2

◆ queryFeatureCountWithParameters:completion:

- (id<AGSCancelable>) queryFeatureCountWithParameters: (AGSQueryParameters *)  parameters
completion: (void(^)(NSInteger count, NSError *__nullable error))  completion 

Query the dataset to find the number of matched features or records.

Parameters
parametersrepresenting the query criteria
completionThe block that is called when the query is complete
Returns
operation which can be canceled
See also
AGSFeatureServiceSessionType
Since
100.2

◆ queryFeaturesWithParameters:completion:

- (id<AGSCancelable>) queryFeaturesWithParameters: (AGSQueryParameters *)  parameters
completion: (nullable void(^)(AGSFeatureQueryResult *__nullable result, NSError *__nullable error))  completion 

Query the dataset to find specific features or records.

Parameters
parametersrepresenting the query criteria
completionThe block that is called when the query is complete
Returns
operation which can be canceled
See also
AGSFeatureServiceSessionType
Since
100

◆ queryStatisticsWithParameters:completion:

- (id<AGSCancelable>) queryStatisticsWithParameters: (AGSStatisticsQueryParameters *)  parameters
completion: (void(^)(AGSStatisticsQueryResult *__nullable result, NSError *__nullable error))  completion 

Query the dataset to compute statistics on matched features or records.

Parameters
parametersrepresenting the query criteria
completionThe block that is called when the query is complete
Returns
operation which can be canceled
See also
AGSFeatureServiceSessionType
Since
100.2

◆ retryLoadWithCompletion:

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

  1. you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
  2. the server was down earlier when it failed and you want to retry
  3. the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100

◆ setSymbolOverride:forFeature:

- (void) setSymbolOverride: (nullable AGSSymbol *)  symbol
forFeature: (AGSFeature *)  feature 

◆ symbolOverrideForFeature:

- (nullable AGSSymbol*) symbolOverrideForFeature: (AGSFeature *)  feature

Property Documentation

◆ canAddFeature

- (BOOL) canAddFeature
readnonatomicassigninherited

Indicates whether the source supports adding new features.

Since
100

◆ canEditGeometry

- (BOOL) canEditGeometry
readnonatomicassigninherited

Indicates whether the source supports updating geometry of existing features.

Since
100

◆ displayName

- (NSString*) displayName
readwritenonatomiccopyinherited

User-friendly name that can be displayed in the UI (for example in a Table of Contents)

Since
100.3

◆ editable

- (BOOL) editable
readnonatomicassigninherited

Indicates whether the dataset can be edited. For details on which fine-grained editing capabilites are supported, refer to canUpdateFeature: and canDeleteFeature:

Since
100

◆ extent

- (AGSEnvelope*) extent
readnonatomicstronginherited

The extent of the dataset.

Since
100

◆ featureLayer

- (AGSFeatureLayer*) featureLayer
readnonatomicweakinherited

The feature layer this table is associated with, or created from, if any. nil if this table is not associated with a feature layer. This property is populated when the AGSFeatureLayer is created from the AGSFeatureTable.

Since
100.0
Deprecated:
100.7.0. Use AGSFeatureTable::layer instead

Provided by category AGSFeatureTable(AGSDeprecated).

◆ fields [1/2]

- (NSArray<AGSField*>*) fields
readrequirednonatomiccopyinherited

The attribute fields (columns) available in data. The property is an array of AGSField objects.

See also
AGSField
Since
100

◆ fields [2/2]

- (NSArray<AGSField*>*) fields
readnonatomiccopyinherited

Array of AGSField objects representing the fields (columns) in the dataset.

See also
AGSField
Since
100

◆ geometryType [1/2]

- (AGSGeometryType) geometryType
readnonatomicassigninherited

The type of geometry contained by features.

Since
100

◆ geometryType [2/2]

- (AGSGeometryType) geometryType
readnonatomicassigninherited

The type of geometry used by geographic feautres. Only applicable if hasGeometry is true.

Since
100

◆ hasGeometry

- (BOOL) hasGeometry
readnonatomicassigninherited

Indicates whether the dataset contains a geometry field (column). If YES, the dataset contains geographic features. If NO, the dataset contains non-spatial records, similar to a database table.

Since
100

◆ hasM

- (BOOL) hasM
readnonatomicassigninherited

Indicates whether features may contain M values

Since
100.2

◆ hasZ

- (BOOL) hasZ
readnonatomicassigninherited

Indicates whether features may contain Z values

Since
100.2

◆ layer

- (AGSLayer*) layer
readnonatomicweakinherited

The layer this table is associated with, or created from, if any. This can be an AGSAnnotationLayer, an AGSFeatureLayer, or null if this table is not associated with a layer. This property is populated when the layer is created from the AGSFeatureTable.

Since
100.7

◆ layerInfo

- (AGSArcGISFeatureLayerInfo*) layerInfo
readnonatomicstrong

◆ loadError

- (NSError*) loadError
readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since
100

◆ loadStatus

- (AGSLoadStatus) loadStatus
readrequirednonatomicassigninherited

Status of the load operation.

Since
100

◆ numberOfFeatures

- (NSInteger) numberOfFeatures
readnonatomicassigninherited

The total number of features or records in the dataset.

Since
100

◆ popupDefinition

- (AGSPopupDefinition*) popupDefinition
readwritenonatomicstronginherited

The AGSPopupDefinition associated with the popup source. This property will be nil if an error occurs or if the popup source is not associated with a popup definition.

Since
100

◆ popupEnabled

- (BOOL) popupEnabled
readwriterequirednonatomicassigninherited

Indicates whether popups are enabled on this source.

Since
100

◆ renderer

- (AGSRenderer*) renderer
readwritenonatomicstrong

◆ spatialReference [1/2]

- (AGSSpatialReference*) spatialReference
readnonatomicstronginherited

The spatial reference of the features.

Since
100

◆ spatialReference [2/2]

- (AGSSpatialReference*) spatialReference
readnonatomicstronginherited

The spatial reference of the dataset.

Since
100

◆ tableName

- (NSString*) tableName
readnonatomiccopyinherited

Name of the dataset.

Since
100

◆ title

- (NSString*) title
readwritenonatomiccopy