Class: Overlay
- Last UpdatedMay 21, 2025
- 8 minute read
A Overlay is a visual representation of a rectangular area on a map in the form of a bitmap. Overlays are rendered in projected geographical space.
Throws:
-
if boundingBox or bitmap argument is invalid
Extends
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
removeEventListenerordisposeon the given object when you no longer need it. -
addOnDisposeCallback (callback, opt_scope) inherited
-
This method adds a callback which is triggered when the
EventTargetobject is being disposed.Name Type Description callbackfunction The callback function.
opt_scopeObject 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 otherH.map.Object The map object with which to compare the given object.
Returns:
Type Description number A value lower than 0indicates that the given object has a lower z-order.0indicates that both objects have the same z-order. A value greater than0, 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 trueif the given object is contained in the given object, otherwisefalse -
dispatchEvent (evt) inherited
-
This method dispatches an event on the
EventTargetobject.Name Type Description evtH.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
EventTargetmay need to override this method in order to remove references to DOM Elements and additional listeners. -
This method retrieves the current bitmap of the overlay.
Returns:
Type Description HTMLImageElement | HTMLCanvasElement The bitmap associated with the overlay or nullif 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#getGeometryinstead.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 -
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
nullif the object is not contained in any group.Returns:
Type Description H.map.Group An object representing the containing group object or nullif 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_effectiveboolean optional Indicates whether the effective visibility is requested, defaults to
false. If set totruethe 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_effectiveboolean optional Indicates whether the effective volatility is requested, defaults to
false. If set totruethe 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 flagsH.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
EventTargetinstance. -
setBitmap (bitmap, opt_crossOrigin)H.map.Overlay
-
This method sets the bitmap for the given overlay.
Name Type Description bitmapstring | HTMLImageElement | HTMLCanvasElement An image URL, an SVG image (markup), a bitmap image or a canvas.
opt_crossOriginstring optional The value to use for the
crossOriginattribute of the overlay image. If omitted the attribute is not set.Throws:
-
if boundingBox or bitmap argument is invalid
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#setGeometryinstead.Name Type Description boundingBoxH.geo.Rect A bounding box to set.
Throws:
-
if boundingBox argument is invalid
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 geometryH.geo.Rect A geometry to set.
Throws:
-
if geometry argument is invalid
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 opacitynumber A value representing opacity; must be in the range from 0 (transparent) to 1 (opaque).
Throws:
-
if opacity argument is invalid
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 idnumber | 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_visibilityboolean 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_volatilityboolean optional The volatility value to set,
truemeans volatile,falsemeans non-volatile. The default value isfalse.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 zIndexnumber | 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
Featureobject representing the given map object.Name Type Description opt_callbackfunction(*) optional Callback called with the object's data as argument. It must return either a valid JSON object or
nullwhich will be set as value for the Feature's properties key.- See:
Throws:
-
-
If the provided callback is not a function.
-
-
-
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 FeatureorFeatureCollectionobject representing the given map object.
Type Definitions
-
Options used to initialize an overlay.
Properties:
