Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.mapping.view

Class LayerViewState

java.lang.Object

com.esri.arcgisruntime.mapping.view.LayerViewState

public final class LayerViewState
extends Object

The state of a layer in a GeoView.

This object allows you to know the current state of a layer in a view.

Since:

100.10.0

See Also:

• GeoView.getViewStateForLayer(Layer)

Method Summary

Modifier and Type	Method	Description
ArcGISRuntimeException	getError()	Gets the error that describes a problem encountered when displaying layers in a GeoView.
EnumSet<LayerViewStatus>	getStatus()	Gets a set of view states that apply to a layer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getError

public ArcGISRuntimeException getError()

Gets the error that describes a problem encountered when displaying layers in a GeoView.

For your application, an error may be critical for the user's interaction with the view's data content. Depending on the type of problem encountered, you could:

• Call Layer.retryLoadAsync()
• Remove the layer from the ArcGISMap or ArcGISScene
• Inspect the data
• Check your network connection
• Check whether an online service is experiencing problems.

Returns:

the error that describes a problem encountered when displaying layers in a GeoView, or null if none

Since:

100.10.0

getStatus

public EnumSet<LayerViewStatus> getStatus()

Gets a set of view states that apply to a layer. This can be used, for example, to report layer status in a map legend or table of contents.

Each layer may have more than one view status; for example, a layer may be LOADING, and therefore NOT_VISIBLE, or may be NOT_VISIBLE because it is currently OUT_OF_SCALE. If the layer is ACTIVE, this can be combined with LayerViewStatus.WARNING. For child layers of group layers, the parent layers status is taken into account.

Returns:

the layer view status(es) which apply to the given layer

Since:

100.10.0