var MyCustomTileLayer = BaseTileLayer.createSubclass({
    // properties of the custom tile layer
    properties: {
      urlTemplate: null,
    },

   // override getTileUrl()
   // generate the tile url for a given level, row and column
   getTileUrl: function (level, row, col) {
     return this.urlTemplate.replace("{z}", level).replace("{x}", col).replace("{y}", row);
   }
});

// override fetchTile() method to process the data returned
// from the server.
 fetchTile: function (level, row, col) {
   // call getTileUrl method to construct the Url for the image
   // for given level, row and column
   var url = this.getTileUrl(level, row, col);

   // request for the tile based on the url returned from getTileUrl() method.
   return esriRequest(url, {
     responseType: "image"
   })
   .then(function (response) {
     // when esriRequest resolves successfully,
     // process the image that is returned
     var image = response.data;
     var width = this.tileInfo.size[0];
     var height = this.tileInfo.size[0];

     // create a canvas with a filled rectangle
     var canvas = document.createElement("canvas");
     var context = canvas.getContext("2d");
     canvas.width = width;
     canvas.height = height;

     // Apply the color provided the the layer to the fill rectangle
     if (this.tint) {
       context.fillStyle = this.tint.toCss();
       context.fillRect(0, 0, width, height);
       // apply multiply blend mode to canvas' fill color and the tile
       // returned from the server to darken the tile
       context.globalCompositeOperation = "multiply";
     }
     context.drawImage(image, 0, 0, width, height);
     return canvas;
   }.bind(this));
}

// Override load method
load: function () {
 // multiply property is an array of ArcGIS cached map services
 this.multiply.forEach(function (layer) {
   // loop through each tile layers and call
   // load method on each layer
   var promise = layer.load();

   // add the promise of each load() method to addResolvingPromise()
   // the custom tile layer will be loaded when every promise is resolved
   this.addResolvingPromise(promise);
 }, this);
}

Property Overview

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.

fullExtentExtentautocast inherited

The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.

Example:

// Once the layer loads, set the view's extent to the layer's fullextent
layer.when(function(){
  view.extent = layer.fullExtent;
});

idString inherited

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

listModeString inherited

Indicates how the layer should display in the LayerList widget. The possible 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 inherited

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

Default Value:false

loadErrorErrorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value:null

loadStatusStringreadonly inherited

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 inherited

A list of warnings which occurred while loading.

maxScaleNumber

The maximum scale (most zoomed in) 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. The maxScale value should always be smaller than the minScale value.

Default Value:0

Examples:

// The layer will not be visible when the view is zoomed in 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 (most zoomed out) 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. The minScale value should always be larger than the maxScale value.

Default Value:0

Examples:

// The layer will not be visible when the view is zoomed out 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;

opacityNumber inherited

The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Default Value:1

Example:

// Makes the layer 50% transparent
layer.opacity = 0.5;

refreshIntervalNumber

Since: ArcGIS API for JavaScript 4.6

Refresh interval of the layer in minutes. Minimum refresh interval is 0.1 minute (6 seconds). Value of 0 indicates no refresh.

Default Value:0

Example:

// the layer will be refreshed every 6 seconds.
layer.refreshInterval = 0.1;

spatialReferenceSpatialReferenceautocast

The spatial reference of the layer.

Default Value:SpatialReference.WebMercator

tileInfoTileInforeadonly

The tiling scheme information for the layer.

tileInfoTileInfoautocast

The tiling scheme information for the layer.

titleString inherited

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

typeStringreadonly

For BaseTileLayer the type is base-tile.

visibleBoolean inherited

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

addResolvingPromise(promiseToLoad){Promise}

Adds a promise to the layer's loadable chain. This is typically used in the load() method to ensure that all loadable resources required for the layer to function are loaded prior to this layer resolving and becoming loaded.

Parameter:

promiseToLoad Promise A promise that must resolve for the layer to resolve and move from the loading status to being loaded.

Returns:

