var elevLyr = new ElevationLayer({
  // Custom elevation service
  url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Elevation/MtBaldy_Elevation/ImageServer"
});
// Add elevation layer to the map's ground.
map.ground.layers.add(elevLyr);

Property Overview

Property Details

copyrightString

The copyright text as defined by the map service.

declaredClassStringreadonly

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

fullExtentExtent

The full extent of the layer as defined by the map service.

Example:

// zooms the view to the full extent of the layer
layer.then(function(){
  view.goTo(layer.fullExtent);
});

idString

The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.

listModeString

Indicates how the layer should display in the LayerList widget. The known values are listed below.

Value	Description
show	The layer is visible in the table of contents.
hide	The layer is hidden in the table of contents.
hide-children	If the layer is a GroupLayer, hide the children layers from the table of contents.

Default Value: show

loadedBooleanreadonly

Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.

Default Value: false

loadErrorErrorreadonly

The Error object returned if an error occurred while loading.

Default Value: null

loadStatusStringreadonly

Represents the status of a load operation.

Value	Description
not-loaded	The object's resources have not loaded.
loading	The object's resources are currently loading.
loaded	The object's resources have loaded without errors.
failed	The object's resources failed to load. See loadError for more details.

Default Value: not-loaded

loadWarningsObject[]readonly

A list of warnings which occurred while loading.

maxScaleNumber

The maximum scale at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale.

Default Value: 0

Examples:

//The layer will not be visible when the
//view is zoomed beyond a scale of 1:1,000
layer.maxScale = 1000;

//The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0;

minScaleNumber

The minimum scale at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale.

Default Value: 0

Examples:

//The layer will not be visible when the view
//is zoomed beyond a scale of 1:3,000,000
layer.minScale = 3000000;

//The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;

portalItemPortalItem

The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to to load with the layerId property.

Examples:

// while this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // the first layer in the service is returned
});

// set hostname when using an on-premise portal (default is Arcgis Online)
// esriConfig.portalUrl = "http://myHostName.esri.com/arcgis";

// while this example uses FeatureLayer, this same pattern can be
// used for SceneLayers
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

spatialReferenceSpatialReferencereadonly

The spatial reference of the layer as defined by the map service.

tileInfoTileInfo autocast

The tiling scheme information for the layer.

titleString

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

When loading a layer by service url, the title is derived from the service name. When the layer is loaded from a portal item, the title of the portal item will be used instead. Finally, if a layer is loaded as part of a webmap or a webscene, then the title of the layer as stored in the webmap/webscene will be used.

tokenStringreadonly

Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use IdentityManager.registerToken().

typeStringreadonly

The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.

Possible values: base-dynamic | base-elevation | base-tile | elevation | feature | graphics | group | imagery | integrated-mesh | map-image | open-street-map | point-cloud | scene | stream | tile | unknown | unsupported | vector-tile | web-tile

urlString

URL pointing to the Elevation layer resource on an ArcGIS Image Server.

Example:

url: "http://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"

visibleBoolean

Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.

Default Value: true

Example:

// The layer is no longer visible in the view
layer.visible = false;

Method Overview

Method Details

always(callbackOrErrback){Promise}inherited

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:

callbackOrErrback Function optional The function to execute when the promise is rejected or resolved.

Returns:

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

Example:

// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

cancelLoad()inherited

Cancels a load() operation if it is already in progress.

fetchAttributionData(){Promise}inherited

Fetches custom attribution data for the layer when it becomes available.

Returns:

Type	Description
Promise	Resolves to an object containing custom attribution data for the layer.

fetchTile(level, row, column, noDataValue){Promise}

Requests a tile from the service and decodes the data into a linear array of elevation values.

The returned promise resolves with a plain object describing the obtained elevation data for the tile. The object has the following properties:

Property	Type	Description
values	Float32Array	The elevation values contained in the tile.
width	number	The number of elevation values in one row of the tile.
height	number	The number of elevation values in one column of the tile.
maxZError	number	The upper bound for the compression error on the elevation values.

Parameters:

level Number the tile level.

row Number the tile row.

column Number the tile column.

noDataValue Number optional the value to use when a tile is partially missing data.

Returns:

Type	Description
Promise	a Promise which resolves with elevation tile data.

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:

json Object A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:

Type	Description
*	Returns a new instance of this class.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

isFulfilled(){Boolean}inherited

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:

Type	Description
Boolean	Indicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:

Type	Description
Boolean	Indicates whether the promise has been rejected.

isResolved(){Boolean}inherited

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:

Type	Description
Boolean	Indicates whether the promise has been resolved.

load(){Promise}inherited

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

Returns:

Type	Description
Promise	Resolves when the resources have loaded.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters:

