Class: TileProvider
- Last UpdatedMay 21, 2025
- 6 minute read
TileProvider is an abstract class to provide tile data.
| Name | Type | Description |
|---|---|---|
options |
H.map.provider.TileProvider.Options |
The options to
instantiate the given |
Extends
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.
-
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. -
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
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
-
This method cancels a tile request, using the caller-supplied tile coordinates.
-
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 abstract
-
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. -
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.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
-
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 -
providesDomMarkers ()boolean inherited
-
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) -
providesGeoJSON ()boolean inherited
-
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) -
providesMarkers ()boolean inherited
-
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) -
providesOMV ()boolean inherited
-
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) -
providesOverlays ()boolean inherited
-
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 -
providesRasters ()boolean inherited
-
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) -
providesSpatials ()boolean inherited
-
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) -
removeEventListener (type, handler, opt_capture, opt_scope) inherited
-
This method removes a previously added listener from the
EventTargetinstance. -
requestTile (x, y, z, cacheOnly)H.map.provider.Tile | undefined abstract
-
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 -
setStyleInternal (style, opt_suppressChangeEvent) inherited
-
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.
Type Definitions
-
This object contains configuration options for a
TileProviderinstance.Properties:
Events
-
update inherited
-
Event fired when this provider's data updates.
Type:
