Class: ImageProvider

.xyz.maps.providers. ImageProvider

new ImageProvider(config)

Image provider
Parameters:
Name Type Description
config here.xyz.maps.providers.RemoteTileProvider.Options configuration of the provider

Extends

Members Summary

id :String

Provider id.

level :Integer

provider request tiles at this zoomlevel.

margin :Integer

default tile margin.

name :String

Provider name.

url :String

url for requesting tiles.

Methods Summary

addEventListener()

Add event listener to provider, valid events: "featureAdd", "featureRemove", "featureCoordinatesChange", "clear" and "error"

cancel(quadkey)

Cancel request of a tile.

clear(tile)

Clear tiles in bounding box, clear all if parameter is not given

config(cfg) → {here.xyz.maps.providers.TileProvider}

set config for provider.

createTile(quadkey) → {here.xyz.maps.providers.TileProvider.Tile}

create tile.

getCachedTile(quadkey) → {here.xyz.maps.providers.TileProvider.Tile}

get cached tile by quadkey.

getCachedTilesOfBBox(bbox, level) → {Array.<here.xyz.maps.providers.TileProvider.Tile>}

get cached tile by bounding box.

getTile(quadkey, cb) → {here.xyz.maps.providers.TileProvider.Tile}

Get a tile by quad key.

removeEventListener()

Remove event listener from provider, valid events: "featureadd", "featureRemove", "featureCoordinatesChange", "clear" and "error"

setMargin(margin)

set tile margin.

Members Details

id :String

Provider id.
Type:
String
Inherited From:

level :Integer

provider request tiles at this zoomlevel.
Type:
Integer
Inherited From:

margin :Integer

default tile margin.
Type:
Integer
Inherited From:

name :String

Provider name.
Type:
String
Inherited From:

url :String

url for requesting tiles.
Type:
String
Inherited From:

Methods Details

addEventListener()

Add event listener to provider, valid events: "featureAdd", "featureRemove", "featureCoordinatesChange", "clear" and "error"
Inherited From:

cancel(quadkey)

Cancel request of a tile.
Parameters:
Name Type Description
quadkey here.xyz.maps.providers.TileProvider.Tile | string quad key of a tile or a tile instance

clear(tile)

Clear tiles in bounding box, clear all if parameter is not given
Parameters:
Name Type Argument Description
tile Array.<Number> <optional>
bbox array of coordinates in order: [minLon, minLat, maxLon, maxLat]

config(cfg) → {here.xyz.maps.providers.TileProvider}

set config for provider.
Parameters:
Name Type Description
cfg here.xyz.maps.providers.TileProvider.Options
Inherited From:
Returns:
Type:
here.xyz.maps.providers.TileProvider

createTile(quadkey) → {here.xyz.maps.providers.TileProvider.Tile}

create tile.
Parameters:
Name Type Description
quadkey String
Inherited From:
Returns:
created tile
Type:
here.xyz.maps.providers.TileProvider.Tile

getCachedTile(quadkey) → {here.xyz.maps.providers.TileProvider.Tile}

get cached tile by quadkey.
Parameters:
Name Type Description
quadkey String
Inherited From:
Returns:
Type:
here.xyz.maps.providers.TileProvider.Tile

getCachedTilesOfBBox(bbox, level) → {Array.<here.xyz.maps.providers.TileProvider.Tile>}

get cached tile by bounding box.
Parameters:
Name Type Argument Description
bbox Array.<Number> array of coordinates in order: [minLon, minLat, maxLon, maxLat]
level Integer <optional>
get tiles at specified level
Inherited From:
Returns:
array of tiles
Type:
Array.<here.xyz.maps.providers.TileProvider.Tile>

getTile(quadkey, cb) → {here.xyz.maps.providers.TileProvider.Tile}

Get a tile by quad key.
Parameters:
Name Type Description
quadkey number
cb function
Returns:
Type:
here.xyz.maps.providers.TileProvider.Tile

removeEventListener()

Remove event listener from provider, valid events: "featureadd", "featureRemove", "featureCoordinatesChange", "clear" and "error"
Inherited From:

setMargin(margin)

set tile margin.
Parameters:
Name Type Description
margin Integer in pixel
Inherited From: