A sublayer of an ArcGISMapImageLayer. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
- List of all members, including inherited members
- ArcGISMapImageSublayer is part of QML Type List.
Properties
- defaultVisibility : bool
- definitionExpression : string
- labelDefinitions : LabelDefinitionListModel
- labelsEnabled : bool
- maxScale : double
- minScale : double
- name : string
- opacity : real
- renderer : Renderer
- scaleSymbols : bool
- source : SublayerSource
- sublayerId : string
- sublayerIdAsInt : int
- table : ServiceFeatureTable
Signals
Detailed Description
ArcGISMapImageLayer displays maps from an ArcGIS map server. Each layer in the underlying map service is represented by an ArcGISSublayer. Sublayers can be accessed from the ArcGISMapImageLayer as ArcGISMapImageSublayer. You can control the visibility and symbols of sublayers and filter data with layer definition expressions.
You can get this object from ArcGISMapImageLayer::mapImageSublayers after the map image layer is loaded, or you can get a collection of handles from another map image sublayer by using ArcGISSublayer::sublayers. The sublayer ID is the index number of the map layer that is listed in the ArcGIS REST Services Directory documentation for the service.
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 |
|---|---|
| Renderer | renderer (since Esri.ArcGISRuntime 100.1) |
| SublayerSource | source (since Esri.ArcGISRuntime 100.1) |
| LabelDefinition | labelDefinitions (since Esri.ArcGISRuntime 100.1) (appends to model) |
See also Cancelable and LayerContent.
Property Documentation
[read-only, since Esri.ArcGISRuntime 100.1] defaultVisibility : bool |
Returns whether the sublayer is visible by default (read-only).
This property was introduced in Esri.ArcGISRuntime 100.1.
[since Esri.ArcGISRuntime 100.1] definitionExpression : string |
The sublayer's definition expression.
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.
This property was introduced in Esri.ArcGISRuntime 100.1.
[default] labelDefinitions : LabelDefinitionListModel |
Returns the list model of label definitions applied to the layer (read-only).
[since Esri.ArcGISRuntime 100.1] labelsEnabled : bool |
Whether the sublayer's labels are displayed.
This property was introduced in Esri.ArcGISRuntime 100.1.
[since Esri.ArcGISRuntime 100.1] maxScale : double |
The maximum scale at which the sublayer displays.
This property was introduced in Esri.ArcGISRuntime 100.1.
[since Esri.ArcGISRuntime 100.1] minScale : double |
The minimum scale at which the sublayer displays.
This property was introduced in Esri.ArcGISRuntime 100.1.
name : string |
The name of the sublayer.
[since Esri.ArcGISRuntime 100.1] opacity : real |
The sublayer's opacity.
This property was introduced in Esri.ArcGISRuntime 100.1.
[default, since Esri.ArcGISRuntime 100.1] renderer : Renderer |
The renderer specifying how the features should be symbolized.
This property was introduced in Esri.ArcGISRuntime 100.1.
[since Esri.ArcGISRuntime 100.1] 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.1.
[default, since Esri.ArcGISRuntime 100.1] source : SublayerSource |
The sublayer source.
This property can be set only when instantiating this type.
This property was introduced in Esri.ArcGISRuntime 100.1.
[since Esri.ArcGISRuntime 100.1] sublayerId : string |
The sublayer ID.
This is the ID (or index number) of map layer that is listed in the ArcGIS REST Services Directory documentation for the service.
The sublayerId can only be set during instantiation of an ArcGISMapImageSublayer. Once set, the ArcGISMapImageSublayer can be given to an ArcGISMapImageLayer before the layer is loaded. This will result in the ArcGISMapImageLayer containing and rendering just the specified sublayers after loaded.
Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.
Note: sublayerId and sublayerIdAsInt can be used interchangeably. Both reference the same underlying API property.
This property was introduced in Esri.ArcGISRuntime 100.1.
[since Esri.ArcGISRuntime 100.3] sublayerIdAsInt : int |
The same as sublayerId but represented as an integer type.
Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.
Note: sublayerIdAsInt and sublayerId can be used interchangeably. Both reference the same underlying API property.
This property was introduced in Esri.ArcGISRuntime 100.3.
[read-only, since Esri.ArcGISRuntime 100.3] table : ServiceFeatureTable |
The sublayer's feature table.
This only applies to sublayers of type "Feature layer" or "Table". This method returns null if the sublayer has not been loaded.
This property was introduced in Esri.ArcGISRuntime 100.3.
Signal Documentation
|
Emitted when the source property changes.
Note: The corresponding handler is onSourceChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
|
Emitted when the table property changes.
Note: The corresponding handler is onTableChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.