LayerView

Class: esri/views/layers/LayerView
Inheritance: LayerView Accessor
Since: ArcGIS API for JavaScript 4.0

Represents the view for a single layer after it has been added to either a MapView or a SceneView.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Layer

The layer being viewed.

more details
more detailsLayerView
Boolean

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

more details
more detailsLayerView
Boolean

Value is true when the layer is updating; for example, if it is in the process of fetching data.

more details
more detailsLayerView
Boolean

When true, the layer is visible in the view.

more details
more detailsLayerView

Property Details

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

layerLayerreadonly

The layer being viewed.

suspendedBooleanreadonly

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

updatingBooleanreadonly

Value is true when the layer is updating; for example, if it is in the process of fetching data.

Default Value:false
visibleBoolean

When true, the layer is visible in the view. Set this property to false to hide the layer from the view.

Default Value:true

Method Overview

NameReturn TypeSummaryClass
Promise

Deprecated at 4.7.always() may be used to execute a function if creating an instance of the class is rejected or resolved.*

more details
more detailsLayerView
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).`

more details
more detailsLayerView
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.`

more details
more detailsLayerView
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.`

more details
more detailsLayerView
Promise

Deprecated at 4.7. Use otherwise() to call a function once creating an instance of the class is rejected.*

more details
more detailsLayerView
Promise

when() may be leveraged once an instance of the class is created.`

more details
more detailsLayerView

Method Details

always(callbackOrErrback){Promise}
Deprecated
  • Deprecated at 4.7. This method will be removed at 4.8.

Deprecated at 4.7. always() may be used to execute a function if creating an instance of the class is rejected or resolved. The input function will always execute no matter the response.

Parameter:
callbackOrErrback Function
optional

The function to execute when creating an instance of the class is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
isFulfilled(){Boolean}

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been resolved.
otherwise(errback){Promise}
Deprecated
  • Deprecated at 4.7. This method will be removed at 4.8.

Deprecated at 4.7. Use otherwise() to call a function once creating an instance of the class is rejected.

Parameter:
errback Function
optional

The function to execute when creating an instance of the class fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
when(callback, errback){Promise}
Since: ArcGIS API for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});
Searching...

API Reference search results

NameTypeModule

There were no match results from your search criteria.