type String The name of event to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

otherwise(errback){Promise}inherited

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:

errback Function optional The function to execute when the promise fails.

Returns:

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

Example:

// Although this example uses MapView, any class instance that is a promise may use otherwise() in the same way
var view = new MapView();
view.otherwise(function(error){
  // This function will execute if the promise is rejected due to an error
});

queryElevation(geometry, options){Promise}

Queries the service layer for elevation values for the given geometry. The returned result contains a copy of the geometry with z-values sampled from elevation data from the service. The resolution from which the elevation is queried can be set using the demResolution option. The following table describes the supported values:

demResolution	Description
auto	Automatically chooses an appropriate resolution for each coordinate of the input geometry. The current implementation will try to use the finest available resolution given that the total required number of tile requests does not exceed a certain maximum amount (currently 100). Note that this may result in values being sampled from different resolutions.
finest-contiguous	Sample elevation from the finest available resolution (cell size) across the entire geometry.
{number}	Sample elevation from the resolution closest to the specified resolution (in meters).

In many cases, auto demResolution can be used to get high quality elevation samples without the need to know exactly where the data in the service is located. This is particularly useful for services which combine elevation data from many sources (such as the world elevation service). If more control, or higher quality samples are required, use either finest-contiguous or a fixed {number} resolution.

The returned promise resolves with a plain object containing the following properties:

Property	Type	Description
geometry	Point/Polyline/Multipoint	The geometry with sampled z-values.
sampleInfo?	Object[]	Contains additional information about how the geometry was sampled. This property is present depending on whether the user set options.returnSampleInfo = true, for each coordinate in the geometry.
noDataValue	number	The value used when there is no data available.

The sampleInfo property of the result will be returned if options.returnSampleInfo is set and contains the following properties (for each coordinate):

Property	Type	Description
demResolution	number	The resolution at which the z-value was sampled. If no data was available for sampling for a given coordinate, the dem resolution value will be -1 for that coordinate.

Parameters:

geometry Point | Multipoint | Polyline The geometry to use for sampling elevation data.

options Object optional Additional query options. See the table below. Specification: demResolution Number | String optional Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to auto). See the table above for more details on the different settings. Known Values: auto | finest-contiguous | {number} Default Value: auto returnSampleInfo Boolean optional Indicates whether to return additional sample information for each coordinate. Default Value: false noDataValue Number optional The value to use when there is no data available. Default Value: 0

Returns:

Type	Description
Promise	Resolves to an object with the sampled geometry, resolution information, and no data value.

Example:

require(["esri/layers/ElevationLayer", "esri/geometry/Multipoint"], function(ElevationLayer, Multipoint) {
  var url = "//elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer/";
  var layer = new ElevationLayer(url);

  // Various points across a ridge of the mount everest
  var points = [
     [ 86.9252, 27.9883 ],
     [ 86.9265, 27.9894 ],
     [ 86.9292, 27.9923 ],
     [ 86.9324, 27.9960 ],
     [ 86.9359, 27.9992 ]
   ];

  // Uses "auto" resolution by default
  layer.queryElevation(new Multipoint(points), { returnSampleInfo: true })

    // Successfully sampled all points
    .then(function(result) {
      // Print result of each sampled point to the console
      result.geometry.points.forEach(function(point, index) {
        var elevation = Math.round(point[2]);
        var resolution = result.sampleInfo[index].demResolution;

        var coordinateText = "(" + point[0] + ", " + point[1] + ")";
        var resolutionText = Math.round(resolution) + " meter resolution";

        console.log("Sampled " + coordinateText + ": " + elevation + " at " + resolutionText);
      });
    })

    // Failed to sample (e.g. service unavailable)
    .otherwise(function(error) {
      console.error("Failed to query elevation:", error);
    });
});

then(callback, errback, progback){Promise}inherited

An instance of this class is a Promise. Therefore then() 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 promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:

callback Function optional The function to call when the promise resolves.

errback Function optional The function to execute when the promise fails.

progback Function optional The function to invoke when the promise emits a progress update.

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.then(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
});

toJSON(){Object}

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:

Type	Description
Object	The ArcGIS Portal JSON representation of an instance of this class.

Event Overview

{view: View,layerView: LayerView}

{view: View,layerView: LayerView}

Event Details

layerview-createinherited

Fires after the layer's LayerView is created and rendered in a view.

Properties:

view View The view in which the layerView was created.

layerView LayerView The LayerView rendered in the view representing the layer in layer.

See also:

• View.whenLayerView()

Example:

// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});

layerview-destroyinherited

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Properties:

view View The view in which the layerView was destroyed.

layerView LayerView The destroyed LayerView representing the layer.