CanvasLayer 最后更新时间: 2026年07月02日

AMap.CanvasLayer

Canvas layer class, users can add a Canvas as a layer on the map, the Canvas layer will adaptively scale with the zoom level. Construct a CanvasLayer object, and set the layer properties via ImageLayerOptions

new AMap.CanvasLayer(opts: ImageLayerOptions)

Tutorial

Parameter

opts（ImageLayerOptions）: Canvas layer parameters

Attribute	Type	Description
canvas	HTMLCanvasElement	Canvas DOM object
zooms	[Number, Number]	Supported zoom level range, default range [2-30]
bounds	[Number, Number, Number, Number] \| Bounds	The latitude and longitude range of the canvas, if passing a numeric array type: [minlng, minlat, maxlng, maxlat]
opacity	Number	The transparency of the layer, value range [0 ~ 1], 1 means completely opaque, 0 means completely transparent. Default value: 1
visible	Boolean	Whether to display, default: true
zIndex	Number	The order value of layer overlay, the larger the number, the higher the layer level, with 1 being the bottom layer. Default zIndex: 6

Method

setCanvas(canvas)

Modify Displayed Canvas

Parameter: canvas (HTMLCanvasElement) Displayed Canvas

Demo:

CanvasLayer.setCanvas(canvas);

getElement()

Return the Canvas object

return value: (HTMLCanvasElement) Canvas object

Demo:

CanvasLayer.getElement();

getBounds()

Return the latitude and longitude of the canvas range

return value: (Bounds) Latitude and longitude range values

Demo:

CanvasLayer.getBounds();

setBounds(Bounds)

Set the display range of CanvasLayer

Parameter: Bounds(Bounds) Display Range of CanvasLayer

Demo:

CanvasLayer.setBounds(new AMap.Bounds([116.327911, 39.939229], [116.342659, 39.946275]));

reFresh()

Refresh the layer when the content of the canvas changes, called in 3D view, not needed in 2D view

Demo:

CanvasLayer.reFresh();

getOptions()

Get Layer Parameter Information

return value: (Object) Layer Parameter Information

Demo:

CanvasLayer.getOptions();

getzIndex()

Get Layer Hierarchy

return value: (Number) zIndex layer hierarchy

Demo:

CanvasLayer.getzIndex();

setzIndex(zIndex)

set layer hierarchy, the higher the number the higher the layer hierarchy

Parameter: zIndex (Number) layer hierarchy value

Demo:

CanvasLayer.setzIndex(10);

getOpacity()

get layer transparency

return value: (Number) opacity layer transparency

Demo:

CanvasLayer.getOpacity();

setOpacity(opacity)

Set layer transparency, range [0 ~ 1], 1 means completely opaque, 0 means completely transparent

Parameter: opacity (Number) Layer transparency

Demo:

CanvasLayer.setOpacity(0.5);

getZooms()

Get the displayable level range of this layer, default range is [2-20]

return value: ([Number, Number]) The displayable level range of this layer

Demo:

CanvasLayer.getZooms();

setZooms(zooms)

Set the displayable level range of this layer

Parameter: zooms([Number, Number]) The zoom range in which this layer is visible

Demo:

CanvasLayer.setZooms([8,12]);

show()

Show Layer

Demo:

CanvasLayer.show();

hide()

Hide Layer

Demo:

CanvasLayer.hide();