FeatureLayer QML Type

A layer that can display features from a FeatureTable on a map. More...

Import Statement:	import Esri.ArcGISRuntime 100.15
Since:	Esri.ArcGISRuntime 100.0
Inherits:	Layer
Inherited By:	SubtypeFeatureLayer

Properties

definitionExpression : string
displayFilterDefinition : DisplayFilterDefinition
featureTable : FeatureTable
floorDefinition : LayerFloorDefinition
fullTimeExtent : TimeExtent
item : ArcGISItem
labelDefinitions : LabelDefinitionListModel
labelsEnabled : bool
popupDefinition : PopupDefinition
popupEnabled : bool
refreshInterval : int
renderer : Renderer
renderingMode : Enums.FeatureRenderingMode
scaleSymbols : bool
sceneProperties : LayerSceneProperties
selectFeaturesResult : FeatureQueryResult
selectFeaturesStatus : Enums.TaskStatus
selectedFeaturesResult : FeatureQueryResult
selectedFeaturesStatus : Enums.TaskStatus
serviceLayerId : string
serviceLayerIdAsInt : double
supportsTimeFiltering : bool
tilingMode : Enums.FeatureTilingMode
timeFilteringEnabled : bool
timeInterval : TimeValue
timeOffset : TimeValue
unknownJson : jsobject
unsupportedJson : jsobject

Signals

definitionExpressionChanged()
displayFilterDefinitionChanged()
featureTableChanged()
fullTimeExtentChanged()
labelsEnabledChanged()
popupDefinitionChanged()
popupEnabledChanged()
refreshIntervalChanged()
rendererChanged()
renderingModeChanged()
scaleSymbolsChanged()
scenePropertiesChanged()
selectFeaturesStatusChanged()
selectedFeaturesStatusChanged()
serviceLayerIdAsIntChanged()
serviceLayerIdChanged()
supportsTimeFilteringChanged()
tilingModeChanged()
timeFilteringEnabledChanged()
timeIntervalChanged()
timeOffsetChanged()

Methods

void clearSelection()
void resetFeaturesVisible()
void resetRenderer()
void selectFeature(Feature feature)
void selectFeatures(list<Feature> features)
void selectFeaturesWithQuery(QueryParameters parameters, SelectionMode mode)
void selectedFeatures()
void setFeatureVisible(Feature feature, bool visible)
void setFeaturesVisible(list<Feature> features, bool visible)
void unselectFeature(Feature feature)
void unselectFeatures(list<Feature> features)

Detailed Description

Feature layers display data from feature services or supported local data sources, including shapefiles, GeoPackages, and geodatabases. Feature layers can be used to display, select, and query features in a layer. If the underlying feature service or table supports editing, you can use it with a feature layer as a basis for editing geometry, attributes, and attachments. Feature layers can also be used to store features associated with a utility network.

In a MVC architecture, the FeatureLayer is the view, while the FeatureTable is the model. Use the FeatureLayer to manipulate how the data displays on the map. For example, you can manipulate the opacity of the layer, turn labels on or off, and set a different Renderer through the FeatureLayer. The FeatureTable contains the data, and can be used for querying or editing the data.

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

The feature layer has a load dependency on its featureTable from where it gets information about itself, such as minimum and maximum scale, renderer, and so on.

To display features in a FeatureCollectionTable, use FeatureCollectionLayer instead.

Features are retrieved as needed by the app. Features can be downloaded from a sync-enabled feature service when the device is connected and cached locally for use when the device is offline. Edits can then be synchronized back to the service.

Functional characteristics

The following sources can be rendered using a feature layer:

Feature service - backed by a feature service table. The feature data from the service is cached locally in the table. New features are retrieved automatically when you navigate the map. The local table cache is discarded when the layer is disposed. If sync is enabled, features can be created, edited, and pushed to the server.
Geodatabase - backed by a geodatabase feature table. The geodatabase can be a replica of a feature service, which allows synchronizing with the feature service, or taking the content of a feature service offline. Use a geodatabase sync task to synchronize the geodatabase with the service. The geodatabase can also be a mobile geodatabase created by ArcGIS Pro. Mobile geodatabases cannot be synced and use a default renderer.
Shapefile - backed by a shapefile feature table. Uses a feature layer to show the contents of shapefiles (.shp).
Geopackage - backed by a geopackage feature table. This uses a feature layer to render the tables in a GeoPackage (.gpkg). A GeoPackage is a data source that conforms to the OGC GeoPackage specification. Geopackage feature tables can be edited and saved, but can't support sync, because there is no backing feature service. ArcGIS Runtime supports GeoPackage versions 1.0, 1.1, and 1.2.
Web Feature Service (WFS) - backed by a WFS feature table. You can populate the table using Runtime query parameters or raw XML-encoded GetFeature queries. A WFS feature table only supports manual cache feature request mode. Runtime supports OGC WFS versions 2.0.0 and 2.0.2. WFS server implementations are inconsistent in how they expect coordinates to be formatted. Some return and expect coordinates in (x,y) order, while others expect (y,x). Runtime guesses the correct order by default. This behavior can be configured with the WfsFeatureTable::axisOrder and WfsFeatureTable::filterAxisOrder properties.
OGC API Features - Backed by an OGC feature collection table. You can populate the table using Runtime query parameters. An OCG feature collection table only supports manual cache feature request mode. Runtime supports OGC API - Features - Part 1 and OGC API - Features - Part 2.

Individual features can be queried and filtered based on spatial queries or SQL queries. String comparisons for features queried in service feature tables are case-insensitive.

The features displayed in a FeatureLayer are reprojected to match the Map::spatialReference, if necessary. Local tables cannot be reprojected automatically.

Feature layers expose a FeatureLayer::unsupportedJson property that, for feature layers based on a feature service, returns a dictionary of values known to the supported web map specification but not explicitly exposed through the Runtime API. This lets you access information that was saved with the layer but not used by Runtime. Feature layers also provide a FeatureLayer::unknownJson property to return JSON that was not recognized.

Performance characteristics

Because full feature information is cached locally in a geodatabase, shapefile, or GeoPackage, and features are drawn natively, this layer type offers excellent display performance when zooming and panning the map within the extent of cached features. Querying features is also efficient, enabling app functions such as real-time updates of query results in a map.

The local cache must be initially created, which can be resource-intensive for the server. The initial download to the device may require extensive network usage and subsequent local device storage. App memory increases with the number and complexity of the features cached. Network usage can be eliminated by provisioning the cache directly to the device in advance.

Feature tables backed by a service define three feature request modes. The table's feature request mode controls how and when features are requested from the service:

Enums.FeatureRequestModeOnInteractionCache - Features are requested automatically for the visible map or scene extent. As the user pans and zooms, features are cached locally. If the user returns to an area where features have already been loaded, the table won't need to download those features again.
Enums.FeatureRequestModeManualCache - Features must be manually populated using a call to ServiceFeatureTable::populateFromService. After being populated, all queries are made against the local table only. ServiceFeatureTable::populateFromService can be called again to retrieve more features from the service.
Enums.FeatureRequestModeOnInteractionNoCache - Features are requested automatically for the visible map extent. As the user pans and zooms, features outside the visible extent are not cached and must be downloaded again each time.

Calling load() on the feature layer initiates loading of its featureTable also.

Example:

Display a feature service on a map using a FeatureLayer and ServiceFeatureTable:

Map {
    Basemap {
        initStyle: Enums.BasemapStyleArcGISTerrain
    }
    initialViewpoint: vc

    FeatureLayer {
        ServiceFeatureTable {
            url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Energy/Geology/FeatureServer/9"
        }
    }
}

To display features from a mobile geodatabase, create the Geodatabase, obtain a GeodatabaseFeatureTable, and set the table to the FeatureLayer:

// create a feature layer
FeatureLayer {
    // obtain the feature table from the geodatabase by name
    featureTable: gdb.geodatabaseFeatureTablesByTableName["Trailheads"] ?
                      gdb.geodatabaseFeatureTablesByTableName["Trailheads"] :
                      null

    // create the geodatabase
    Geodatabase {
        id: gdb
        path: dataPath + "geodatabase/LA_Trails.geodatabase"

        onErrorChanged: errorMessage = error.message;
    }

    onErrorChanged: errorMessage = error.message;
}

Note: The FeatureLayer will automatically re-project on-the-fly. For example, a FeatureLayer that is in WKID 4326 could be added to a Map that is in WKID 3857, and the FeatureLayer would project on-the-fly to WKID 3857. This is the case for a FeatureLayer using either a ServiceFeatureTable or a GeodatabaseFeatureTable.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

