Class: Provider
- Last UpdatedMay 21, 2025
- 7 minute read
This class provides interface between loaded venues and rendering. You can add or remove venues from the venues layer.
| Name | Type | Description |
|---|---|---|
options |
H.map.provider.TileProvider.Options |
The options to
instantiate a |
Example
let venuesProvider = new H.venues.Provider();
venueService.loadVenue(VENUE_ID).then((venue) => {
// add venue data to venues provider
venuesProvider.addVenue(venue);
venuesProvider.setActiveVenue(venue);
// create a tile layer for the venue provider
map.addLayer(new H.map.layer.TileLayer(venuesProvider));
// center map on venue
map.setCenter(venue.getCenter());
});Extends
Members
-
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.
-
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 the size of a tile representing edge length in pixels. Its value must be
2^nwhere n is in range[0…30], default is256. -
This property holds the unique identifier for the provider instance. The value is generated at construction time.
-
This property holds the provider's unique resource identifier. If it is not provided at construction time, it defaults to provider's
uid.
Methods
-
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
-
Add and render a venue object
Name Type Description venueH.venues.Venue The venue to render
Throws:
-
This method throws an error if venue is already registered
- Type
- Error
-
-
Add and render multiple venue objects
Name Type Description venuesArray.<H.venues.Venue> The venues to render
-
cancelTile (x, y, z) inherited
-
This method cancels a tile request, using the caller-supplied tile coordinates.
-
cancelTileByKey (tileKey) inherited
-
This method cancels a tile request, using a tile key.
Name Type Description tileKeystring The key identifying the tile
-
createTileInternal (x, y, z, data, opt_options)H.map.provider.Tile inherited
-
The internal method to create a tile. It must be overridden by sub-classes.
Returns:
Type Description H.map.provider.Tile The created tile -
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. -
getActiveVenue ()H.venues.Venue
-
Get currently active venue
Returns:
Type Description H.venues.Venue The currently active venue object -
getCache ()H.util.ICache inherited overrides
-
This method retrieves a tile cache of this provider.
Returns:
Type Description H.util.ICache An object representing a tile cache -
getCopyrights (boundingBox, level)Array.<!H.map.ICopyright> inherited overrides
-
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.OptionsgetCopyrightsproperty. The default implementation returnsnull.Name Type Description boundingBoxH.geo.Rect The rectangular area for which to retrieve the copyright information
levelnumber 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 -
getStyleInternal ()H.map.render.Style.<!Object> inherited overrides
-
This methods returns the style used to render the provider data.
Returns:
Type Description H.map.render.Style.<!Object> -
This method creates a tile key consisting of the provider's URI, and the x, y and z coordinates of the tile, separated by underscores, for example "4711_7_42_23".
Returns:
Type Description string A string containing the tile key -
getVenue (venueId)null | H.venues.Venue
-
Get venue by id
Name Type Description venueIdnumber The venue id
Returns:
Type Description null | H.venues.Venue The venue object corresponding to the id -
This method checks whether this provider will provide
DomMarkermap objects. A concrete implementation ofProvidermust override it if it will provideDomMarkers.Returns:
Type Description boolean A value indicating if the given provider provides DomMarkers ( true) or not (false) -
This method checks whether this provider will provide data in
GeoJSONformat. A concrete implementation ofProvidermust override it if it will provideGeoJSONdata.Returns:
Type Description boolean A value indicating if the given provider provides GeoJSONdata (true) or not (false) -
This method checks whether this provider will provide
Markermap objects. A concrete implementation ofProvidermust override it if it will provideMarkers.Returns:
Type Description boolean A value indicating if the given provider provides Markers ( true) or not (false) -
This method checks whether this provider will provide data in
OMVformat. A concrete implementation ofProvidermust override it if it will provideOMVdata.Returns:
Type Description boolean A value indicating if the given provider provides OMVdata (true) or not (false) -
This method checks whether this provider will provide overlay map objects. A concrete implementation of
Providermust override it if it will provide overlays.Returns:
Type Description boolean trueif the provider provides overlays, otherwisefalse -
This method checks whether this provider will provide bitmap images as tiles. A concrete implementation of
Providermust 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) -
This method checks whether this provider will provide spatial map objects. A concrete implementation of
Providermust override it if it will provideSpatials.Returns:
Type Description boolean A value indicating whether the provider provides map objects ( true) or not (false) -
This method instructs the provider to reload data from its source.
Two reload modes are possible:
hard: This mode immediately removes tiles from the tile cache and forces the provider to re-fetch them. Currently cached tiles are not used for rendering.soft: This mode only marks tiles as invalid and requests the tiles to be re-fetched as soon as possible. The provider does not invalidate the cache immediately. This means that cached tiles can still be rendered while the updated tiles are fetched.
Name Type Description hardboolean A Boolean flag indicating whether to invalidate in
hardmode (true) or insoftmode (false); -
This method removes a previously added listener from the
EventTargetinstance. -
Remove venue, clears stored data & reload provider. In case the venue was active, active venue will become null.
Name Type Description venueH.venues.Venue The venue to remove
-
requestInternal (x, y, z, onResponse, onError, opt_priority)H.util.ICancelable inherited overrides
-
This method is requested for each tile in viewport. Parse tile for quested coords and return resulting vector tile Check parent for more information
Returns:
Type Description H.util.ICancelable An object implementing {@code ICancelable} -
requestTile (x, y, z, cacheOnly)H.map.provider.Tile | undefined inherited
-
This method requests data for a tile.
Returns:
Type Description H.map.provider.Tile | undefined The tile object if it can be obtained, otherwise undefined -
Set a venue as active
Name Type Description venueH.venues.Venue The venue object to set as active
-
This method sets the style to be used to render the provider data.
Name Type Description styleH.map.render.Style.<!Object> The style to use for rendering the provider data.
opt_suppressChangeEventboolean optional Flag to suppress firing of config change event.
Events
-
Event fired when this provider's data updates.
Type:
