require(["esri/views/2d/layers/BaseLayerView2D"], function(BaseLayerView2D) { /* code goes here */ });
Class: esri/views/2d/layers/BaseLayerView2D
Since: ArcGIS API for JavaScript 4.8
beta

Represents the LayerView of a Layer after it has been added to a Map with a MapView.

This class may be extended to create a custom LayerView for a Layer. A LayerView is created on demand by the MapView when a layer is added the to list of layers of its map.

The subclass can implement multiple functions of the LayerView lifecycle. First, the attach() method is called when the LayerView is about to start drawing the layer's content. Then during the life of the LayerView, the render() method is called during the MapView rendering phase. The render() method has access to a canvas 2d context in which it can render the content available for display. Finally the detach() method is called after the layer is removed from the map. It releases all allocated resources and stops on-going requests.

Example:
var TileBorderLayerView2D = BaseLayerView2D.createSubclass({
   render(renderParameters) {
     var tileSize = this.layer.tileInfo.size[0];
     var state = renderParameters.state;
     var context = renderParameters.context;
     var coords = [0, 0];
     var bounds = [0, 0, 0, 0];

     context.save();

     // apply rotation
     if (!state.rotation !== 0) {
       context.translate(state.width * 0.5, state.height * 0.5);
       context.rotate((state.rotation * Math.PI) / 180);
       context.translate(-state.width * 0.5, -state.height * 0.5);
     }

     for (const tile of this.tiles) {
       var screenScale = tile.resolution / state.resolution;

       state.toScreenNoRotation(coords, tile.coords);
       context.strokeRect(coords[0], coords[1], tileSize * screenScale, tileSize * screenScale);
     }

     context.restore();
   }
 });

 var CustomTileLayer = Layer.createSubclass({
   tileInfo: TileInfo.create({ spatialReference: { wkid: 3857 }}),

   createLayerView(view) {
     if (view.type === "2d") {
       return new TileBorderLayerView2D({
         view: view,
         layer: this
       });
     }
   }
 });

Constructors

new BaseLayerView2D(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

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

References the layer this LayerView represents.

more details
more detailsBaseLayerView2D
Tile[]

The array of Tile objects computed to cover the MapView's visible area.

more details
more detailsBaseLayerView2D
MapView

References the MapView this LayerView belongs to.

more details
more detailsBaseLayerView2D

Property Details

layerLayer

References the layer this LayerView represents.

tilesTile[]

The array of Tile objects computed to cover the MapView's visible area. This array is updated when the view is animating or the user is interacting with it. Then if tiles have been added or removed, tilesChanged() is called.

See also:

References the MapView this LayerView belongs to.

Method Overview

NameReturn TypeSummaryClass

Method called when after the LayerView is created and right before it's asked to draw the layer's content.

more details
more detailsBaseLayerView2D

Method called after the layer is removed and the LayerView is about to be removed.

more details
more detailsBaseLayerView2D

The method to implement that is responsible of drawing the content of the layer.

more details
more detailsBaseLayerView2D

The LayerView can call this method to ask the MapView to schedule a new rendering frame.

more details
more detailsBaseLayerView2D

Method to implement, which notifies of tiles being added or removed for the current view state.

more details
more detailsBaseLayerView2D

Method Details

attach()

Method called when after the LayerView is created and right before it's asked to draw the layer's content. Typically this method is implemented to start watching property changes on the layer for example.

See also:
Example:
attach() {
  this._propertyHandle = this.layer.watch("opacity", function() {
    this.requestRender();
  });
}
detach()

Method called after the layer is removed and the LayerView is about to be removed. Typically, this method is implemented to free resources like watchers.

See also:
Example:
// remove the watchers on the layer that are added in attach()
detach() {
  this._propertyHandle.remove();
  this._propertyHandle = null;
}
render(renderParameters)

The method to implement that is responsible of drawing the content of the layer. This method is called every time the MapView's state changes, or if requestRender() has been called.

Parameters:
renderParameters Object
Specification:

The canvas 2D context in which to draw content.

stationary Boolean

The stationary state of the MapView.

state ViewState

The object that describes view state.

Example:
// Example of a render implementation that draws tile boundaries
render(renderParameters) {
  var tileSize = this.layer.tileInfo.size[0];
  var state = renderParameters.state;
  var context = renderParameters.context;
  var coords = [0, 0];
  var bounds = [0, 0, 0, 0];

  context.save();

  // apply rotation
  if (!state.rotation !== 0) {
    context.translate(state.width * 0.5, state.height * 0.5);
    context.rotate((state.rotation * Math.PI) / 180);
    context.translate(-state.width * 0.5, -state.height * 0.5);
  }

  for (const tile of this.tiles) {
    var screenScale = tile.resolution / state.resolution;

    state.toScreenNoRotation(coords, tile.coords);
    context.strokeRect(coords[0], coords[1], tileSize * screenScale, tileSize * screenScale);
  }

  context.restore();
}
requestRender()protected

The LayerView can call this method to ask the MapView to schedule a new rendering frame.

Example:
// Call requestRender whenever the layer opacity has changed.
attach() {
  this._propertyHandle = this.layer.watch("opacity", function() {
    this.requestRender();
  });
}
tilesChanged(added, removed)

Method to implement, which notifies of tiles being added or removed for the current view state. This function can be implemented to start and stop fetching new data, or allocate and dispose resources.

Parameters:
added Tile[]

The tile objects added for the current view viewport.

removed Tile[]

The tile objects removed from the view viewport.

Type Definitions

TileObject

Represents a tile reference.

Properties:

The tile string identifier in the format level/row/col/world

level Number

The level identifier of the LOD to which the tile belongs

row Number

The row identifier.

col Number

The column identifier.

world Number

When the projection allows world wrapping (e.g. Web Mercator), identifies the instance of the world this tile's level/row/col.

resolution Number

The number of map units per pixel in the tile.

scale Number

The map scale at the tile's level.

coords Number[]

The coordinates of the top-left corner of the tile as an array of two numbers. The coordinates are in un-normalized map units.

bounds Number[]

The bounds of the tile as an array of four numbers that be readily converted to an Extent object.

API Reference search results

NameTypeModule
Loading...