Class: Overlay

Extends

• H.map.Object

Members

draggable boolean inherited

Indicates whether the map object will be considered as target for drag events. The default value is false

Methods

addEventListener (type, handler, opt_capture, opt_scope) inherited

This method adds a listener for a specific event.

Note that to prevent potential memory leaks, you must either call removeEventListener or dispose on the given object when you no longer need it.

Name	Type	Description
type	string	The name of the event
handler	function	An event handler function
opt_capture	boolean	optional true indicates that the method should listen in the capture phase (bubble otherwise)
opt_scope	Object	optional An object defining the scope for the handler function

addOnDisposeCallback (callback, opt_scope) inherited

This method adds a callback which is triggered when the EventTarget object is being disposed.

Name	Type	Description
callback	function	The callback function.
opt_scope	Object	optional An optional scope for the callback function

compareZOrder (other)number inherited

This method compares the rendering z-order of the given object with another object. (The 'given object' mean the object on which the method has been invoke.)

Name	Type	Description
other	H.map.Object	The map object with which to compare the given object.

Returns:

Type	Description
number	A value lower than 0 indicates that the given object has a lower z-order. 0 indicates that both objects have the same z-order. A value greater than 0, indicates that the given object has a higher z-order.

contains (object)boolean inherited

This method checks whether the received object is an inclusive descendant of the given object.

Name	Type	Description
object	*	The object to check.

Returns:

Type	Description
boolean	true if the given object is contained in the given object, otherwise false

dispatchEvent (evt) inherited

This method dispatches an event on the EventTarget object.

Name	Type	Description
evt	H.util.Event | string	An object representing the event or a string with the event name

dispose () inherited

This method removes listeners from the given object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

getBitmap ()HTMLImageElement | HTMLCanvasElement

This method retrieves the current bitmap of the overlay.

Returns:

Type	Description
HTMLImageElement | HTMLCanvasElement	The bitmap associated with the overlay or null if no bitmap is associated with the overlay.

getBoundingBox ()H.geo.Rect Deprecated : since 3.1.13.0

This method retrieves the current bounding box of the overlay. This method has been deprecated, use H.map.Overlay#getGeometry instead.

Returns:

Type	Description
H.geo.Rect	An object containing the coordinates of the top-left and bottom-right corners of the overlay.

getData ()* inherited

To retrieve arbitrary data associated with the given object.

Returns:

Type	Description
*	The associated data.

getGeometry ()H.geo.Rect

This method retrieves the current geometry of the overlay.

Returns:

Type	Description
H.geo.Rect	An object containing the coordinates of the top-left and bottom-right corners of the overlay.

getId ()* inherited

This method retrieves the ID of the given object.

Returns:

Type	Description
*	The identifier of the given object.

getInvalidations ()H.map.provider.Invalidations inherited

This method retrieves the invalidation states for the given object.

Returns:

Type	Description
H.map.provider.Invalidations	An object containing the invalidation states

getOpacity ()number

This method retrieves the opacity of the overlay.

Returns:

Type	Description
number	A value representing the opacity of the overlay

getParentGroup ()H.map.Group inherited

This method retrieves the parent group which contains the given object or null if the object is not contained in any group.

Returns:

Type	Description
H.map.Group	An object representing the containing group object or null if the given object is not contained in any group.

getProvider ()H.map.provider.ObjectProvider inherited

This method obtains the current provider of the given object.

Returns:

Type	Description
H.map.provider.ObjectProvider	An object representing the provider

getRemoteId ()number | string | undefined inherited

This method retrieves the remote ID of the given object.

Returns:

Type	Description
number | string | undefined	The remote identifier of the given object.

getRootGroup ()H.map.Object inherited

The root object to which the given object is attached or the object itself if it is not attached to another.

Returns:

Type	Description
H.map.Object	An object representing the root group for the given object or the given object if it is not part of a group.

getVisibility (opt_effective)boolean inherited

This method retrieves a value indicating the visibility of the given object.

Name	Type	Description
opt_effective	boolean	optional Indicates whether the effective visibility is requested, defaults to false. If set to true the visibility of all nesting parent groups on the ancestor axis are also taken into account: The object is only visible if the object itself and all of its nesting parent groups are visible.

Returns:

Type	Description
boolean	A value indicating whether the object is visible

getVolatility (opt_effective)boolean inherited

To obtain the volatility indicator of the object.

Name	Type	Description
opt_effective	boolean	optional Indicates whether the effective volatility is requested, defaults to false. If set to true the volatility of all nesting parent groups on the ancestor axis are also taken into account: The object is volatile if the object itself or at least one of its nesting parent groups is volatile.

Returns:

Type	Description
boolean

