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^n
where 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
removeEventListener
ordispose
on the given object when you no longer need it. -
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
-
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 tileKey
string 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
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 returnsnull
.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 -
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
DomMarker
map objects. A concrete implementation ofProvider
must override it if it will provideDomMarker
s.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 ofProvider
must override it if it will provideGeoJSON
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 ofProvider
must override it if it will provideMarker
s.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 ofProvider
must override it if it will provideOMV
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, otherwisefalse
-
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 provideSpatial
s.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. -
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 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.
Type Definitions
-
This object contains configuration options for a
TileProvider
instance.Properties:
Events
-
update inherited
-
Event fired when this provider's data updates.
Type: