Maps API for JavaScript Developer's Guide

H.map.Overlay.Options

Type Definition Summary

Options used to initialize an overlay.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

min

The minimum zoom level at which the object is visible, the default is -Infinity

max

The maximum zoom level at which the object is visible, the default is Infinity

opacity

The opacity of the object in range from 0 (transparent) to 1 (opaque), the default is 1.

visibility

Indicates whether the map object is visible, the default is true A map object is only treated as visible, if it self and all of its nesting parent groups are visible.

volatility

Indicates whether the map object is volatile, the default is false. A volatile map object has frequently invalidations (for example geometry or style changes). A map object is already treated as volatile, if it self or one of its nesting parent groups is volatile.

zIndex

The z-index value of the map object, the default is 0

provider

The provider of this overlay. This property is needed only if a customized implementation of ObjectProvider wants to instantiate the overlay.

data

Optional arbitrary data to be stored with the map overlay. The data can be retrieved by calling getData().

crossOrigin

The value to use for the crossOrigin attribute of the overlay image, if omitted the attribute is set to "anonymous". For more details see MDN web docs.

Type Definition Description

Options used to initialize an overlay.

Property Details

min: {number=} [optional]

The minimum zoom level at which the object is visible, the default is -Infinity

max: {number=} [optional]

The maximum zoom level at which the object is visible, the default is Infinity

opacity: {number=} [optional]

The opacity of the object in range from 0 (transparent) to 1 (opaque), the default is 1.

visibility: {boolean=} [optional]

Indicates whether the map object is visible, the default is true A map object is only treated as visible, if it self and all of its nesting parent groups are visible.

volatility: {boolean=} [optional]

Indicates whether the map object is volatile, the default is false. A volatile map object has frequently invalidations (for example geometry or style changes). A map object is already treated as volatile, if it self or one of its nesting parent groups is volatile.

zIndex: {number=} [optional]

The z-index value of the map object, the default is 0

provider: {(H.map.provider.Provider | null)=} [optional]

The provider of this overlay. This property is needed only if a customized implementation of ObjectProvider wants to instantiate the overlay.

data: {*}

Optional arbitrary data to be stored with the map overlay. The data can be retrieved by calling getData().

crossOrigin: {?string=} [optional]

The value to use for the crossOrigin attribute of the overlay image, if omitted the attribute is set to "anonymous". For more details see MDN web docs.