maplibre-gl-svg-sprite - v0.1.0
    Preparing search index...

    Class SpriteBuilder

    Builder class for creating and managing sprite sheets from SVG icons

    const builder = new SpriteBuilder({ pixelRatio: 2 });
    builder.addSvg('icon1', '<svg>...</svg>');
    const { sprite, json } = await builder.exportURLs();
    // Don't forget to call builder.destroy() when done
    Index

    Constructors

    constructor

    Methods

    setPixelRatio addSvg addSvgs addSvgIfAbsent exportSpriteURL exportJSONURL exportURLs exportBundle exportJSON exportCanvas exportAssets destroy expire registerMapLibreProtocol

    Constructors

    • Create a new SpriteBuilder

      Parameters

      • options: { pixelRatio?: number } = {}

        Configuration options

        • OptionalpixelRatio?: number

          Pixel ratio for rendering (default: 1)

      Returns SpriteBuilder

    Methods

    • Set pixel ratio (must be positive number)

      Parameters

      • ratio: number

      Returns void

    • Add an SVG icon to the sprite

      Parameters

      • id: string
      • svg: string

      Returns void

    • Add multiple SVG icons at once (array or record)

      Parameters

      • icons: Record<string, string> | SvgInput[]

      Returns void

    • Add an SVG icon only if not already present

      Parameters

      • id: string
      • svg: string

      Returns boolean

    • Export sprite sheet as object URL

      Returns Promise<string>

    • Export JSON metadata as object URL

      Returns Promise<string>

    • Export both sprite and JSON URLs

      Returns Promise<{ sprite: string; json: string }>

    • Export URLs along with layout size

      Returns Promise<{ sprite: string; json: string; width: number; height: number }>

    • Export JSON metadata object

      Returns Promise<SpriteJSON>

    • Export canvas element

      Returns Promise<HTMLCanvasElement>

    • Export sprite assets (JSON + PNG bytes)

      Returns Promise<SpriteAssets>

    • Clean up resources and revoke URLs

      Returns void

    • Revoke a specific object URL

      Parameters

      • Optionalurl: null | string

      Returns void

    • Register a MapLibre custom protocol to serve sprites from memory

      Parameters

      Returns () => void

      Function to unregister protocol

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods