ArcGISSublayer QML Type
A sublayer of a Layer. More...
Import Statement: | import Esri.ArcGISRuntime |
Since: | Esri.ArcGISRuntime 100.0 |
Inherits: | |
Inherited By: | ArcGISMapImageSublayer, ArcGISTiledSublayer, and SubtypeSublayer |
Properties
- autoFetchLegendInfos : bool
- canChangeVisibility : bool
- definitionExpression : string
- error : Error
- labelsEnabled : bool
- legendInfos : LegendInfoListModel
- loadError : Error
- loadStatus : Enums.LoadStatus
- mapServiceSublayerInfo : ArcGISMapServiceSublayerInfo
- maxScale : double
- minScale : double
- opacity : real
- popupDefinition : PopupDefinition
- popupEnabled : bool
- renderer : Renderer
- scaleSymbols : bool
- showInLegend : bool
- subLayerContents : list<LayerContent>
- sublayerId : string
- sublayerIdAsInt : int
- sublayerType : Enums.ArcGISSublayerType
- sublayers : ArcGISSublayerListModel
- visible : bool
Signals
- autoFetchLegendInfosChanged()
- definitionExpressionChanged()
- labelsEnabledChanged()
- loadErrorChanged()
- loadStatusChanged()
- mapServiceSublayerInfoChanged()
- maxScaleChanged()
- minScaleChanged()
- opacityChanged()
- popupDefinitionChanged()
- popupEnabledChanged()
- rendererChanged()
- scaleSymbolsChanged()
- showInLegendChanged()
- sublayerIdAsIntChanged()
- sublayerIdChanged()
- visibleChanged()
Methods
- void cancelLoad()
- bool isVisibleAtScale(double scale)
- void load()
- void retryLoad()
Detailed Description
Note: You cannot declare or create a component of this type in QML code.
Some layer types contain sublayers. Sublayers contain properties, some of which can be accessed before the layer is loaded. These include:
sublayerId
name
maxScale
minScale
visible
Other sublayer properties can be accessed only after the Layer is loaded.
See also Cancelable, LayerContent, Loadable, and PopupSource.
Property Documentation
autoFetchLegendInfos : bool |
See also LayerContent.
canChangeVisibility : bool |
See also LayerContent.
[since Esri.ArcGISRuntime 100.1] definitionExpression : string |
Returns the sublayer's definition expression (read-only).
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.
[since Esri.ArcGISRuntime 100.1] error : Error |
[since Esri.ArcGISRuntime 100.1] labelsEnabled : bool |
Returns whether the sublayer's labels are enabled (read-only).
This property was introduced in Esri.ArcGISRuntime 100.1.
legendInfos : LegendInfoListModel |
Returns a list model containing legend infos for the sublayer and any nested sublayers (read-only).
See also LayerContent.
[since Esri.ArcGISRuntime 100.1] loadError : Error |
Returns the load error (read-only).
Note: load errors are also reported on the error
property and emit the errorChanged
signal.
This property was introduced in Esri.ArcGISRuntime 100.1.
See also Loadable.
[since Esri.ArcGISRuntime 100.1] loadStatus : Enums.LoadStatus |
The Enums.LoadStatus of the Layer.
This property was introduced in Esri.ArcGISRuntime 100.1.
See also Loadable and Enums.LoadStatus.
[since Esri.ArcGISRuntime 100.1] mapServiceSublayerInfo : ArcGISMapServiceSublayerInfo |
Returns the sublayer metadata after the sublayer is loaded (read-only).
Will return a null object if an error occurs or if the sublayer is not loaded.
This property was introduced in Esri.ArcGISRuntime 100.1.
maxScale : double |
Returns the maximum scale at which the sublayer displays (read-only).
minScale : double |
Returns the minimum scale at which the sublayer displays (read-only).
[since Esri.ArcGISRuntime 100.1] opacity : real |
Returns the sublayer's opacity (read-only).
This property was introduced in Esri.ArcGISRuntime 100.1.
popupDefinition : PopupDefinition |
See also PopupSource.
popupEnabled : bool |
See also PopupSource.
[since Esri.ArcGISRuntime 100.1] renderer : Renderer |
Returns the renderer specifying how the features should be symbolized (read-only).
This property was introduced in Esri.ArcGISRuntime 100.1.
[since Esri.ArcGISRuntime 100.1] scaleSymbols : bool |
Returns whether the sublayer renders its symbols based on scale (read-only).
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.
showInLegend : bool |
See also LayerContent.
subLayerContents : list<LayerContent> |
Returns a list of layer contents for any sublayer (read-only).
See also LayerContent.
[since Esri.ArcGISRuntime 100.1] sublayerId : string |
Returns the sublayer ID (read-only).
Note: The underlying 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.1.
See also sublayerIdAsInt.
[since Esri.ArcGISRuntime 100.3] sublayerIdAsInt : int |
The same as sublayerId but represented as an integer type (read-only).
Note: The underlying 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.
sublayerType : Enums.ArcGISSublayerType |
Returns the sublayer's type (read-only).
A sublayer may be an image sublayer or a tiled sublayer, or the type may be unknown.
See also Enums.ArcGISSublayerType.
sublayers : ArcGISSublayerListModel |
The sublayers represented as a list model of ArcGISSublayer.
visible : bool |
See also LayerContent.
Signal Documentation
autoFetchLegendInfosChanged() |
emitted when the autoFetchLegendInfos property changes.
Note: The corresponding handler is onAutoFetchLegendInfosChanged
.
See also LayerContent.
|
Emitted when the definitionExpression property changes.
Note: The corresponding handler is onDefinitionExpressionChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
|
Emitted when the labelsEnabled property changes.
Note: The corresponding handler is onLabelsEnabledChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
|
Emitted when the loadError property of this ArcGISSublayer changes.
Note: load errors are also reported on the error
property and emit the errorChanged
signal.
Note: The corresponding handler is onLoadErrorChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
|
Emitted when the loadStatus property changes.
Note: The corresponding handler is onLoadStatusChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
See also Loadable.
|
Emitted when the mapServiceSublayerInfo property changes.
Note: The corresponding handler is onMapServiceSublayerInfoChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
|
Emitted when the maxScale property changes.
Note: The corresponding handler is onMaxScaleChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
|
Emitted when the minScale property changes.
Note: The corresponding handler is onMinScaleChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
|
Emitted when the opacity property changes.
Note: The corresponding handler is onOpacityChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
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
.
|
Emitted when the renderer property changes.
Note: The corresponding handler is onRendererChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
|
Emitted when the scaleSymbols property changes.
Note: The corresponding handler is onScaleSymbolsChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
showInLegendChanged() |
emitted when the showInLegend property changes.
Note: The corresponding handler is onShowInLegendChanged
.
See also LayerContent.
|
Emitted when the sublayerIdAsInt property changes.
Note: The corresponding handler is onSublayerIdAsIntChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.3.
|
Emitted when the sublayerId property changes.
Note: The corresponding handler is onSublayerIdChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.1.
visibleChanged() |
Emitted when the visible property changes.
Note: The corresponding handler is onVisibleChanged
.
See also LayerContent.
Method Documentation
|
This method was introduced in Esri.ArcGISRuntime 100.1.
See also Loadable.
bool isVisibleAtScale(double scale) |
Returns true
if the sublayer is visible at a given scale.
|
This method was introduced in Esri.ArcGISRuntime 100.1.
See also Loadable.
|
This method was introduced in Esri.ArcGISRuntime 100.1.
See also Loadable.