Property Overview

Property Details

allVisibleMapImagesCollection<MapImage>readonly

A collection of all the MapImages from visible sublayers.

allVisiblePointsCollection<Point>readonly

A collection of all the points from visible sublayers.

allVisiblePolygonsCollection<Polygon>readonly

A collection of all the polygons from visible sublayers.

allVisiblePolylinesCollection<Polyline>readonly

A collection of all the polylines from visible sublayers.

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 inherited

The layer being viewed.

suspendedBooleanreadonly inherited

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

updatingBooleanreadonly inherited

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

Default Value:false

visibleBoolean inherited

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

Method Details

always(callbackOrErrback){Promise}inherited

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:

Type	Description
Promise	Returns a new promise for the result of callbackOrErrback.

isFulfilled(){Boolean}inherited

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:

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

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

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}inherited

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

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

otherwise(errback){Promise}inherited

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:

Type	Description
Promise	Returns a new promise for the result of errback.

when(callback, errback){Promise}inherited

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:

Type	Description
Promise	Returns 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
});

Type Definitions

MapImageObject

MapImage represents an image overlay draped onto the terrain.

Properties:

id Number Map image id.

href String URL to the map image.

Extent Extent The Extent of the map image.

rotation Number Rotation of the map image about its center, in degrees. Values can be ±180. The default is 0 (north). Rotations are specified in a counterclockwise direction.