arcgis-maps-kotlin/com.arcgismaps.mapping.layers/SubtypeFeatureLayer

SubtypeFeatureLayer

class SubtypeFeatureLayer : FeatureLayer

A layer that can visualize feature data with different visibility, rendering, popup properties, and so on for some or all of the subtypes in an ArcGISFeatureTable. The ArcGISFeatureTable must have an ArcGISFeatureLayerInfo.subtypeField and at least one FeatureSubtype defined, otherwise the layer will fail to load.

Subtypes provide a way to organize your data within an ArcGIS feature table. For example, the streets in a city streets feature table could be categorized into three subtypes - local streets, collector streets, and arterial streets. The benefit of the subtype feature layer is that it allows you to configure different layer properties per subtype. This is particularly useful for data, such as utility networks, in which many different network elements are grouped into a single subtype feature layer.

Functional characteristics The subtype feature layer acts like a group layer that automatically creates one feature layer, or subtype sublayer, for each subtype in the table. Each subtype sublayer can be configured independently of one another. They can have different renderers, label definitions, max and min scales, visibility, layer order in the map, and so on. When a subtype group layer is read from a web map or mobile map, it is represented as a SubtypeFeatureLayer. Saving a map that contains a SubtypeFeatureLayer will save the layer as a subtype group layer. Subtype feature layers are supported in offline maps and will work in offline editing workflows.

Performance characteristics Queries are optimized across all sublayers. For example, a pan of the map sends a single request to the feature table to cover all the sublayers. If you had manually created a feature layer for each subtype, this would have resulted in one query per feature layer.

Since

200.1.0

Constructors

SubtypeFeatureLayer

fun SubtypeFeatureLayer(featureTable: ArcGISFeatureTable)

Creates a new subtype feature layer object. If are there no ArcGISFeatureTable.featureSubtypes objects defined on the ArcGISFeatureTable, the layer will fail to load.

SubtypeFeatureLayer

fun SubtypeFeatureLayer(item: Item, layerId: Long)

Creates a new subtype feature layer object from a feature service portal item.

Properties

subtypeSublayers

val subtypeSublayers: MutableList<SubtypeSublayer>

The mutable collection of SubtypeSublayer The objects in this collection are the same objects in LayerContent.subLayerContents. The difference between the two collections is this collection is modifiable so the layer order is configurable.

Inherited properties

attribution

open val attribution: String

The attribution text for the layer.

canChangeVisibility

open override val canChangeVisibility: Boolean

A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

definitionExpression

var definitionExpression: String

