H.map.provider.Provider
Class Summary
Extends: H.util.EventTarget
A Provider defines an object which works as a database for the map. Providers can exists in different forms in that they can implement client-side object storage or they can request data from a remote service.
[ For full details, see the Class Details ]
Property Summary
Properties |
---|
This property holds the provider's unique resource identifier. If it is not provided at construction time, it defaults to provider's |
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. |
This property holds a value indicating the maximum zoom level at which the given provider can server data. The value is set at construction time. |
This property holds the unique identifier for the provider instance. The value is generated at construction time. |
Method Summary
Methods |
---|
This method retrieves the copyrights for the provided content for a certain geographical area and zoom level. |
This method checks whether this provider currently provides spatial map objects. A concrete implementation of |
This method checks whether this provider currently provides overlay map objects. A concrete implementation of |
This method checks whether this provider currently provides |
This method checks whether this provider currentky provides |
This method adds a listener for a specific event. |
This method removes a previously added listener from the |
This method dispatches an event on the |
This method removes listeners from the given object. Classes that extend |
This method adds a callback which is triggered when the |
Events Summary
Events |
---|
Event fired when this provider's data updates. |
Class Description
A Provider defines an object which works as a database for the map. Providers can exists in different forms in that they can implement client-side object storage or they can request data from a remote service.
Constructor Details
H.map.provider.Provider(opt_options)
- Parameters:
-
opt_options
: -
{H.map.provider.Provider.Options=} [optional]
- An object containing configuration options
Property Details
uri: {string}
This property holds the provider's unique resource identifier. If it is not provided at construction time, it defaults to provider's uid
.
min: {number}
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.
max: {number}
This property holds a value indicating the maximum zoom level at which the given provider can server data. The value is set at construction time.
uid: {string}
This property holds the unique identifier for the provider instance. The value is generated at construction time.
Method Details
getCopyrights (bounds, level) : {?Array<H.map.ICopyright>}
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
.
- Parameters:
-
bounds
: -
{H.geo.Rect}
- The bounding area for which to retrieve the copyright information
-
level
: -
{number}
- The zoom level for which to retrieve the copyright information
- Returns:
-
{?Array<H.map.ICopyright>}
- A list of copyright information objects for the provided area and zoom level
providesSpatials () : {boolean}
This method checks whether this provider currently provides spatial map objects. A concrete implementation of Provider
must override it if it currently provides Spatial
s.
- Returns:
-
{boolean}
- A value indicating whether the provider provides map objects (
true
) or not (false
)
providesOverlays () : {boolean}
This method checks whether this provider currently provides overlay map objects. A concrete implementation of Provider
must override it if it currently provides overlays.
- Returns:
-
{boolean}
-
true
if the provider provides overlays, otherwsefalse
providesMarkers () : {boolean}
This method checks whether this provider currently provides Marker
map objects. A concrete implementation of Provider
must override it if it currently provides Marker
s.
- Returns:
-
{boolean}
- A value indicating if the given provider provides Markers (
true
) or not (false
)
providesDomMarkers () : {boolean}
This method checks whether this provider currentky provides DomMarker
map objects. A concrete implementation of Provider
must override it if it currently provides Marker
s.
- Returns:
-
{boolean}
- A value indicating if the given provider provides Markers (
true
) or not (false
)
addEventListener (type, handler, opt_capture, opt_scope)
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.
- Parameters:
-
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
removeEventListener (type, handler, opt_capture, opt_scope)
This method removes a previously added listener from the EventTarget
instance.
- Parameters:
-
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 oject defining the scope for the handler function
dispatchEvent (evt)
This method dispatches an event on the EventTarget
object.
- Parameters:
-
evt
: -
{(H.util.Event | string)}
- An object representing the event or a string with the event name
dispose ()
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.
addOnDisposeCallback (callback, opt_scope)
This method adds a callback which is triggered when the EventTarget
object is being disposed.
- Parameters:
-
callback
: -
{!Function}
- The callback function.
-
opt_scope
: -
{Object=} [optional]
- An optional scope for the callback function
Event Details
update: {H.util.Event}
Event fired when this provider's data updates.