Enum LayerViewStatus
The status of a layer in the GeoView.
Namespace: Esri.ArcGISRuntime.Mapping
Assembly: Esri.ArcGISRuntime.dll
Syntax
[Flags]
public enum LayerViewStatusRemarks
This status is used to determine whether a layer is displaying in a GeoView or whether it is still loading, not visible, out of scale, or has encountered an error or warning. Each layer can have multiple states at the same time. For example, a layer could be both NotVisible and OutOfScale, or it could be NotVisible and Loading. These multiple states are represented using a flag enumeration.
A status of Active indicates that the layer is being displayed in the view. Note, that some of the layer view states are not possible together. For example, a layer cannot be both Active and NotVisible at the same time.
If you implement a layer list in a table of contents (TOCs), you can use the layer view status to manage the TOC user interface. For example, you could gray out the layer if it is OutOfScale, or you could show a spinning icon if the layer is Loading. If the layer list contains a GroupLayer that is NotVisible then its child layers will be NotVisible. If the GroupLayer is visible then each child layer can be either visible or NotVisible.
If the layer completely fails to load or render you will encounter a Error. If the layer fails to render some of its content then you will encounter a Warning. This could be due to the temporary loss of a network connection, failing layer requests or exceeding the max feature count. In both cases you will find more details about the problem in the Error.
Fields
| Name | Description |
|---|---|
| Active | The layer in the view is active. A status of Active indicates that the layer is being displayed in the view. |
| Error | The layer in the view has an unrecoverable error. When the status is Error, the layer cannot be rendered in the view. For example, it may have failed to load, be an unsupported layer type or contain invalid data. The Error property will provide more details about the specific problem which was encountered. Depending on the type of problem, you could:
|
| Loading | The layer in the view is loading. Once loading has completed, the layer will be available for display in the view. If there was a problem loading the layer, the status will be set to Error and the Error property will provide details on the specific problem. |
| NotVisible | The layer in the view is not visible. |
| OutOfScale | The layer in the view is out of scale. A status of OutOfScale indicates that the view is zoomed outside of the scale range of the layer. If the view is zoomed too far in (e.g. to a street level) it is beyond the max scale defined for the layer. If the view has zoomed to far out (e.g. to global scale) it is beyond the min scale defined for the layer. |
| Warning | The layer in the view has encountered an error which may be temporary. When the status is Warning, the layer may still be displayed in the view. It is possible for the status to be both Active and Warning. A warning status indicates that the layer has encountered a problem but may still be usable. For example, some tiles or features may be failing to load due to network failure or server error. You should be aware that when a Warning is received, the layer may not be showing all data or it may be showing data which is not up-to-date. The Error property will provide more details about the specific problem which was encountered. Depending on the type of problem, you could:
|
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.6 |
| .NET | 100.13 - 200.6 |
| .NET Windows | 100.13 - 200.6 |
| .NET Android | 200.0 - 200.6 |
| .NET iOS | 200.0 - 200.6 |
| .NET Framework | 100.0 - 200.6 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.6 |