On this page
Constructors
Properties
Methods

Class VectorTileSourceMaptiler

A source containing vector tiles in Maplibre Vector Tile format or Mapbox Vector Tile format. (See the Style Specification for detailed documentation of options.)

map.addSource('some id', {
    type: 'vector',
    url: 'https://demotiles.maplibre.org/tiles/tiles.json'
});

map.addSource('some id', {
    type: 'vector',
    tiles: ['https://d25uarhxywzl1j.cloudfront.net/v0.1/{z}/{x}/{y}.mvt'],
    minzoom: 6,
    maxzoom: 14
});

map.getSource('some id').setUrl("https://demotiles.maplibre.org/tiles/tiles.json");

map.getSource('some id').setTiles(['https://d25uarhxywzl1j.cloudfront.net/v0.1/{z}/{x}/{y}.mvt']);

Add a vector tile source

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

bounds dispatcher encoding id isTileClipped map maxzoom minzoom promoteId reparseOverscaled 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
encoding: string
id: string

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

isTileClipped: boolean

false if tiles can be drawn outside their boundaries, true if they cannot.

map: MapLibreMap
maxzoom: number

The maximum zoom level for the source.

minzoom: number

The minimum zoom level for the source.

promoteId: PromoteIdSpecification
reparseOverscaled: boolean

true if tiles should be sent back to the worker for each overzoomed zoom level, false if not.

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

The tile size for the source.

type: "vector"
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

  • 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

  • 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

  • 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 Promise<any> | VectorTileSource

    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

  • 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 TileJSON spec.

    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

Was this helpful?
SDK JS
Reference
VectorTileSource