getZIndex ()number | undefined inherited

This method retrieves the z-index of the given object.

Returns:

Type	Description
number | undefined	A value reflecting the z-index of the given object.

invalidate (flags)boolean inherited

This method invalidates the given map object.

Name	Type	Description
flags	H.math.BitMask.<!H.map.provider.Invalidations.Flag>	The value indicates the types of invalidations to the given object.

Returns:

Type	Description
boolean	Indicates whether a validation was executed (only if the object has a provider)

removeEventListener (type, handler, opt_capture, opt_scope) inherited

This method removes a previously added listener from the EventTarget instance.

Name	Type	Description
type	string	The name of the event
handler	function	A previously added event handler
opt_capture	boolean	optional true indicates that the method should listen in the capture phase (bubble otherwise)
opt_scope	Object	optional An object defining the scope for the handler function

setBitmap (bitmap, opt_crossOrigin)H.map.Overlay

This method sets the bitmap for the given overlay.

Name	Type	Description
bitmap	string | HTMLImageElement | HTMLCanvasElement	An image URL, an SVG image (markup), a bitmap image or a canvas.
opt_crossOrigin	string	optional The value to use for the crossOrigin attribute of the overlay image. If omitted the attribute is not set.

Throws:

if boundingBox or bitmap argument is invalid

Type

H.lang.InvalidArgumentError

Returns:

Type	Description
H.map.Overlay	The overlay object itself

setBoundingBox (boundingBox)H.map.Overlay Deprecated : since 3.1.13.0

This method sets the bounding box of the overlay. This method has been deprecated, use H.map.Overlay#setGeometry instead.

Name	Type	Description
boundingBox	H.geo.Rect	A bounding box to set.

Throws:

if boundingBox argument is invalid

Type

H.lang.InvalidArgumentError

Returns:

Type	Description
H.map.Overlay	The overlay object itself.

setData (data)H.map.Object inherited

This method stores arbitrary data associated with the given object.

Name	Type	Description
data	*	The data to be stored

Returns:

Type	Description
H.map.Object	The given map object itself

setGeometry (geometry)H.map.Overlay

This method sets the bounding box of the overlay. If the given geometry is modified afterwards, it must be set again via setGeometry(geometry) to not violate the integrity of the overlay.

Name	Type	Description
geometry	H.geo.Rect	A geometry to set.

Throws:

if geometry argument is invalid

Type

H.lang.InvalidArgumentError

Returns:

Type	Description
H.map.Overlay	The overlay object itself.

setOpacity (opacity)H.map.Overlay

This method sets the opacity of the overlay.

Name	Type	Description
opacity	number	A value representing opacity; must be in the range from 0 (transparent) to 1 (opaque).

Throws:

if opacity argument is invalid

Type

H.lang.InvalidArgumentError

Returns:

Type	Description
H.map.Overlay	The overlay object itself

setRemoteId (id)H.map.Object inherited

This method sets the ID that identifies the given object in a remote service.

Name	Type	Description
id	number | string	The identifier to assign to the given object.

Returns:

Type	Description
H.map.Object	The given map object itself

setVisibility (opt_visibility)H.map.Object inherited

This method sets the visibility of the given object.

Name	Type	Description
opt_visibility	boolean	optional Indicates whether the map object should be visible, the default value is false.

Returns:

Type	Description
H.map.Object	The given object

setVolatility (opt_volatility)H.map.Object inherited

To set the volatility indicator of the object

Name	Type	Description
opt_volatility	boolean	optional The volatility value to set, true means volatile, false means non-volatile. The default value is false.

Returns:

Type	Description
H.map.Object	The given object

setZIndex (zIndex)H.map.Object inherited

This method sets the z-index of the given object.

Name	Type	Description
zIndex	number | undefined	A value indicating the new z-index

Returns:

Type	Description
H.map.Object	The given object

toGeoJSON (opt_callback)Object inherited

To obtain a GeoJSON Feature object representing the given map object.

Name	Type	Description
opt_callback	function(*)	optional Callback called with the object's data as argument. It must return either a valid JSON object or null which will be set as value for the Feature's properties key.

See:

• GeoJSON spec

Throws:

• If the provided callback is not a function.

  Type

  H.lang.InvalidArgumentError

• If the callback (if provided) returns an invalid JSON object/null or (if not) the object's data is an invalid JSON object.

  Type

  Error

Returns:

Type	Description
Object	A GeoJSON Feature or FeatureCollection object representing the given map object.

Type Definitions

H.map.Overlay.Options Object

Options used to initialize an overlay.

Properties:

Name	Type	Argument	Description
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 undefined.
provider	H.map.provider.Provider	<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> <nullable>	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.