Class MapProvider

A map provider is a object that handles the access to map tiles of a specific service.

They contain the access configuration and are responsible for handling the map theme size etc.

MapProvider should be used as a base for all the providers.

Constructors

constructor

Properties

bounds? layers mapView maxZoom minZoom name options?

Methods

fetchTile

Constructors

constructor

  • new MapProvider(layers, options?): MapProvider

  • Parameters

    • layers: MapProviderLayer | MapProviderLayer[]
    • Optional options: MapProviderParameters

    Returns MapProvider

Properties

Optional bounds

bounds?: Box2

Map bounds.

layers

layers: MapProviderLayer[] = []

mapView

mapView: MapView

Name of the map provider

maxZoom

maxZoom: number = 22

Maximum tile level.

minZoom

minZoom: number = 0

Minimum tile level.

name

name: string = ''

Name of the map provider

Optional options

options?: MapProviderParameters

Methods

fetchTile

  • fetchTile(zoom, x, y): {
        layers: MapProviderLayer[];
        promise: Promise<any>;
    }

  • Get a tile for the x, y, zoom based on the provider configuration.

    The tile should be returned as a image object, compatible with canvas context 2D drawImage() and with webgl texImage2D() method.

    Parameters

    • zoom: number

      Zoom level.

    • x: number

      Tile x.

    • y: number

      Tile y.

    Returns {
        layers: MapProviderLayer[];
        promise: Promise<any>;
    }

    Promise with the image obtained for the tile ready to use.

    • layers: MapProviderLayer[]
    • promise: Promise<any>

Settings

Member Visibility

Theme

On This Page