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

    Interface InputValue<T>

    Input Value

    Input values directly access properties data from the feature.

    ex.

    Lets say you have a feature with the following properties:

    const properties = {
    class: {
    type: 'blue',
    subclass: 'deep'
    }
    }

    You can utilize/access the type property with the following:

    {
    "color": {
    "inputValue": {
    "key": {
    "nestedKey": ["class", "type"],
    },
    "fallback": "blue"
    }
    }
    }
    • key: [See NestedKey] Access value in feature properties by either its key or a nested key.
    • fallback: If the property search for a key turns up no value, the fallback is used.
    interface InputValue<T extends NotNullOrObject> {
        fallback: T;
        key: string | NestedKey;
    }

    Type Parameters

    Index

    Properties

    Properties

    fallback: T

    If the property search for a key turns up no value, the fallback is used.

    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'