Powered by Zoomin Software. For more details please contactZoomin

HERE Maps API for JavaScript - API Reference

Filters

Clear All Filters
Product category
Technology
Doc type
Version
Product lifecycle
Clear All Filters
This publication

HERE Maps API for JavaScript - API Reference: Class: ImageTileProvider

Share
Share to emailCopy article URL
Feedback
Print
Table of Contents
HomeHERE Maps API for JavaScript - API Reference...IndexClass: ImageTileProviderCurrent page
Table of Contents

Class: ImageTileProvider

Share
Share to emailCopy article URL
Feedback
Print

H.map.provider.ImageTileProvider

new H.map.provider.ImageTileProvider (options)

An ImageTileProvider uses a network service to provide bitmap images as tiles.

Name Type Description
options H.map.provider.ImageTileProvider.Options

An object containing configuration for the tile provider

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.

providesRasters inherited overrides

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.

tileSize number overrides

This property holds a value indicating the size of a tile image supported by the provider.

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.

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

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
tileKey string

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 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.

getCache ()H.util.ICache inherited

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

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

getOpacity ()number

To obtain the opacity which is used for the rendering of the provider's image tiles.

Returns:
Type Description
number the opacity in range [0..1] where 0.0 means full transparent and 1.0 means full opaque.

getStyle ()H.map.render.Style.<!Object>

To obtain the style used for the rendering of the provider's data.

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

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>

getTileKey (x, y, z)string inherited

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 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

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)

reload (hard) inherited

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
hard boolean

A Boolean flag indicating whether to invalidate in hard mode (true) or in soft mode (false);

removeEventListener (type, handler, opt_capture, opt_scope) inherited

This method removes a previously added listener from the EventTarget instance.

requestInternal (x, y, z, onResponse, onError, opt_priority)H.util.ICancelable inherited overrides

To request a tile from a remote service. This method must be implemented by deriving classes.

Returns:
Type Description
H.util.ICancelable An object implementing 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

setOpacity (opt_opacity)

To set the opacity which is used for the rendering of the provider's image tiles.

Name Type Description
opt_opacity number optional

The opacity to set in range [0..1] where 0.0 means full transparent and 1.0 means full opaque. The default value is 1.0.

setStyle (style)

Sets the style to be used for the rendering of the provider's data. This method works only when engineType is H.Map.EngineType.HARP.

Name Type Description
style H.map.render.Style.<!Object>
Example
const style = new H.map.render.harp.Style({
  'styles': [
    {
      'technique': 'raster',
      'attr': {
        'gamma': 1.2,
        'brightness': 0.5
      }
    }
  ]
});
myProvider.setStyle(style);

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

H.map.provider.ImageTileProvider.Options Object

This object encapsulates configuration options for an ImageTileProvider instance.

Properties:

Events

update inherited

Event fired when this provider's data updates.

Type:
Was this article helpful?
YesNo
TitleResults for “How to create a CRG?”Also Available inAlert