Class: ObjectLayer

H .map .layer.ObjectLayer

new H.map.layer.ObjectLayer (provider, opt_options)

This class represents a layer which renders map objects. Spatial objects such as polygons and polylines are rendered to tiles before being passed to the rendering engine. Point objects such as markers are provided as objects given an rectangular area.

Name	Type	Description
`provider`	H.map.provider.ObjectProvider	The `ObjectProvider` which provides the map objects to the given object layer.
`opt_options`	H.map.layer.ObjectLayer.Options	optional An object containing the initialization options for the given layer

Extends

H.map.layer.Layer

Implements

Members

max number inherited

This property holds a value of the maximum zoom level at which the given layer can be rendered.

min number inherited

This property holds the value of the minimum zoom level at which the given layer can be rendered.

pixelProjection H.geo.PixelProjection non-null inherited

This property indicates the projection type for the given layer.

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

cancelTile (x, y, z)

Implementation of H.map.layer.ITileLayer#cancelTile.

Name	Type	Description
`x`	number	Tile row position
`y`	number	Tile column position
`z`	number	Zoom level

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.

getCopyrights (boundingBox, level)Array.<!H.map.ICopyright> inherited

This method retrieves the copyright of the current data provider.

Note: This function must be overridden by any class derived from Layer. The default implementation returns null.

Name	Type	Description
`boundingBox`	H.geo.Rect	The bounding box for which to retrieve the copyright information
`level`	number	The zoom level for which to retrieve the copyright information

Returns:

Type	Description
Array.<!H.map.ICopyright>	A list of copyright information objects for the provided area and zoom level

getProvider ()H.map.provider.Provider inherited

This method returns the provider which feeds this layer with data.

Returns:

Type	Description
H.map.provider.Provider	this layer's provider

isValid (zoomLevel)boolean inherited

This method checks if a zoom level can be served by the given layer.

Name	Type	Description
`zoomLevel`	number	The zoom level to check

Returns:

Type	Description
boolean	`true` if the given layer can provide data for the zoom level, otherwise `false`

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

requestDomMarkers (boundingBox, zoomLevel, cacheOnly, prioCenter)H.map.layer.IMarkerLayer.Response | H.map.layer.IMarkerLayer.TiledResponse

This method requests DOM marker objects for a bounding rectangle.

The implementation of this method must return all DOM marker objects which are contained within the bounding rectangle.

The response object returned by this method must contain the number of objects which intersect with the bounding rectangle.

This method is called by the renderer in each rendering cycle. An implementing object must make sure that calling this method does not impede the rendering process.

Name	Type	Description
`boundingBox`	H.geo.Rect	The rectangular area for which marker are to be retrieved
`zoomLevel`	number	The zoom level for which the objects are requested
`cacheOnly`	boolean	A value indicating whether only cached objects are to be considered `true`
`prioCenter`	H.math.Point	The priority center as an offset in screen pixel relative to the center

Returns:

Type	Description
H.map.layer.IMarkerLayer.Response \| H.map.layer.IMarkerLayer.TiledResponse	a response object containing the number of markers and the markers themselves

requestMarkers (boundingBox, zoomLevel, cacheOnly, prioCenter)H.map.layer.IMarkerLayer.Response | H.map.layer.IMarkerLayer.TiledResponse

This method requests marker objects for a bounding rectangle.

The implementation of this method must return all marker objects which are contained within the bounding rectangle.

The response object returned by this method must contain the number of objects which intersect with the bounding rectangle.

This method is called by the renderer in each rendering cycle. An implementing object must make sure that calling this method does not impede the rendering process.

Name	Type	Description
`boundingBox`	H.geo.Rect	The rectangular area for which marker are to be retrieved
`zoomLevel`	number	The zoom level for which the objects are requested
`cacheOnly`	boolean	A value indicating whether only cached objects are to be considered `true`
`prioCenter`	H.math.Point	The priority center as an offset in screen pixels relative to the center

Returns:

