Class: ObjectProvider

Extends

• H.map.provider.Provider

Members

max number inherited

This property holds a value indicating the maximum zoom level at which the given provider can serve data. The value is set at construction time.

min number inherited

This property holds a value indicating the minimum zoom level at which the given provider can serve data. The value is set at construction time.

uid string inherited

This property holds the unique identifier for the provider instance. The value is generated at construction time.

uri string inherited

This property holds the provider's unique resource identifier. If it is not provided at construction time, it defaults to provider's uid.

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

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 copyrights for the provided content for a certain geographical area and zoom level.

Note: This function may be overridden by H.map.provider.Provider.Options getCopyrights property. The default implementation returns null.

Name	Type	Description
boundingBox	H.geo.Rect	The rectangular area 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

getInvalidations (opt_type)H.map.provider.Invalidations

This method retrieves the accumulated invalidations of the given provider's objects.

Name	Type	Description
opt_type	H.map.Object.Type	optional The type of objects to consider for the invalidations. If undefined, all types are taken into account.

Returns:

Type	Description
H.map.provider.Invalidations	An object specifying invalidations

getStyleInternal ()H.map.render.Style.<!Object> inherited

This methods returns the style used to render the provider data.

Returns:

Type	Description
H.map.render.Style.<!Object>

invalidateObject (mapObject, changes)

This method signals to the provider that a map object has changed. The method updates the Invalidations of the given provider and the specified map object and triggers dispatchUpdate().

Name	Type	Description
mapObject	H.map.Object	The map object to be invalidated
changes	H.math.BitMask.<!H.map.provider.Invalidations.Flag>	The flags indicating the types of changes that have occurred

providesDomMarkers ()boolean inherited

This method checks whether this provider will provide DomMarker map objects. A concrete implementation of Provider must override it if it will provide DomMarkers.

Returns:

Type	Description
boolean	A value indicating if the given provider provides DomMarkers (true) or not (false)

providesGeoJSON ()boolean inherited

This method checks whether this provider will provide data in GeoJSON format. A concrete implementation of Provider must override it if it will provide GeoJSON data.

Returns:

Type	Description
boolean	A value indicating if the given provider provides GeoJSON data (true) or not (false)

providesMarkers ()boolean inherited

This method checks whether this provider will provide Marker map objects. A concrete implementation of Provider must override it if it will provide Markers.

Returns:

Type	Description
boolean	A value indicating if the given provider provides Markers (true) or not (false)

providesOMV ()boolean inherited

This method checks whether this provider will provide data in OMV format. A concrete implementation of Provider must override it if it will provide OMV data.

Returns:

Type	Description
boolean	A value indicating if the given provider provides OMV data (true) or not (false)

providesOverlays ()boolean inherited

This method checks whether this provider will provide overlay map objects. A concrete implementation of Provider must override it if it will provide overlays.

Returns:

Type	Description
boolean	true if the provider provides overlays, otherwise false

providesRasters ()boolean inherited

This method checks whether this provider will provide bitmap images as tiles. A concrete implementation of Provider must override it if it will provide raster tiles.

Returns:

Type	Description
boolean	A value indicating if the given provider provides raster tiles (true) or not (false)

providesSpatials ()boolean inherited

This method checks whether this provider will provide spatial map objects. A concrete implementation of Provider must override it if it will provide Spatials.

Returns:

Type	Description
boolean	A value indicating whether the provider provides map objects (true) or not (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 (geoRect, zoomLevel, visiblesOnly, cacheOnly)Array.<!H.map.DomMarker> abstract

This method retrieves all DomMarker map objects which intersect with the provided rectangular area.

Name	Type	Description
geoRect	H.geo.Rect	A rectangular area defined in terms of the geographic coordinates of its top-left and bottom-right corners
zoomLevel	number | undefined	The zoom level for which the objects are requested, or undefined to retrieve all objects for any zoom level
visiblesOnly	boolean	Indicates whether only objects that are effectively visible are requested
cacheOnly	boolean	A value indicating whether only cached objects are to be considered (true) or not (false)

Returns:

Type	Description
Array.<!H.map.DomMarker>	A list of intersecting objects

requestMarkers (geoRect, zoomLevel, visiblesOnly, cacheOnly)Array.<!H.map.Marker> abstract

This method retrieves all Marker map objects which intersect with the provided rectangular area.

Name	Type	Description
geoRect	H.geo.Rect	A rectangular area defined in terms of the geographic coordinates of its top-left and bottom-right corners
zoomLevel	number | undefined	The zoom level for which the objects are requested, or undefined to retrieve all objects for any zoom level
visiblesOnly	boolean	Indicates whether only objects that are effectively visible are requested
cacheOnly	boolean	A value indicating whether only cached objects are to be considered (true) or not (false)

Returns:

Type	Description
Array.<!H.map.Marker>	A list of intersecting objects

requestOverlays (geoRect, zoomLevel, visiblesOnly, cacheOnly)Array.<!H.map.Overlay> abstract

This method retrieves all overlay objects which intersect with the specified area.

Name	Type	Description
geoRect	H.geo.Rect	A rectangular area defined in terms of the geographic coordinates of its top-left and bottom-right corners
zoomLevel	number | undefined	The zoom level for which the objects are requested, or undefined to retrieve all objects for any zoom level
visiblesOnly	boolean	Indicates whether only objects that are effectively visible are requested
cacheOnly	boolean	A value indicating whether only cached objects are to be considered (true) or not (false)

Returns:

Type	Description
Array.<!H.map.Overlay>	A list of intersecting objects

requestSpatials (geoRect, zoomLevel, visiblesOnly, cacheOnly)Array.<!H.map.Spatial> abstract

This method retrieves all polyline, polygon, circle and rectangle objects which intersect with the provided area.

Name	Type	Description
geoRect	H.geo.Rect	A rectangular area defined in terms of the geographic coordinates of its top-left and bottom-right corners
zoomLevel	number | undefined	The zoom level for which the objects are requested, or undefined to retrieve all objects for any zoom level
visiblesOnly	boolean	Indicates whether only objects that are effectively visible are requested
cacheOnly	boolean	A value indicating whether only cached objects are to be considered (true) or not (false)

Returns:

Type	Description
Array.<!H.map.Spatial>	A list of intersecting objects

setStyleInternal (style, opt_suppressChangeEvent) inherited

This method sets the style to be used to render the provider data.

Name	Type	Description
style	H.map.render.Style.<!Object>	The style to use for rendering the provider data.
opt_suppressChangeEvent	boolean	optional Flag to suppress firing of config change event.

Events

update inherited

Event fired when this provider's data updates.

Type:

• H.util.DataEvent