Subtype
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 com.arcgismaps.data.ArcGISFeatureTable. The com.arcgismaps.data.ArcGISFeatureTable must have an com.arcgismaps.arcgisservices.ArcGISFeatureLayerInfo.subtypeField and at least one com.arcgismaps.data.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
Creates a new subtype feature layer object. If are there no com.arcgismaps.data.ArcGISFeatureTable.featureSubtypes objects defined on the com.arcgismaps.data.ArcGISFeatureTable, the layer will fail to load.
Creates a new subtype feature layer object from a feature service portal item.
Properties
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
The attribution text for the layer.
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.
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 document.
The description for the layer.
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: Future
Defines the user interface to display when editing a feature in this layer or table. This is null if an error occurs or if the table does not have an associated feature form definition.
Defines properties for dynamically aggregating and summarizing groups of features as the map scale or visible extent changes. com.arcgismaps.mapping.reduction.FeatureReduction is only supported for point feature layers in dynamic rendering mode (FeatureRenderingMode.Dynamic) in 2D. The following conditions will generate a com.arcgismaps.mapping.view.LayerViewState error and will result in the layer rendering the original features.
The feature table whose features are drawn on the map by this layer.
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.
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 its com.arcgismaps.data.FeatureTable.extent.
The full time extent of the layer. If the layer, such as an com.arcgismaps.mapping.layers.ArcGISMapImageLayer, has sublayers with different time extents, fullTimeExtent is a union of its sublayer's time extents.
The unique identifying string for the layer, as 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 com.arcgismaps.geotriggers.FeatureFenceParameters or a com.arcgismaps.mapping.floor.FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.
True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.
A flag indicating whether the PopupDefinition defined on the PopupSource is enable / disable. Will return false if an error occurs.
True if the layer filters data based on its com.arcgismaps.mapping.view.GeoView.timeExtent, false otherwise. This is only applicable if the layer's TimeAware.supportsTimeFiltering value is true. If the com.arcgismaps.mapping.view.GeoView.timeExtent value is null, no time filtering is applied and all content is rendered.
The collection of com.arcgismaps.mapping.labeling.LabelDefinition objects that define how labels are displayed.
True if features in the layer are labelled, otherwise false.
The load status.
The maximum scale for the layer. 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. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.
The minimum scale for the layer. 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. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.
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.
The objects refresh interval. The refresh interval, in milliseconds. A refresh interval of null means never refresh.
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.
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.
Properties that are applied when the layer is rendered in a 3D scene using a com.arcgismaps.mapping.view.SceneView object.
A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.
The spatial reference of the layer.
The sub layer contents of a layer content.
True if the layer supports filtering data based on its time values, false otherwise.
The mode defines whether feature tiling is used to retrieve the features from the feature service. The default tiling mode is FeatureTilingMode.EnabledWhenSupported.
The suggested time slider step size for this time aware layer. You can use this information to set the step size for a time slider control. The value is null if no time interval is suggested. The author of the layer's data typically configures this property if the data has been collected on a regular basis. For example, the daily position of a hurricane.
The amount of time by which the temporal values of this layer's data points are offset when displaying it in a com.arcgismaps.mapping.view.GeoView. The time offset is subtracted from the time extent set on the layer's com.arcgismaps.mapping.view.GeoView. This is useful if you want to overlay data in multiple layers that lies within different temporal extents. For example, if you want to compare data in one layer for a certain year with data in the same layer from the subsequent year, you can create two layers that reference the same data's service endpoint but set the com.arcgismaps.mapping.TimeValue in one of the layers to be one year.
Unknown data from the source JSON. Unknown JSON is a dictionary of values not defined in the ArcGIS specification used to create this object but found in the source JSON. If the object is written back to JSON, any unknown JSON data is not persisted. The ArcGIS specification may be for a web map, web scene, REST API, and so on.
Unsupported data from the source JSON. Unsupported JSON is a dictionary of values defined in the ArcGIS specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted. The ArcGIS specification may be from a web map, web scene, REST API, and so on.
A SharedFlow that emits when the visibility of the layer changes.
Functions
Clones the SubtypeFeatureLayer.
Finds a SubtypeSublayer for a feature subtype based on the com.arcgismaps.data.FeatureSubtype.code. When working with a particular com.arcgismaps.data.ArcGISFeature, the com.arcgismaps.data.FeatureSubtype.code is the value of the com.arcgismaps.arcgisservices.ArcGISFeatureLayerInfo.subtypeField field. The corresponding SubtypeSublayer can be found using the value of that field.
Finds a SubtypeSublayer for a feature subtype based on the subtype name.
Inherited functions
Cancels loading metadata for the Loadable object.
Clears all selected features.
Fetches the list of legend info.
Returns a collection of the currently selected features.
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.
Reset the visibility of all features back to their original state.
Reset the renderer back to the original renderer provided by the com.arcgismaps.data.FeatureTable.
Selects the given feature and adds it to the current collection of selected features. Selected features are rendered according to the com.arcgismaps.mapping.view.GeoView.selectionProperties.
Selects the given features and adds them to the current collection of selected features. Use the FeatureLayer.getSelectedFeatures: Future
Selects the features that match the criteria in the com.arcgismaps.data.QueryParameters object and adds them to the current collection of selected features.
Sets the visibility of the given features.
Sets the visibility of the given feature.
Unselects the given feature and removes it from the current collection of selected features.
Unselects the given features and removes them from the current collection of selected features.