Type	Description
H.map.layer.IMarkerLayer.Response \| H.map.layer.IMarkerLayer.TiledResponse	A response object containing the number of markers and the markers themselves

requestOverlays (boundingBox, zoomLevel, cacheOnly, prioCenter)H.map.layer.ObjectLayer.OverlaysResponse

This method retrieves overlay objects for a given bounding box.

Name	Type	Description
`boundingBox`	H.geo.Rect	The bounding box for which overlays are to be returned
`zoomLevel`	number	The zoom level for which the objects are requested
`cacheOnly`	boolean	Indicates whether only cached objects are to be considered
`prioCenter`	H.math.Point	The priority center as an offset in screen pixel relative to the center

Returns:

Type	Description
H.map.layer.ObjectLayer.OverlaysResponse	An object containing all overlays in the given bounding box

requestTile (x, y, z, cacheOnly)H.map.provider.Tile | undefined

Implementation of H.map.layer.ITileLayer#requestTile.

Name	Type	Description
`x`	number	Tile row position
`y`	number	Tile column position
`z`	number	The zoom level for which the tile is requested
`cacheOnly`	boolean	A value indicating whether only cached tiles are to be considered `true`

Returns:

Type	Description
H.map.provider.Tile \| undefined	A tile object matching the supplied coordinates if the tile is already loaded, otherwise the method starts loading the tile and returns `undefined`

requestTiles (boundingBox, zoomLevel, cacheOnly, prioCenter, opt_requesterId)H.map.layer.ITileLayer.Response

Implementation of H.map.layer.ITileLayer#requestTiles.

Name	Type	Description
`boundingBox`	H.geo.Rect	The rectangular area for which tiles are to be returned
`zoomLevel`	number	The zoom level for which the tiles are requested
`cacheOnly`	boolean	Indicates whether only cached tiles are to be considered (`true`)
`prioCenter`	H.math.Point	The priority center as an offset in screen pixel relative to the center
`opt_requesterId`	*	optional Unique identifier of the requester, is used when layer is shared between different maps

Returns:

Type	Description
H.map.layer.ITileLayer.Response	A response object containing the total number of tiles requested and the tile objects that could be immediately returned

setMax (max)H.map.layer.Layer inherited

This method sets the maximum zoom level at which the given layer provides content.

Name	Type	Description
`max`	number	The new maximum zoom level for the given layer

Throws:

if the max parameter is not a number or if it is smaller that the current minimum zoom level

Returns:

Type	Description
H.map.layer.Layer	An object representing the given layer

setMin (min)H.map.layer.Layer inherited

This method sets the minimum zoom level at which the given layer provides content.

Name	Type	Description
`min`	number	The new minimum zoom level for the given layer

Throws:

if the min parameter is not a number or if it is larger that the current maximum zoom level

Returns:

Type	Description
H.map.layer.Layer	An object representing the given layer

Type Definitions

H.map.layer.ObjectLayer.Options Object

This object encapsulates the configuration/initialization properties for the ObjectLayer.

Properties:

Name	Type	Argument	Description
`tileSize`	number	<optional>	The size of the tiles rendered by this layer for polylines and polygons. Must be power of 2, the default is 256.
`tileCacheSize`	number	<optional>	The number of fully rendered spatial tiles that are cached for immediate reuse, the default is 32.
`dataCacheSize`	number	<optional>	The number of tiles to cache which have render data only, the default is 512.
`pixelRatio`	number	<optional>	The pixel ratio to use for over-sampling on high-resolution displays, the default is `window.devicePixelRatio`.

H.map.layer.ObjectLayer.OverlaysResponse Object

A response object returned by the H.map.layer.ObjectLayer#requestOverlays function.

Properties:

Name	Type	Description
`total`	number	The total number of overlays within the requested bounding box, inclusive of overlays which are not yet loaded
`overlays`	Array.<H.map.Overlay>	A list of all overlays which are ready to render

Events

update inherited

Event fired when the data associated with the given layer is updated.

Type:

H.util.Event