AGSLayerViewState.h File Reference

Go to the source code of this file.

Enumerations
enum	AGSLayerViewStatus {   AGSLayerViewStatusActive = 1 << 0 , AGSLayerViewStatusNotVisible = 1 << 1 , AGSLayerViewStatusOutOfScale = 1 << 2 , AGSLayerViewStatusLoading = 1 << 3 ,   AGSLayerViewStatusError = 1 << 4 , AGSLayerViewStatusWarning = 1 << 5 }

Enumeration Type Documentation

AGSLayerViewStatus

enum AGSLayerViewStatus

The status of a layer in the AGSGeoView.

This status is used to determine whether a layer is displaying in an AGSGeoView 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 AGSLayerViewStatusNotVisible and AGSLayerViewStatusOutOfScale, or it could be AGSLayerViewStatusNotVisible and AGSLayerViewStatusLoading. These multiple states are represented using a flag enumeration.

A status of AGSLayerViewStatusActive 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 AGSLayerViewStatusActive and AGSLayerViewStatusNotVisible 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 AGSLayerViewStatusOutOfScale, or you could show a spinning icon if the layer is AGSLayerViewStatusLoading. If the layer list contains an AGSGroupLayer that is AGSLayerViewStatusNotVisible then its child layers will be AGSLayerViewStatusNotVisible. If, the AGSGroupLayer is visible then each child layer can be either visible or AGSLayerViewStatusNotVisible.

If the layer completely fails to load or render you will encounter an AGSLayerViewStatusError. If the layer fails to render some of its content then you will encounter an AGSLayerViewStatusWarning. 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 AGSLayerViewState::error.

See also

AGSLayerViewState

Since

100.0

Enumerator
AGSLayerViewStatusActive	The layer in the view is active.
AGSLayerViewStatusNotVisible	The layer in the view is not visible.
AGSLayerViewStatusOutOfScale	The layer in the view is out of scale.
AGSLayerViewStatusLoading	The layer in the view is loading.
AGSLayerViewStatusError	The layer in the view has an unrecoverable error.
AGSLayerViewStatusWarning	The layer in the view has encountered an error which may be temporary. Since 100. 9