Type	Description
Promise	Resolves when the given promise resolves.

See also:

• Sample - Custom BlendLayer

Example:

// The requiredLayer must load() prior to the MyCustomTileLayer
// resolving and moving to the "loaded" status.
var MyCustomTileLayer = BaseTileLayer.createSubclass({
  load: function() {
    var promise = this.requiredLayer.load();
    this.addResolvingPromise(promise);
  }
});

cancelLoad()inherited

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

emit(type, event)inherited

Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:

type String The name of the event.

event Object The event payload.

fetchAttributionData(){Promise<Object>}inherited

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

Returns:

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

fetchTile(level, row, col, options){Promise<(HTMLImageElement|HTMLCanvasElement)>}

This method fetches a tile for the given level, row and column present in the view. Override this method if the data or image returned from the server needs to be processed before it can be displayed.

Parameters:

level Number Level of detail of the tile to fetch. This value is provided by LayerView.

row Number The row (y) position of the tile fetch. This value is provided by LayerView.

col Number The column (x) position of the tile to fetch. This value is provided by LayerView.

options Object optional Optional settings for the tile request. The options have the following properties.

Returns:

Type	Description
Promise<(HTMLImageElement|HTMLCanvasElement)>	Returns a promise that resolves to an HTMLImageElement or HTMLCanvasElement.

See also:

• Sample - Custom BlendLayer

• Sample - Custom LERC Layer

Example:

// Process the image returned from the server before
// it is displayed.
fetchTile: function (level, row, col) {
  // call getTileUrl method to construct the URL for
  // the image for the given level, row and col
  var url = this.getTileUrl(level, row, col);

  // request for the tile based on the generated url
  return esriRequest(url, {
    responseType: "image"
  })
  .then(function (response) {
    // get the image from the response
    var image = response.data;
    var width = this.tileInfo.size[0];
    var height = this.tileInfo.size[0];

    var canvas = document.createElement("canvas");
    canvas.width = width;
    canvas.height = height;
    var context = canvas.getContext("2d");

    // tint is a custom property of this layer
    // Apply the tint color provided by the application
    // to the canvas
    if (this.tint) {
      context.fillStyle = this.tint.toCss();
      context.fillRect(0, 0, width, height);

      // The pixels of the top layer are multiplied by the corresponding
      // pixel of the bottom layer. A darker picture is the result.
      context.globalCompositeOperation = "multiply";
    }
    context.drawImage(image, 0, 0, width, height);
    return canvas;
  }.bind(this));
}

getTileBounds(level, row, column, out){Number[]}

Returns the bounds of the tile as an array of four numbers that be readily converted to an Extent object. The value for each item in the array is described in the following table:

Index	Value
0	Minimum x-value
1	Minimum y-value
2	Maximum x-value
3	Maximum y-value

Parameters:

level Number The level of detail (LOD) of the tile.

row Number The tile's row (y) position in the dataset.

column Number The tiles column (x) position in the dataset.

out Number[] optional Array for storing the tile bounds or extent.

Returns:

Type	Description
Number[]	Returns an array representing the tile bounds or extent.

getTileUrl(level, row, col){String}

This method returns a URL to an image for a given level, row and column. Override this method to construct the URL for the image based on user interaction.

Parameters:

level Number Level of detail. This value is provided by the LayerView.

row Number Tile row. This value is provided by the LayerView.

col Number Tile column. This value is provided by the LayerView.

Returns:

Type	Description
String	Returns the URL to the tile image.

Example:

// generate the tile url for a given level, row and column
getTileUrl: function (level, row, col) {
  // urlTemplate is a property of the custom layer.
  // value is provided by the application
  return this.urlTemplate.replace("{z}", level).replace("{x}", col).replace("{y}", row);
},

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

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.

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.

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);
});

refresh()

Since: ArcGIS API for JavaScript 4.6

Fetches all the data for the layer.

when(callback, errback){Promise}inherited

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:

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
});

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.