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

    Interface Source

    A FlatGeobuf source descriptor.

    Binds a layer name and file path to optional tiling parameters. The path format is interpreted by the Connector:

    Connector Path format
    LocalConnector Filesystem path (./data/buildings.fgb)
    HttpConnector Full URL (https://cdn.example.com/roads.fgb)
    S3Connector S3 URI (s3://bucket/key.fgb)
    interface Source {
        crs?: SourceCrs;
        filter?: FeatureFilter;
        idColumn?: string | false;
        keepIdProperty?: boolean;
        name: string;
        options?: SourceOptions;
        path: string;
        properties?: PropertySelection;
        revision?: string;
        useIndex?: boolean;
    }
    Index
    crs?: SourceCrs

    Coordinate reference system of the file's coordinates. By default ('auto') it is taken from the file header: WGS 84 longitude/latitude and Web Mercator are built in, and any other CRS raises UnsupportedFormatError unless a Projection is given here.

    'auto'
    
    filter?: FeatureFilter

    Write only the features for which this returns true, e.g. only major roads below zoom 10: (f, z) => z >= 10 || f.properties.class === 'major'.

    The filter sees every property of a feature, also those left out by Source.properties. It shrinks tiles, not reads: the features are read and decoded first, and budgets such as maxFeatures count them before filtering. To read less at low zooms, use an overview file (a source with the same name and a lower maxZoom).

    Tile ETags identify a filter by its source text: when its result depends on anything else (e.g. configuration it reads), change Source.revision with it.

    idColumn?: string | false

    Column providing the MVT feature id, or false for no ids. By default the first integer column named id, fid, gid or ogc_fid (case insensitive) is used. A named column must be an integer column; features whose value is negative or missing get no id.

    keepIdProperty?: boolean

    Also write the id column as a property (subject to properties).

    false
    
    name: string

    Layer name in the output MVT. Sources sharing a name are merged into one layer, e.g. an overview file for low zooms and a detailed file for high zooms, or one dataset split into several files.

    options?: SourceOptions

    Per-source tiling option overrides.

    path: string

    Path to the FGB file, interpreted by the Connector.

    properties?: PropertySelection

    Properties to write: the column names to keep ([] writes none), or { exclude: [...] } to drop some. Binary columns are always dropped (MVT has no binary values).

    all properties
    
    revision?: string

    Revision of this source's settings, part of its tile ETags. Change it when the tiles change in a way the ETag cannot see: a filter or crs projection that behaves differently with the same source text, e.g. because it reads configuration. A build or deployment id works.

    useIndex?: boolean

    false ignores the file's spatial index and scans its features (bounded by maxScanBytes), e.g. for a file whose index does not match its data (IndexMismatchError).

    true