s2maps-gpu - v0.18.0
    Preparing search index...

    Interface DataRangeEase<T>

    Data Range Ease

    Data Range is used to group features based on a range of values and apply specific design attributes for those groups. If the feature's value falls within the range, the fallback is used.

    ex.

    "weight": {
    "dataRange": {
    "key": "mag",
    "ease": "expo",
    "base": 1.5,
    "ranges": [
    { "stop": 0, "input": 0 },
    { "stop": 8, "input": 1 }
    ]
    }
    }
    • key: [See NestedKey] Access value in feature properties by either its key or a nested key.
    • ease: [See EaseType] The ease effect. Choose between lin | expo | quad | cubic | step [default: lin]
    • base: Used by expo, quad, or cubic ease functions. Ranges from 0 -> 2 where 1 is linear, 0 is slow start, 2 is slow finish. [default: 1]
    • ranges: [See Range] Set the range stops and the input values to apply at those stops.
    interface DataRangeEase<T extends number | string> {
        base?: number;
        ease?: EaseType;
        key: string | NestedKey;
        ranges: Range<T>[];
    }

    Type Parameters

    • T extends number | string
    Index

    Properties

    Properties

    base?: number

    Used by expo, quad, or cubic ease functions

    Ranges from 0 -> 2 [default: 1]

    • 1 is the default and a linear ease
    • 0 is the slowest ease early on
    • 2 is the fastest ease
    ease?: EaseType

    lin | expo | quad | cubic | step [default: lin]

    key: string | NestedKey

    Access value in feature properties by either its key or a nested key.

    If the key is class for example, this would be used to filter feature's values where feature.properties.class === 'ocean'

    nested conditions are used to dive into nested properties ex.

    { "filter": { "key": { "nestedKey": ["class", "type"] }, "comparator": "==", "value": "ocean" } }
    

    this would be used to filter features where feature.properties.class.type === 'ocean'

    ranges: Range<T>[]

    Set the range stops and the input values to apply at those stops.

    ex.

    "ranges": [
    { "stop": 0, "input": 0 },
    { "stop": 5, "input": 0.5 },
    { "stop": 8, "input": 1 }
    ]