A SQL expression which limits the features available for query and display on the feature layer. The definition expression string should follow standard SQL syntax as detailed in the SQL reference for query expressions used in ArcGIS[https://pro.arcgis.com/en/pro-app/latest/help/mapping/navigation/sql-reference-for-elements-used-in-query-expressions.htm] document.

description

var description: String

The description for the layer. The description of the layer.

displayFilterDefinition

var displayFilterDefinition: DisplayFilterDefinition?

Defines how features are filtered from the display. Use this property to reduce the number of features displayed in the map or scene view. The filter aims to improve data visualization and optimize rendering performance. It only affects the display of features so all features are still available for query methods such as FeatureLayer.selectFeatures(QueryParameters, SelectionMode): Future.

featureTable

val featureTable: FeatureTable?

The feature table whose features are drawn on the map by this layer.

floorDefinition

open override var floorDefinition: LayerFloorDefinition?

Defines the properties that allow a layer to be floor-aware. When a layer is configured as floor-aware, it has a FloorAware.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.

fullExtent

val fullExtent: Envelope?

The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from the tables extent.

fullTimeExtent

open override val fullTimeExtent: StateFlow<TimeExtent?>

The full time extent of the object. A null if the object is not time aware or if an error occurs.

var id: String

The unique identifying string for the layer, for example specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.

isIdentifyEnabled

val isIdentifyEnabled: Boolean

Whether the layer supports identify. If the layer is not loaded it may return false if identify support is determined by metadata that is not yet available.

isPopupEnabled

open override var isPopupEnabled: Boolean

A flag indicating whether the PopupDefinition defined on the PopupSource is enable / disable. Will return false if an error occurs.

isTimeFilteringEnabled

open override var isTimeFilteringEnabled: Boolean

A flag indicating whether the object must use the time extent defined on the owning GeoView to filter its data.

isVisible

open override var isVisible: Boolean

The layer content's visibility. The layer content visibility. Will return false if an error occurs.

item

val item: Item?

The item the layer has been created from.

labelDefinitions

val labelDefinitions: MutableList<LabelDefinition>

The collection of LabelDefinition objects that define how labels are displayed.

labelsEnabled

var labelsEnabled: Boolean

True if features in the layer are labelled, otherwise false.

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

maxScale

var maxScale: Double?

The maximum scale for the layer. This controls the maximum scale level the layer can zoom to. All of the connected map views will be updated.

minScale

var minScale: Double?

The minimum scale for the layer. This controls the minimum scale level the layer can zoom to. All of the connected map views will be updated.

name

open override val name: String

The layer content's name. The layer content name.

opacity

var opacity: Float

The opacity for the layer. All of the connected map views will be updated.

popupDefinition

open override var popupDefinition: PopupDefinition?

The pop-up definition. The PopupDefinition associated with the popup source. A null if an error occurs or if the popup source is not associated with a pop-up definition.

renderer

var renderer: Renderer?

The renderer specifies how the features are symbolized.

renderingMode

var renderingMode: FeatureRenderingMode

The mode defines how the feature layer is rendered. FeatureRenderingMode.Static mode is better suited for displaying large datasets (in terms of the number of vertices) and for complex symbology because it does not update the layer's display while pan/zoom operations are in progress.

scaleSymbols

var scaleSymbols: Boolean

True if the layer's symbols and labels honor the map's reference scale, otherwise false. If the map has a positive reference scale, and the layer honors it, then symbols and labels are drawn at their specified size when the viewing scale is the same as the reference scale. They 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 this feature layer's scaleSymbols property is false, then the symbols and labels will be drawn at their fixed screen size.

sceneProperties

var sceneProperties: LayerSceneProperties

Properties that are applied when the layer is rendered in a 3D scene using a SceneView object.

showInLegend

open override var showInLegend: Boolean

A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.

spatialReference

val spatialReference: SpatialReference?

The spatial reference of the layer.

subLayerContents

open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

supportsTimeFiltering

open override val supportsTimeFiltering: Boolean

A flag indicating whether the object supports filtering its contents by time values with the extent set on the owning GeoView.

tilingMode

var tilingMode: FeatureTilingMode

The mode defines whether feature tiling is used to retrieve the features from the feature service. The default tiling mode is FeatureTilingMode.EnabledWhenSupported.

timeInterval

open override val timeInterval: TimeValue?

The suggested time slider step size for this time aware object. Can be null if no time interval is suggested for this time aware object.

timeOffset

open override var timeOffset: TimeValue?

The time offset applied to this object. The offset is subtracted from the time extent set on the owning GeoView. This allows for data from different periods of time to be compared.

unknownJson

val unknownJson: Map<String, Any>

Unknown data from the source JSON. Unknown JSON is a dictionary of values that are in the source JSON, but not parsed by this API.

unsupportedJson

val unsupportedJson: Map<String, Any>

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values that are supported by web maps, but not exposed by this API.

visibilityChanged

val visibilityChanged: SharedFlow<Boolean>

Callback invoked when the visibility of the layer changes.

Functions

clone

open override fun clone(): SubtypeFeatureLayer

Clones the SubtypeFeatureLayer.

getSublayerWithSubtypeCode

fun getSublayerWithSubtypeCode(code: Any): SubtypeSublayer?

Finds a SubtypeSublayer for a feature subtype based on the FeatureSubtype.code When working with a particular ArcGISFeature, the FeatureSubtype.code is the value of the ArcGISFeatureLayerInfo.subtypeField field. The corresponding SubtypeSublayer can be found using the value of that field.

getSublayerWithSubtypeName

fun getSublayerWithSubtypeName(name: String): SubtypeSublayer?

Finds a SubtypeSublayer for a feature subtype based on the subtype name.

Inherited functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

clearSelection

fun clearSelection()

Clears all selected features.

equals

open operator override fun equals(other: Any?): Boolean

fetchLegendInfos

open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

getSelectedFeatures

suspend fun getSelectedFeatures(): Result<FeatureQueryResult>

Returns a collection of the currently selected features.

hashCode

open override fun hashCode(): Int

isVisibleAtScale

open override fun isVisibleAtScale(scale: Double): Boolean

Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.

load

open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

resetFeaturesVisible

fun resetFeaturesVisible()

Reset the visibility of all features back to their original state.

resetRenderer

fun resetRenderer()

Reset the renderer back to the original renderer provided by the FeatureTable.

retryLoad

open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.

selectFeature

fun selectFeature(feature: Feature)

Selects the given feature and adds it to the current collection of selected features. Selected features are rendered according to the GeoView.selectionProperties.

selectFeatures

fun selectFeatures(features: Iterable<Feature>)

Selects the given features and adds them to the current collection of selected features. Use the FeatureLayer.getSelectedFeatures(): Future to retrieve all of the selected features.