On this page

Type Alias CanvasSourceSpecification

Options to add a canvas source type to the map.

type CanvasSourceSpecification = {
    animate?: boolean;
    canvas?: string | HTMLCanvasElement;
    coordinates: [
        [number, number],
        [number, number],
        [number, number],
        [number, number],
    ];
    type: "canvas";
}
Index

Properties

animate?: boolean

Whether the canvas source is animated. If the canvas is static (i.e. pixels do not need to be re-read on every frame), animate should be set to false to improve performance.

true
canvas?: string | HTMLCanvasElement

Canvas source from which to read pixels. Can be a string representing the ID of the canvas element, or the HTMLCanvasElement itself.

coordinates: [
    [number, number],
    [number, number],
    [number, number],
    [number, number],
]

Four geographical coordinates denoting where to place the corners of the canvas, specified in [longitude, latitude] pairs.

type: "canvas"

Source type. Must be "canvas".

Was this helpful?
SDK JS
Reference
CanvasSourceSpecification