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

    Interface TileOptions

    Tile-level tiling option defaults.

    Applied to all sources that do not specify their own override for a given field. Typically set at the TileClient or TileServer constructor level.

    interface TileOptions {
        buffer?: number;
        extent?: number;
        maxFeatures?: number;
        maxReadBytes?: number;
        maxTileBytes?: number;
        maxZoom?: number;
        minZoom?: number;
        omitEmptyLayers?: boolean;
        pointGrid?: number;
        reduceToFit?: boolean;
        simplifyBeforeClip?: boolean;
        tolerance?: number;
    }
    Index
    buffer?: number

    Default buffer around tile in tile-coordinate pixels.

    64
    
    extent?: number

    Default tile coordinate extent.

    4096
    
    maxFeatures?: number

    Default per-source feature limit per tile.

    Infinity
    
    maxReadBytes?: number

    Default per-source limit on feature bytes read per tile.

    268435456 (256 MiB)
    
    maxTileBytes?: number

    Largest encoded tile, in bytes; larger tiles raise LimitExceededError (e.g. to stay below a response size limit). Applies to the whole tile, not per source.

    Infinity
    
    maxZoom?: number

    Default maximum zoom level.

    24
    
    minZoom?: number

    Default minimum zoom level.

    0
    
    omitEmptyLayers?: boolean

    Leave layers without features out of the tile. A tile without any features then encodes to zero bytes, which a server can answer with 204 No Content. Applies to the whole tile.

    false
    
    pointGrid?: number

    Default point thinning cell size in tile units (0: off).

    0
    
    reduceToFit?: boolean

    When a tile exceeds maxTileBytes, encode it again with coarser detail before giving up: up to four times, each time doubling the simplification tolerance and the point grid (starting from extent / 512 for sources without one). LimitExceededError is raised only if the coarsest attempt is still too large. The tile's TileStats.reduced reports the steps taken.

    Costs memory: the decoded features of every source are kept until the tile is encoded.

    false
    
    simplifyBeforeClip?: boolean

    Default for simplifying whole features before clipping.

    false
    
    tolerance?: number

    Default simplification tolerance.

    3