FIMViz.jsAPI
    Preparing search index...

    Class Stats

    Index
    constructor
    describe diff download percentile toCSV toJSON raster vector

    • Not usually called directly — use the Stats.raster()/Stats.vector() factories.

      Parameters

      • Optionalfields: any = {}

      Returns Stats

    • Deltas between two Stats of the same kind (this − other) over shared numeric fields.

      Parameters

      Returns {}

    • Parameters

      • Optionalname: string = "stats.csv"

      Returns void

    • Approximate percentile p (0–100) from the histogram. Raster only.

      Parameters

      • p: number

      Returns number

    • Raster statistics over pixelData, optionally scoped by a Filter and classified by a ColorScale.

      Parameters

      • pixelData: ArrayLike<number>
      • meta: {
            be: number;
            bn: number;
            bs: number;
            bw: number;
            height: number;
            noData?: number;
            unit?: string;
            width: number;
        }
      • Optionalopts: {
            bins?: number;
            classify?: ColorScale;
            filter?: Function | any[] | Filter;
            skipZero?: boolean;
        } = {}

      Returns Stats

    • Vector statistics over any feature source.

      Accepts GeoJSON (a FeatureCollection, a single Feature, a Feature[], or the engine's VectorFeatures) — what a headless caller and VectorLayer.getStats() have — or a google.maps.Data-shaped layer.

      Parameters

      • source: any

        GeoJSON FeatureCollection|Feature|Feature[]|VectorFeatures, or a google.maps.Data layer

      • Optionalopts: {
            classify?: ColorScale;
            classifyBy?: string;
            filter?: Function | any[] | Filter;
        } = {}
        • Optionalclassify?: ColorScale

          bucket features into byClass by the SAME scale that colours them. Needs classifyBy to know which property carries the value; VectorLayer.getStats() passes both from the layer, so the buckets line up with the legend exactly as they do for a raster.

        • OptionalclassifyBy?: string

          the feature property classify reads

        • Optionalfilter?: Function | any[] | Filter

      Returns Stats

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods