Class CanvasSource

A data source containing the contents of an HTML canvas. See CanvasSourceSpecification for detailed documentation of options.

Example

// add to map
map.addSource('some id', {
   type: 'canvas',
   canvas: 'idOfMyHTMLCanvas',
   animate: true,
   coordinates: [
       [-76.54, 39.18],
       [-76.52, 39.18],
       [-76.52, 39.17],
       [-76.54, 39.17]
   ]
});

// update
let mySource = map.getSource('some id');
mySource.setCoordinates([
    [-76.54335737228394, 39.18579907229748],
    [-76.52803659439087, 39.1838364847587],
    [-76.5295386314392, 39.17683392507606],
    [-76.54520273208618, 39.17876344106642]
]);

map.removeSource('some id');  // remove

Hierarchy (view full)

Properties

pause play

Methods

getCanvas listens off on once setCoordinates setEventedParent updateImage

Properties

pause

pause: (() => void)

Disables animation. The map will display a static copy of the canvas image.

Type declaration

    • (): void

    • Returns void

play

play: (() => void)

Enables animation. The image will be copied from the canvas to the map on each frame.

Type declaration

    • (): void

    • Returns void

Methods

getCanvas

  • getCanvas(): HTMLCanvasElement

  • Returns the HTML canvas element.

    Returns HTMLCanvasElement

    The HTML canvas element.

listens

  • listens(type): 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

off

  • off(type, listener): CanvasSource

  • Removes a previously registered event listener.

    Parameters

    • type: string

      The event type to remove listeners for.

    • listener: Listener

      The listener function to remove.

    Returns CanvasSource

on

  • on(type, listener): 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 this

once

  • once(type, listener?): Promise<any> | CanvasSource

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

    • Optional listener: Listener

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

    Returns Promise<any> | CanvasSource

    this or a promise if a listener is not provided

setCoordinates

  • setCoordinates(coordinates): this

  • Sets the image's coordinates and re-renders the map.

    Parameters

    • coordinates: Coordinates

      Four geographical coordinates, represented as arrays of longitude and latitude numbers, which define the corners of the image. The coordinates start at the top left corner of the image and proceed in clockwise order. They do not have to represent a rectangle.

    Returns this

setEventedParent

updateImage

  • updateImage(options): this

  • Updates the image URL and, optionally, the coordinates. To avoid having the image flash after changing, set the raster-fade-duration paint property on the raster layer to 0.

    Parameters

    Returns this

Settings

Member Visibility

Theme

On This Page

pauseplaygetCanvaslistensoffononcesetCoordinatessetEventedParentupdateImage