ArcGIS Runtime SDK for macOS: AGSFeatureLayer Class Reference
ArcGIS Runtime SDK for macOS  100.5
AGSFeatureLayer Class Reference

Description

Instances of this class represent a feature layer. Feature layers can display features from an AGSFeatureTable on a map using AGSMapView or a scene using AGSSceneView. The feature table represents feature data either in a remote ArcGIS Feature Service or in a local geodatabase on disk.

Feature layer adopts the loadable pattern; many of its properties are initialized asynchronously. See AGSLoadable for more information.

The feature layer has a load dependency on its featureTable from where it gets information about itself such as min/max scale, renderer, etc. Calling loadWithCompletion: (AGSLoadable-p) on the feature layer initiates loading of its featureTable too.

See also
AGSFeatureTable
Since
100
Inheritance diagram for AGSFeatureLayer:
AGSLayer <AGSPopupSource> <AGSTimeAware> AGSLoadableBase <AGSLayerContent> AGSObject <AGSLoadable>

Instance Methods

("Please use initWithFeatureTable: or initWithItem:layerID:") - __deprecated_msg
 
(AGSColor *selectionColor) - __deprecated_msg
 
(double selectionWidth) - __deprecated_msg
 
(void) - cancelLoad
 
(void) - clearSelection
 
(id< AGSCancelable >) - fetchLegendInfosWithCompletion:
 
(id< AGSCancelable >) - getSelectedFeaturesWithCompletion:
 
(instancetype) - initWithFeatureTable:
 
(instancetype) - initWithItem:layerID:
 
(BOOL) - isEqualToLayer:
 
(BOOL) - isVisibleAtScale:
 
(void) - loadWithCompletion:
 
(void) - resetFeaturesVisible
 
(void) - resetRenderer
 
(void) - retryLoadWithCompletion:
 
(void) - selectFeature:
 
(void) - selectFeatures:
 
(id< AGSCancelable >) - selectFeaturesWithQuery:mode:completion:
 
(void) - setFeature:visible:
 
(void) - setFeatures:visible:
 
(void) - unselectFeature:
 
(void) - unselectFeatures:
 

Class Methods

("Please use featureLayerWithFeatureTable: or featureLayerWithItem:layerID:") + __deprecated_msg
 
(instancetype) + featureLayerWithFeatureTable:
 
(instancetype) + featureLayerWithItem:layerID:
 

Properties

NSString * attribution
 
BOOL canChangeVisibility
 
NSString * definitionExpression
 
AGSFeatureTablefeatureTable
 
AGSEnvelopefullExtent
 
AGSTimeExtentfullTimeExtent
 
BOOL identifyEnabled
 
AGSItemitem
 
NSMutableArray< AGSLabelDefinition * > * labelDefinitions
 
BOOL labelsEnabled
 
NSString * layerDescription
 
NSString * layerID
 
NSError * loadError
 
AGSLoadStatus loadStatus
 
double maxScale
 
double minScale
 
NSString * name
 
float opacity
 
AGSPopupDefinitionpopupDefinition
 
BOOL popupEnabled
 
NSTimeInterval refreshInterval
 
AGSRendererrenderer
 
AGSFeatureRenderingMode renderingMode
 
BOOL scaleSymbols
 
AGSLayerScenePropertiessceneProperties
 
BOOL showInLegend
 
AGSSpatialReferencespatialReference
 
NSArray< id< AGSLayerContent > > * subLayerContents
 
void(^ subLayerContentsChangedHandler )()
 
BOOL supportsTimeFiltering
 
BOOL timeFilteringEnabled
 
AGSTimeValuetimeInterval
 
AGSTimeValuetimeOffset
 
BOOL visible
 

Method Documentation

§ __deprecated_msg() [1/4]

- ("Please use) initWithFeatureTable:

Initialize a new feature layer

Returns
A new initialized feature layer
Since
100
Deprecated:
100.1. Use initWithFeatureTable: or initWithItem:layerID: instead.

§ __deprecated_msg() [2/4]

Initialize a new feature layer

Returns
A new initialized feature layer
Since
100
Deprecated:
100.1. Use featureLayerWithFeatureTable: or featureLayerWithItem:layerID: instead.

§ __deprecated_msg() [3/4]

- (AGSColor* selectionColor) __deprecated_msg ("Please use 'color' property exposed through 'selectionProperties' property in AGSGeoView") 

The color to use for drawing a halo around selected features. Defaults to cyan color.

Since
100
Deprecated:
100.4 Use color property exposed through AGSGeoView::selectionProperties

§ __deprecated_msg() [4/4]

- (double selectionWidth) __deprecated_msg ("This property will be removed in a future version") 

The width (in points) of the selection halo

Since
100
Deprecated:
100.4 This property will be removed in a future version

§ 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

§ clearSelection()

- (void) clearSelection

Clears selection on all features.

Since
100

§ featureLayerWithFeatureTable:()

+ (instancetype) featureLayerWithFeatureTable: (AGSFeatureTable *)  featureTable

Initialize the layer with the given AGSFeatureTable

Parameters
featureTableThe backing dataset whose features need to be drawn on the map by this layer.
Since
100

§ featureLayerWithItem:layerID:()

+ (instancetype) featureLayerWithItem: (AGSItem *)  item
layerID: (NSInteger)  layerID 

Initialize the layer with the provided information

Parameters
itemrepresenting an ArcGIS Feature Serivce. The item's type must be AGSPortalItemTypeFeatureService.
layerIDID of an individual layer in the ArcGIS Feature service represented by the item
Returns
Initialized layer
Since
100

§ fetchLegendInfosWithCompletion:()

- (id<AGSCancelable>) fetchLegendInfosWithCompletion: (void(^)(NSArray< AGSLegendInfo * > *__nullable legendInfos, NSError *__nullable error))  completion

Fetches the array of legend infos (AGSLegendInfo) for this layer.

Since
100

§ getSelectedFeaturesWithCompletion:()

- (id<AGSCancelable>) getSelectedFeaturesWithCompletion: (void(^)(AGSFeatureQueryResult *__nullable featureQueryResult, NSError *__nullable error))  completion

Retrieve the list of features that have selection enabled.

Parameters
completionblock that is invoked with the results, or an error if one is encountered.
Returns
operation which can be canceled
Since
100

§ initWithFeatureTable:()

- (instancetype) initWithFeatureTable: (AGSFeatureTable *)  featureTable

Initialize the layer with the given AGSFeatureTable

Parameters
featureTableThe backing dataset whose features need to be drawn on the map by this layer.
Since
100

§ initWithItem:layerID:()

- (instancetype) initWithItem: (AGSItem *)  item
layerID: (NSInteger)  layerID 

Initialize the layer with the provided information

Parameters
itemrepresenting an ArcGIS Feature Serivce. The item's type must be AGSPortalItemTypeFeatureService.
layerIDID of an individual layer in the ArcGIS Feature service represented by the item
Returns
Initialized layer
Since
100

§ isVisibleAtScale:()

- (BOOL) isVisibleAtScale: (double)  scale

Check whether this layer is visible at a given scale.

Since
100

§ 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

§ resetFeaturesVisible()

- (void) resetFeaturesVisible

Reset the visibility of all features back to their original state

Since
100

§ resetRenderer()

- (void) resetRenderer

Reset the renderer back to the original renderer provided by the featureTable. This is useful if you, for instance, change the renderer and then want to revert back to the original.

Since
100

§ 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

§ selectFeature:()

- (void) selectFeature: (AGSFeature *)  feature

Select the specified feature. The map or scene will be updated to render the feature with #selectionColor

Parameters
featureto select
Since
100
See also
#selectionColor
Note
Use selectFeatures: to enable selection on a group of features together. It provides better performance as the map will only need to be updated once.

§ selectFeatures:()

- (void) selectFeatures: (NSArray< AGSFeature * > *)  features

Select the specified features. The map or scene will be updated to highlight the features with #selectionColor (cyan by default).

Parameters
featuresto select
Since
100
See also
#selectionColor

§ selectFeaturesWithQuery:mode:completion:()

- (id<AGSCancelable>) selectFeaturesWithQuery: (AGSQueryParameters *)  parameters
mode: (AGSSelectionMode mode
completion: (nullable void(^)(AGSFeatureQueryResult *__nullable featureQueryResult, NSError *__nullable error))  completion 

Select features that match the query criteria. The map or scene will be updated to highlight the features with #selectionColor (cyan by default).

Parameters
parametersdefining which features should be considered
modedefining how selection needs to be applied to the features
completionblock that is invoked with the results, or an error if one is encountered.
Returns
operation which can be canceled
Since
100

§ setFeature:visible:()

- (void) setFeature: (AGSFeature *)  feature
visible: (BOOL)  visible 

Change the visibility of the specified feature. The map or scene is redrawn to reflect the change.

Parameters
featureto change
visibleIf true, feature is made visible. If false, feature is hidden
Since
100
Note
Use setFeatures:visible: to change the visibility of a group of features together. It provides better performance as the map will only need to be updated once.

§ setFeatures:visible:()

- (void) setFeatures: (NSArray< AGSFeature * > *)  features
visible: (BOOL)  visible 

Change the visibility of the specified features. The map or scene is updated to reflect the change.

Parameters
featuresto change
visibleIf true, features are made visible. If false, features are hidden
Since
100

§ unselectFeature:()

- (void) unselectFeature: (AGSFeature *)  feature

Clear selection on the specified feature. The map or scene will be redrawn to reflect the change.

Parameters
featureto unselect
Since
100
Note
Use unselectFeatures: to disable selection on a group of features together. It provides better performance as the map will only need to be updated once.

§ unselectFeatures:()

- (void) unselectFeatures: (NSArray< AGSFeature * > *)  features

Clear selection on the specified features. The map or scene will be redrawn to reflect the change.

Parameters
featuresto unselect
Since
100

Property Documentation

§ attribution

- (NSString*) attribution
readnonatomiccopyinherited

Attribution information of the layer

Since
100

§ canChangeVisibility

- (BOOL) canChangeVisibility
readrequirednonatomicassigninherited

Denotes whether the layer can change visibility or not.

Since
100

§ definitionExpression

- (NSString*) definitionExpression
readwritenonatomiccopy

The definition expression in the syntax of a SQL where clause by which to limit which features are displayed on the map.

Since
100

§ featureTable

- (AGSFeatureTable*) featureTable
readnonatomicstrong

The backing dataset whose features are drawn on the map by this layer.

Since
100

§ fullExtent

- (AGSEnvelope*) fullExtent
readnonatomicstronginherited

Full extent of the layer.

Since
100

§ fullTimeExtent

- (AGSTimeExtent*) fullTimeExtent
readnonatomicstronginherited

The full time extent of the layer 100.2

§ identifyEnabled

- (BOOL) identifyEnabled
readnonatomicassigninherited

Specifies whether the layer supports identify.

Since
100

§ item

- (AGSItem*) item
readnonatomicstronginherited

The item the layer has been created from.

Since
100

§ labelDefinitions

- (NSMutableArray<AGSLabelDefinition*>*) labelDefinitions
readnonatomicstrong

Defines how labels should be displayed.

Since
100.1

§ labelsEnabled

- (BOOL) labelsEnabled
readwritenonatomicassign

Indicates whether or not features will be labelled on this layer.

Since
100

§ layerDescription

- (NSString*) layerDescription
readwritenonatomiccopyinherited

The layer's description

Since
100

§ layerID

- (NSString*) layerID
readwritenonatomiccopyinherited

The layer's ID specified in the webmap item of ArcGIS Online or an on-premises portal.

Since
100

§ 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

§ maxScale

- (double) maxScale
readwritenonatomicassigninherited

The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene.

Since
100

§ minScale

- (double) minScale
readwritenonatomicassigninherited

The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene.

Since
100

§ name

- (NSString*) name
readwritenonatomiccopyinherited

The name of the layer

Since
100

§ opacity

- (float) opacity
readwritenonatomicassigninherited

The opacity of this layer as a value between 0 (fully transparent) and 1 (fully opaque). Default value is 1.

Since
100

§ popupDefinition

- (AGSPopupDefinition*) popupDefinition
readwritenonatomicstronginherited

Information on how popups are defined for this source.

Since
100

§ popupEnabled

- (BOOL) popupEnabled
readwriterequirednonatomicassigninherited

Indicates whether popups are enabled on this source.

Since
100

§ refreshInterval

- (NSTimeInterval) refreshInterval
readwritenonatomicassign

Time interval (in seconds) specifying how often the layer should auto-refresh its contents. If 0 or less is specified, the layer will not auto-refresh.

Since
100.1

§ renderer

- (AGSRenderer*) renderer
readwritenonatomicstrong

The renderer specifying how the features should be symbolized

Since
100

§ renderingMode

- (AGSFeatureRenderingMode) renderingMode
readwritenonatomicassign

Mode used for rendering this layer. Static mode is better suited for displaying large datasets (in terms of number of vertices) and for complex symbology because it does not update the layer's display while pan/zoom operations are in progress. Dynamic mode is better suited for smaller datasets that are updating frequently or for more interactive experience as the layer's display is updated continuously while pan/zoom operations are in progress.

Since
100.2
See also
AGSLoadSettings to specify rendering mode for all feature layers in a map or scene

§ scaleSymbols

- (BOOL) scaleSymbols
readwritenonatomicassign

Whether the layer's symbols and labels honor the Map reference scale. If the Map has a positive reference scale, and the layer honors it, then symbols and labels will be drawn at their specified size when the viewing scale is the same as the reference scale, and will grow or shrink as the view zooms in or out, to keep the symbol a fixed size on the map. If the Map has no reference scale, the reference scale is zero or the FeatureLayer's scaleSymbols property is false, then the symbols and labels will be drawn at their fixed screen size.

Since
100.5

§ sceneProperties

- (AGSLayerSceneProperties*) sceneProperties
readwritenonatomicstrong

Properties to apply only when rendering data in 3D scenes using AGSSceneView

Since
100.2

§ showInLegend

- (BOOL) showInLegend
readwritenonatomicassigninherited

Indicates whether to show legend information.

Since
100

§ spatialReference

- (AGSSpatialReference*) spatialReference
readnonatomicstronginherited

The spatial reference of the layer.

Since
100

§ subLayerContents

- (NSArray<id<AGSLayerContent> >*) subLayerContents
readnonatomiccopyinherited

This layer's sub-layers.

Since
100

§ subLayerContentsChangedHandler

- (void(^ subLayerContentsChangedHandler) ())
readwritenonatomiccopyinherited

Block that is invoked when the sub layer contents changes.

Note
The block will be invoked on the same thread on which the event occured, which could be any arbitrary thread. You need to dispatch any UI related work to the main thread.
Since
100

§ supportsTimeFiltering

- (BOOL) supportsTimeFiltering
readnonatomicassigninherited

Indicates whether the layer supports filtering its contents by a time range 100.2

§ timeFilteringEnabled

- (BOOL) timeFilteringEnabled
readwritenonatomicassigninherited

Indicates whether the layer must use the time extent defined on the owning AGSGeoView::timeExtent and filter its content. Only applicable if the layer supports time filtering (see supportsTimeFiltering) 100.2

§ timeInterval

- (AGSTimeValue*) timeInterval
readnonatomicstronginherited

Returns the suggested time slider step size for this time aware layer. 100.2

§ timeOffset

- (AGSTimeValue*) timeOffset
readwritenonatomicstronginherited

A time offset for this layer. This is useful when data from different layers belong to different time periods and must be displayed together. The offset it applied on-the-fly, it does not change the actual data of the layer. The time offset is subtracted from the time extent set on the owning AGSGeoView::timeExtent before the extent is used to filter content from the layer. 100.2

§ visible

- (BOOL) visible
readwritenonatomicassigninherited

Denotes whether the layer is visible or not.

Since
100