Class ArcGISSublayer
The base class for ArcGIS sublayer classes such as ArcGISMapImageSublayer, ArcGISTiledSublayer, and SubtypeSublayer.
Namespace: Esri.ArcGISRuntime.Mapping
Assembly: Esri.ArcGISRuntime.dll
Syntax
public abstract class ArcGISSublayer : INotifyPropertyChanged, ILayerContent, IPopupSource, ILoadableRemarks
Some layers, such as ArcGISMapImageLayer, ArcGISTiledLayer, and SubtypeFeatureLayer, represent a collection of one or more layers that are referred to as sublayers. For example, ArcGISMapImageLayer represents the collection of Sublayers.
If one of the sublayers is a group layer (where the SublayerType is GroupLayer, for example), it will also have a collection of sublayers. Use Sublayers to obtain the collection of sublayers. If one of these sublayers is a group layer it will also contain a collection of sublayers, and so on.
Note: Some of the sublayer properties can only be accessed once the sublayer has loaded.
Properties
| Name | Description |
|---|---|
| CanChangeVisibility | Gets a value indicating whether the sublayer content's visibility can be changed. |
| DefinitionExpression | Gets a SQL statement where clause that stipulates a subset of features to be displayed. |
| Id | Gets an id that uniquely identifies this sublayer instance. |
| IsPopupEnabled | Gets or sets a value indicating whether the PopupDefinition defined is enabled. |
| IsVisible | Gets or sets a value indicating whether the sublayer content is visible. |
| LabelsEnabled | Gets a value indicating whether labels should be displayed on this sublayer. |
| LoadError | Gets the System.Exception associated with the last load error. |
| LoadStatus | Gets the load status. |
| MapServiceSublayerInfo | Gets this sublayer's metadata. |
| MaxScale | Gets the maximum scale at which this sublayer is visible. |
| MinScale | Gets the minimum scale at which this sublayer is visible. |
| Name | Gets the name of the sublayer. |
| Opacity | Gets the opacity of this sublayer. |
| PopupDefinition | Gets or sets the popup definition for the sublayer. |
| Renderer | Gets this sublayer's Renderer. |
| ScaleSymbols | Gets a value indicating whether this sublayer renders its symbols based on scale. |
| ShowInLegend | Gets or sets a value indicating whether the sublayer participates in the legend. |
| SublayerContents | Gets a read-only collection of ILayerContent for this sublayer. |
| Sublayers | Gets the collection of sublayers of this sublayer. |
Methods
| Name | Description |
|---|---|
| CancelLoad() | Cancel loading metadata for the object. |
| Clone() | Clones this instance of the ArcGISSublayer and its members. |
| GetLegendInfosAsync() | Asynchronously retrieves a read-only list of LegendInfo objects. |
| IsVisibleAtScale(Double) | Retrieves the sublayer's visibility at the specified scale. |
| LoadAsync() | Load the metadata for the object asynchronously. |
| OnSublayerLoaded() | Called when the sublayer is done loading. |
| RetryLoadAsync() | Load the metadata for the object asynchronously. |
Events
| Name | Description |
|---|---|
| Loaded | Event that is raised when the object is done loading. |
| LoadStatusChanged | Event that is raised when the LoadStatus property changes. |
| Name | Description |
|---|---|
| INotifyPropertyChanged.PropertyChanged | Occurs when a property value changes. |
See Also
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.8 |
| .NET | 100.13 - 200.8 |
| .NET Windows | 100.13 - 200.8 |
| .NET Android | 200.0 - 200.8 |
| .NET iOS | 200.0 - 200.8 |
| .NET Framework | 100.0 - 200.8 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.8 |