CustomLayer

AMap.CustomLayer

Custom layer is a layer completely specified by the developer to determine the drawing method. Construct a CustomLayer object, and set layer properties through CustomLayerOption

new AMap.CustomLayer(canvas: HTMLCanvasElement, opts: CustomLayerOption)

Tutorial

Parameter

canvas (HTMLCanvasElement) canvas object

opts (CustomLayerOption) Custom layer parameters

Attribute	Type	Description
render	Function	Drawing function, when the initialization is completed, the developer needs to set the render method for this layer, this method needs to achieve the drawing of the layer, the API will automatically call this method at the appropriate time
zooms	[Number, Number]	Layer zoom level range, default: [2, 20]
opacity	Number	The transparency of the layer, ranging from [0 ~ 1], where 1 is completely opaque and 0 is completely transparent. Default: 1
visible	Boolean	Whether to display, default: true
zIndex	Number	The stacking order of layers, the larger the number, the higher the layer level, 1 indicates the bottom layer. Default: 120
alwaysRender	Boolean	Whether to actively refresh, set to true, refreshing at the same frequency as the main map. Default: false

Demo

var cLayer = new AMap.CustomLayer(canvas, {
  zooms: [2, 18],
  zIndex: 120,
  render() {
    // Draw on the canvas
  },
});

Method

getOptions()

Get layer parameter information

return value: (Object) Layer parameter information

Demo:

cLayer.getOptions();

getzIndex()

Get layer level

return value: (Number) zIndex layer level

Demo:

cLayer.getzIndex();

setzIndex(zIndex)

Set layer level, the higher the number, the higher the layer level

Parameter: zIndex (Number) Layer Hierarchy Value

Demo:

cLayer.setzIndex(10);

getOpacity()

Get Layer Opacity

return value: (Number) Opacity Layer Transparency

Demo:

cLayer.getOpacity();

setOpacity(opacity)

Set layer opacity, range [0 ~ 1], where 1 represents completely opaque and 0 represents completely transparent

Parameter: opacity (Number) Layer Opacity

Demo:

cLayer.setOpacity(0.5);

etZooms()

Get the level range at which this layer can be displayed, the default range is [2-20]

return value: ([Number, Number]) The level range at which this layer can be displayed

Demo:

cLayer.getZooms();

setZooms(zooms)

Set the level range at which this layer can be displayed

Parameter: zooms([Number, Number]) The zoom range at which this layer can be displayed

Demo:

cLayer.setZooms([8,12]);

show()

Set layer visibility

Demo:

cLayer.show();

hide()

Set Layer Visibility

Demo:

cLayer.hide();

setMap(map)

Add to Map

Parameter: map (Map) Map Instance Object

Demo:

cLayer.setMap(map);