On this page
Constructors
Properties
Methods

Class RasterTileSource

A source containing raster tiles (See the raster source documentation for detailed documentation of options.)

map.addSource('raster-source', {
    'type': 'raster',
    'tiles': ['https://tiles.stadiamaps.com/tiles/stamen_watercolor/{z}/{x}/{y}.jpg'],
    'tileSize': 256, // Set this to match tile server output to avoid blurry rendering
});

map.addSource('wms-test-source', {
     'type': 'raster',
// use the tiles option to specify a WMS tile source URL
     'tiles': [
         'https://img.nj.gov/imagerywms/Natural2015?bbox={bbox-epsg-3857}&format=image/png&service=WMS&version=1.1.1&request=GetMap&srs=EPSG:3857&transparent=true&width=256&height=256&layers=Natural2015'
     ],
     'tileSize': 256 // Important for WMS if tiles are 256px
});

Hierarchy (View Summary)

Implements

Index

Constructors

constructor

Properties

bounds dispatcher id map maxzoom minzoom roundZoom scheme tileBounds tiles tileSize type url

Methods

abortTile fire hasTile hasTransition listens load loaded loadTile off on onAdd once onRemove serialize setEventedParent setSourceProperty setTiles setUrl unloadTile

Constructors

Properties

bounds: [number, number, number, number]
dispatcher: Dispatcher
id: string

The id for the source. Must not be used by any existing source.

map: MapLibreMap
maxzoom: number

The maximum zoom level for the source.

minzoom: number

The minimum zoom level for the source.

roundZoom: boolean

true if zoom levels are rounded to the nearest integer in the source data, false if they are floor-ed to the nearest integer.

scheme: string
tileBounds: TileBounds
tiles: string[]
tileSize: number

The tile size for the source.

type: "raster" | "raster-dem"
url: string

Methods

  • Allows to abort a tile loading.

    Parameters

    • tile: Tile

      The tile to abort

    Returns Promise<void>

  • An ability to fire an event to all the listeners, see Evented

    Parameters

    • event: string | Event

      The event to fire

    • Optionalproperties: any

    Returns this

  • True if the source has transition, false otherwise.

    Returns boolean

  • Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

    Parameters

    • type: string

      The event type

    Returns boolean

    true if there is at least one registered listener for specified event type, false otherwise

  • Parameters

    • OptionalsourceDataChanged: boolean

    Returns Promise<void>

  • True if the source is loaded, false otherwise.

    Returns boolean

  • This method does the heavy lifting of loading a tile. In most cases it will defer the work to the relevant worker source.

    Parameters

    • tile: Tile

      The tile to load

    Returns Promise<void>

  • Removes a previously registered event listener.

    Parameters

    • type: string

      The event type to remove listeners for.

    • listener: Listener

      The listener function to remove.

    Returns this

  • Adds a listener to a specified event type.

    Parameters

    • type: string

      The event type to add a listen for.

    • listener: Listener

      The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties.

    Returns Subscription

  • This method is called when the source is added to the map.

    Parameters

    Returns void

  • Adds a listener that will be called only once to a specified event type.

    The listener will be called first time the event fires after the listener is registered.

    Parameters

    • type: string

      The event type to listen for.

    • Optionallistener: Listener

      The function to be called when the event is fired the first time.

    Returns RasterTileSource | Promise<any>

    this or a promise if a listener is not provided

  • This method is called when the source is removed from the map.

    Returns void

  • Bubble all events fired by this instance of Evented to this parent instance of Evented.

    Parameters

    • Optionalparent: Evented | null
    • Optionaldata: any

    Returns this

  • Parameters

    • callback: Function

    Returns void

  • Sets the source tiles property and re-renders the map.

    Parameters

    • tiles: string[]

      An array of one or more tile source URLs, as in the raster tiles spec (See the Style Specification

    Returns this

  • Sets the source url property and re-renders the map.

    Parameters

    • url: string

      A URL to a TileJSON resource. Supported protocols are http: and https:.

    Returns this

  • Allows to unload a tile.

    Parameters

    • tile: Tile

      The tile to unload

    Returns Promise<void>

Was this helpful?
SDK JS
Reference
RasterTileSource