Type	Default Property
FeatureTable	featureTable
Renderer	renderer
LabelDefinition	labelDefinitions (since Esri.ArcGISRuntime 100.1) (appends to model)
LayerSceneProperties	sceneProperties (since Esri.ArcGISRuntime 100.2)
ArcGISItem	item (since Esri.ArcGISRuntime 100.3)

Example:

Display a feature service on a map using a FeatureLayer and ServiceFeatureTable:

Map {
    Basemap {
        initStyle: Enums.BasemapStyleArcGISTerrain
    }
    initialViewpoint: vc

    FeatureLayer {
        ServiceFeatureTable {
            url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Energy/Geology/FeatureServer/9"
        }
    }
}

To display features from a mobile geodatabase, create the Geodatabase, obtain a GeodatabaseFeatureTable, and set the table to the FeatureLayer:

// create a feature layer
FeatureLayer {
    // obtain the feature table from the geodatabase by name
    featureTable: gdb.geodatabaseFeatureTablesByTableName["Trailheads"] ?
                      gdb.geodatabaseFeatureTablesByTableName["Trailheads"] :
                      null

    // create the geodatabase
    Geodatabase {
        id: gdb
        path: dataPath + "geodatabase/LA_Trails.geodatabase"

        onErrorChanged: errorMessage = error.message;
    }

    onErrorChanged: errorMessage = error.message;
}

Note: You cannot create a FeatureLayer from a FeatureCollectionTable.

For samples, see:

See also Cancelable, LayerContent, Loadable, PopupSource, and TimeAware.

Property Documentation

definitionExpression : string

A SQL expression that limits the features available for query and display on the feature layer.

The definition expression string that is used as the FeatureLayer::definitionExpression should follow standard SQL syntax similar to what is discussed in the document SQL reference for query expressions used in ArcGIS.

The definition expression string uses the SQL-92 WHERE clause syntax. Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. See the ArcGIS Blog article Querying Feature Services Date-Time Queries for more information.

displayFilterDefinition : DisplayFilterDefinition

Defines how features are filtered from the display.

Use this property to declutter the feature display. Because this only affects the display, features filtered by the displayFilterDefinition remain available for query, unlike features filtered by definitionExpression.

This property was introduced in Esri.ArcGISRuntime 100.13.

[default] featureTable : FeatureTable

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

This property cannot be set after the layer has started loading.

floorDefinition : LayerFloorDefinition

Defines the properties that allow a layer to be floor-aware.

When a layer is configured as floor-aware, it has a floorDefinition property that defines properties that allow a layer to be floor-aware. When it is null (default value) the specific layer does not support floor filtering.

This property was introduced in Esri.ArcGISRuntime 100.12.

fullTimeExtent : TimeExtent

Returns the full time extent of the time aware layer (read-only).

Note: This property is only available after the time aware layer is loaded.

This property was introduced in Esri.ArcGISRuntime 100.3.

See also TimeExtent.

[default] item : ArcGISItem

The item being used by the feature layer.

The Item represents a feature layer on ArcGIS Online or an ArcGIS Enterprise portal.

This property can be set along with the serviceLayerId property. The FeatureLayer will fail to load if an invalid portal item is passed in, for example a feature layer portal item.

The item cannot be changed after the layer is loaded.

This property was introduced in Esri.ArcGISRuntime 100.3.

[default] labelDefinitions : LabelDefinitionListModel

Returns the list model of label definitions applied to the layer (read-only).

labelsEnabled : bool

Whether features will be labeled on the map.

popupDefinition : PopupDefinition

See also PopupSource.

popupEnabled : bool

See also PopupSource.

refreshInterval : int

The refresh interval used by the layer in milliseconds.

Layers request features from the service each time this interval elapses.

A value of 0 means to never refresh.

Note: The value is treated as unsigned and cannot be negative.

This property was introduced in Esri.ArcGISRuntime 100.1.

[default] renderer : Renderer

The renderer specifying how the features should be symbolized.

renderingMode : Enums.FeatureRenderingMode

The rendering mode of the feature layer.

The default value is Enums.FeatureRenderingModeAutomatic.

This property was introduced in Esri.ArcGISRuntime 100.2.

See also Enums.FeatureRenderingMode.

scaleSymbols : bool

Whether the sublayer renders its symbols based on scale.

A value of false means the symbols stay the same size in screen units regardless of the map scale.

The default value is false.

This property was introduced in Esri.ArcGISRuntime 100.5.

[default] sceneProperties : LayerSceneProperties

The layer scene properties that can be used to make changes to how features are displayed in a SceneView.

These settings will have no effect if the layer is displayed in a MapView.

This property was introduced in Esri.ArcGISRuntime 100.2.

selectFeaturesResult : FeatureQueryResult

A collection of selected features, the result of the last successful select features task.

selectFeaturesStatus : Enums.TaskStatus

The status for the task to select features.

See also Enums.TaskStatus.

selectedFeaturesResult : FeatureQueryResult

A collection of selected features, the result of the last successful get selected features task.

selectedFeaturesStatus : Enums.TaskStatus

The status for the task to retrieve the collection of selected features.

See also Enums.TaskStatus.

serviceLayerId : string

The service layer ID being used by the feature layer.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This property must be set along with the item property. Failure to set both properties will result in the layer failing to load.

The service layer ID cannot be changed after the layer is loaded.

This property was introduced in Esri.ArcGISRuntime 100.3.

See also serviceLayerIdAsInt.

serviceLayerIdAsInt : double

The same as serviceLayerId but represented as an integer type.

The service layer ID cannot be changed after the layer is loaded.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This property was introduced in Esri.ArcGISRuntime 100.3.

supportsTimeFiltering : bool

Returns whether the time aware layer supports filtering its contents by time values (read-only).

This property was introduced in Esri.ArcGISRuntime 100.3.

tilingMode : Enums.FeatureTilingMode

The feature tiling mode in use by the feature layer.

Default is Enums.FeatureTilingModeEnabledWhenSupported. Determines how feature tiling is handled by the feature layer.

This property was introduced in Esri.ArcGISRuntime 100.10.

timeFilteringEnabled : bool

Returns whether the time aware layer participates in filtering based on the time extent of its geo view.

This property was introduced in Esri.ArcGISRuntime 100.3.

timeInterval : TimeValue

Returns a time interval that represents the suggested step size for use when manipulating the time extent (read-only).

This information can be used to set the step size for a time slider control.

Note: This property is only available after the time aware layer is loaded.

This property was introduced in Esri.ArcGISRuntime 100.3.

See also TimeValue.

timeOffset : TimeValue

The time offset of the time aware layer.

The time offset is subtracted from the time extent set on the time aware layer's geo view. This can be used to overlay data from different periods of time for comparison.

Note: This property is only available after the layer is loaded.

This property was introduced in Esri.ArcGISRuntime 100.3.

See also TimeValue.

unknownJson : jsobject

Returns unknown JSON data from the source JSON. (read-only).

Unknown JSON data consists of values that are in the source JSON but not parsed by ArcGIS Runtime.

This property was introduced in Esri.ArcGISRuntime 100.7.

unsupportedJson : jsobject

Returns unsupported JSON data from the source JSON. (read-only).

Unsupported JSON data consists of values that are supported by web maps, but are not exposed through the ArcGIS Runtime API.

This property was introduced in Esri.ArcGISRuntime 100.7.

Signal Documentation

definitionExpressionChanged()

Emitted when the definitionExpression property changes.

Note: The corresponding handler is onDefinitionExpressionChanged.

displayFilterDefinitionChanged()

Emitted when the displayFilterDefinition property changes.

Note: The corresponding handler is onDisplayFilterDefinitionChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

featureTableChanged()

Emitted when the featureTable property changes.

Note: The corresponding handler is onFeatureTableChanged.

fullTimeExtentChanged()

Emitted when the fullTimeExtent property of the time aware layer changes.

Note: The corresponding handler is onFullTimeExtentChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.

labelsEnabledChanged()

Emitted when the labelsEnabled property changes.

Note: The corresponding handler is onLabelsEnabledChanged.

popupDefinitionChanged()

Emitted when the popupDefinition property changes.

Note: The corresponding handler is onPopupDefinitionChanged.

popupEnabledChanged()

Emitted when the popupEnabled property changes.

Note: The corresponding handler is onPopupEnabledChanged.

refreshIntervalChanged()

Emitted when the refreshInterval property changes.

Note: The corresponding handler is onRefreshIntervalChanged.

This signal was introduced in Esri.ArcGISRuntime 100.1.

rendererChanged()

Emitted when the renderer property changes.

Note: The corresponding handler is onRendererChanged.

renderingModeChanged()

Emitted when the renderingMode property changes.

Note: The corresponding handler is onRenderingModeChanged.

This signal was introduced in Esri.ArcGISRuntime 100.2.

scaleSymbolsChanged()

Emitted when the scaleSymbols property changes.

Note: The corresponding handler is onScaleSymbolsChanged.

This signal was introduced in Esri.ArcGISRuntime 100.5.

scenePropertiesChanged()

Emitted when the sceneProperties property changes.

Note: The corresponding handler is onScenePropertiesChanged.

This signal was introduced in Esri.ArcGISRuntime 100.2.

selectFeaturesStatusChanged()

Emitted when the selectFeaturesStatus property changes.

Note: The corresponding handler is onSelectFeaturesStatusChanged.

selectedFeaturesStatusChanged()

Emitted when the selectedFeaturesStatus property changes.

Note: The corresponding handler is onSelectedFeaturesStatusChanged.

serviceLayerIdAsIntChanged()

Emitted when the serviceLayerIdAsInt property changes.

Note: The corresponding handler is onServiceLayerIdAsIntChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.

serviceLayerIdChanged()

Emitted when the serviceLayerId property changes.

Note: The corresponding handler is onServiceLayerIdChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.

supportsTimeFilteringChanged()

Emitted when the supportsTimeFiltering property of the time aware layer changes.

Note: The corresponding handler is onSupportsTimeFilteringChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.

tilingModeChanged()

Emitted when the tilingMode property changes.

Note: The corresponding handler is onTilingModeChanged.

This signal was introduced in Esri.ArcGISRuntime 100.10.

timeFilteringEnabledChanged()

Emitted when the timeFilteringEnabled property of the time aware layer changes.

Note: The corresponding handler is onTimeFilteringEnabledChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.

timeIntervalChanged()

Emitted when the timeInterval property of the time aware layer changes.

Note: The corresponding handler is onTimeIntervalChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.

timeOffsetChanged()

Emitted when the timeOffset property of the time aware layer changes.

Note: The corresponding handler is onTimeOffsetChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.

Method Documentation

void clearSelection()

Clears selection on all features.

void resetFeaturesVisible()

Resets all features back to visible state.

void resetRenderer()

Resets the renderer back to the original renderer provided by the feature table.

This is useful if you change the renderer and then want to revert back to the original renderer.

void selectFeature(Feature feature)

Selects a feature, adding it to the current selection set.

void selectFeatures(list<Feature> features)

Selects multiple features, adding them to the current selection set.

void selectFeaturesWithQuery(QueryParameters parameters, SelectionMode mode)

Queries for features and selects them, adding them to the current selection set.

parameters - The query parameters. See QueryParameters.
mode - The selection mode. See Enums.SelectionMode.

This method uses an asynchronous task that cannot be started if it is already running from a previous call to selectFeaturesWithQuery. You should check that the selectFeaturesStatus property is not Enums.TaskStatusInProgress before calling this method.

After the task starts, you may use the signal selectFeaturesStatusChanged to monitor task status.

Returns a task ID that can be used to cancel the selectFeaturesWithQuery task.

See also Enums.TaskStatus and Cancelable.

void selectedFeatures()

Retrieves a list of selected features.

This method uses an asynchronous task that cannot be started if it is already running from a previous call to selectedFeatures. You should check that the selectedFeaturesStatus property is not Enums.TaskStatusInProgress before calling this method.

After the task starts, you may use the signal selectedFeaturesStatusChanged to monitor task status.

Returns a task ID that can be used to cancel the selectedFeatures task.

See also Cancelable.

void setFeatureVisible(Feature feature, bool visible)

Sets a feature to be visible or invisible.

void setFeaturesVisible(list<Feature> features, bool visible)

Sets multiple features to be visible or invisible.

void unselectFeature(Feature feature)

Unselects a feature, removing it from the current selection set.

void unselectFeatures(list<Feature> features)

Unselects multiple features, removing them from the current selection set.