fgb-vt - v1.0.4
    Preparing search index...

    Function tile

    • Generate a vector tile from multiple FlatGeobuf sources.

      Each source produces one MVT layer in the output PBF. Layer ordering matches the order of the sources array.

      Parameters

      • connector: Connector

        Byte-range reader for accessing FGB files.

      • z: number

        Tile zoom level.

      • x: number

        Tile column.

      • y: number

        Tile row.

      • sources: Source[]

        Array of source descriptors; each becomes one MVT layer.

      • Optionaloptions: TileOptions

        Tile-level tiling option defaults (overridden by per-source options).

      Returns Promise<Uint8Array<ArrayBufferLike>>

      PBF-encoded Mapbox Vector Tile containing one layer per source.

      const pbf = await tile(connector, 12, 2048, 1365, [
        { name: 'water', path: '/data/water.fgb' },
        { name: 'roads', path: '/data/roads.fgb', options: { tolerance: 1 } },
      ]);

    • Generate a vector tile from a single FlatGeobuf source.

      Convenience overload that wraps the source in a single-element array and delegates to the multi-source implementation.

      Parameters

      • connector: Connector

        Byte-range reader for accessing FGB files.

      • z: number

        Tile zoom level.

      • x: number

        Tile column.

      • y: number

        Tile row.

      • source: Source

        Single source descriptor; produces one MVT layer.

      • Optionaloptions: TileOptions

        Tile-level tiling option defaults (overridden by per-source options).

      Returns Promise<Uint8Array<ArrayBufferLike>>

      PBF-encoded Mapbox Vector Tile containing one layer.

      const pbf = await tile(connector, 14, 8192, 5461, {
        name: 'buildings',
        path: 'https://cdn.example.com/buildings.fgb',
      });

    Settings

    Member Visibility