Maps API for JavaScript Developer's Guide

H.map.layer.CanvasLayer.Options

Type Definition Summary

This object encapsulates options which can be used when creating new H.map.layer.CanvasLayer.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

min

The minimum zoom level for which the layer is considered for rendering, the default is 0.

max

The maximum zoom level for which the layer is considered for rendering, the default is 22.

dark

Indicates whether the content of the given layer is mainly dark, the default is false. See also H.Map.Options#autoColor.

contextType

The context identifier defining the drawing context associated to the canvas, default is 2d. Supported types are 2d, webgl, webgl2, experimental-webgl. See https://developer.mozilla.org/en/docs/Web/API/HTMLCanvasElement/getContext#Parameters.

contextAttributes

The rendering context attributes. See https://developer.mozilla.org/en/docs/Web/API/HTMLCanvasElement/getContext#Parameters.

Type Definition Description

This object encapsulates options which can be used when creating new H.map.layer.CanvasLayer.

Property Details

min: {number=} [optional]

The minimum zoom level for which the layer is considered for rendering, the default is 0.

max: {number=} [optional]

The maximum zoom level for which the layer is considered for rendering, the default is 22.

dark: {boolean=} [optional]

Indicates whether the content of the given layer is mainly dark, the default is false. See also H.Map.Options#autoColor.

contextType: {(string | undefined)}

The context identifier defining the drawing context associated to the canvas, default is 2d. Supported types are 2d, webgl, webgl2, experimental-webgl. See https://developer.mozilla.org/en/docs/Web/API/HTMLCanvasElement/getContext#Parameters.

contextAttributes: {(Object | undefined)}

The rendering context attributes. See https://developer.mozilla.org/en/docs/Web/API/HTMLCanvasElement/getContext#Parameters.