gis-tools-ts - v0.6.0
    Preparing search index...

    Interface BaseGridOptions<M>

    Options for grid clustering

    interface BaseGridOptions<M extends MValue = Properties | RGBA> {
        bufferSize: number;
        getInterpolationValue?: GetInterpolateValue<M> | "rgba";
        gridSize?: number;
        interpolation?: InterpolationMethod;
        layerName?: string;
        maxzoom?: number;
        maxzoomInterpolation?: InterpolationMethod;
        minzoom?: number;
        nullValue?: number | RGBA;
        projection?: Projection;
        store?: VectorStoreConstructor<PointShape<M>>;
    }

    Type Parameters

    • M extends MValue = Properties | RGBA

    Hierarchy (View Summary)

    Index

    Properties

    bufferSize getInterpolationValue? gridSize? interpolation? layerName? maxzoom? maxzoomInterpolation? minzoom? nullValue? projection? store?

    Properties

    bufferSize: number

    Used by the cell search to specify the tile buffer size in pixels. [default: 0]

    getInterpolationValue?: GetInterpolateValue<M> | "rgba"

    Used by cell search to specify the interpolation function to use [default: 'z' value of the point]

    gridSize?: number

    Grid size, assumed pixel ratio.

    interpolation?: InterpolationMethod

    Used by cell search to specify the type of interpolation to use. From experimentation, lanczos is a fast algorithm that maintains the quality of the data [default: 'lanczos']

    layerName?: string

    Name of the layer to build when requesting a tile

    maxzoom?: number

    max zoom level to cluster the points on

    maxzoomInterpolation?: InterpolationMethod

    Used by cell search to specify the type of interpolation to use. The recommendation is IDW as you want to prioritize closest data points. [default: 'idw']

    minzoom?: number

    min zoom to generate clusters on

    nullValue?: number | RGBA

    Set a null value for grid cells that are empty

    projection?: Projection

    projection to use

    store?: VectorStoreConstructor<PointShape<M>>

    type of point index store to use. Defaults to an in memory store

    Settings

    Member Visibility

    On This Page

    Properties