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

    Interface RasterStyle

    Raster Style Guide

    [See LayerStyleBase]

    • name: the name of the layer, useful for sorting a layer on insert or for removal
    • source: the name of the source whose data this layer will use
    • layer: the source's layer. Defaults to "default" for JSON data
    • minzoom: the minimum zoom level at which the layer will be visible
    • maxzoom: the maximum zoom level at which the layer will be visible
    • filter: [See Filter] a filter function to filter out features from the source layer
    • lch: use LCH coloring instead of RGB. Useful for color changing when the new color is very different from the old one
    • visible: whether the layer is visible or not
    • metadata: additional metadata. Used by style generators
    • opacity: the opacity of the raster. Choose between [0, 1], or pull out the value using a Property.
    • saturation: the saturation of the raster. Choose between [-1, 1], or pull out the value using a Property.
    • contrast: the contrast of the raster. Choose between [-1, 1], or pull out the value using a Property.
    • resampling: [See Resampling] The resampling method. Either nearest or linear
    • fadeDuration: The time it takes for each raster tile to fade in and out of view in milliseconds
    interface RasterStyle {
        contrast?: number | Property<number>;
        fadeDuration?: number;
        filter?: Filter;
        layer?: string;
        lch?: boolean;
        maxzoom?: number;
        metadata?: unknown;
        minzoom?: number;
        name?: string;
        opacity?: number | Property<number>;
        resampling?: GPUFilterMode;
        saturation?: number | Property<number>;
        source?: string;
        type: "raster";
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    contrast?: number | Property<number>

    A PAINT Property.

    0

    ex.

    { "contrast": 0.5 }
    

    ex.

    { "contrast": { "inputValue": { "key": "contrast", "fallback": 1 } } }
    
    • inputValue: [See InputValue] access value in feature properties
    • dataCondition: [See DataCondition] filter based on feature property conditions
    • dataRange: [See DataRange] filter based on feature property ranges
    • inputRange: [See InputRange] filter based on map conditions like "zoom", "lon", "lat", "angle", or "pitch"
    • featureState: [See FeatureState] filter based on feature state
    • fallback: if all else fails, use this value. A value of number itself or pull from feature properties using Property
    fadeDuration?: number

    The duration of the fade in milliseconds. Defaults to 300

    filter?: Filter

    A filter function to filter out features from the source layer.

    example:

    "filter": { "key": "class", "comparator": "==", "value": "ocean" }
    

    another example:

    "filter": {
    "or": [
    { "key": "class", "comparator": "==", "value": "ocean" },
    { "key": "class", "comparator": "==", "value": "bay" }
    ]
    }

    another example:

    "filter": {
    "and": [
    { "key": "class", "comparator": "==", "value": "ocean" },
    { "key": "size", "comparator": "==", "value": "large" },
    { "key": "type", "comparator": "!=", "value": "pacific" }
    ]
    }
    layer?: string

    The source's layer. Default for JSON data

    lch?: boolean

    Use LCH coloring instead of RGB. Useful for color changing when the new color is very different from the old one

    maxzoom?: number

    The maximum zoom level at which the layer will be visible

    metadata?: unknown

    Additional metadata. Used by style generators.

    minzoom?: number

    The minimum zoom level at which the layer will be visible

    name?: string

    The name of the layer - useful for sorting a layer on insert or for removal

    opacity?: number | Property<number>

    A PAINT Property.

    1

    ex.

    { "opacity": 0.5 }
    

    ex.

    { "opacity": { "inputValue": { "key": "opacity", "fallback": 1 } } }
    
    • inputValue: [See InputValue] access value in feature properties
    • dataCondition: [See DataCondition] filter based on feature property conditions
    • dataRange: [See DataRange] filter based on feature property ranges
    • inputRange: [See InputRange] filter based on map conditions like "zoom", "lon", "lat", "angle", or "pitch"
    • featureState: [See FeatureState] filter based on feature state
    • fallback: if all else fails, use this value. A value of opacity itself or pull from feature properties using Property
    resampling?: GPUFilterMode

    Decide how the GPU samples the texture. Either nearest or linear. Linear is smoother but nearest has better performance.

    Defaults to linear.

    saturation?: number | Property<number>

    A PAINT Property.

    0

    ex.

    { "saturation": 0.5 }
    

    ex.

    { "saturation": { "inputValue": { "key": "saturation", "fallback": 0.5 } } }
    
    • inputValue: [See InputValue] access value in feature properties
    • dataCondition: [See DataCondition] filter based on feature property conditions
    • dataRange: [See DataRange] filter based on feature property ranges
    • inputRange: [See InputRange] filter based on map conditions like "zoom", "lon", "lat", "angle", or "pitch"
    • featureState: [See FeatureState] filter based on feature state
    • fallback: if all else fails, use this value. A value of saturation itself or pull from feature properties using Property
    source?: string

    The source used to generate the layer

    type: "raster"

    Raster Style Guide

    [See LayerStyleBase]

    • name: the name of the layer, useful for sorting a layer on insert or for removal
    • source: the name of the source whose data this layer will use
    • layer: the source's layer. Defaults to "default" for JSON data
    • minzoom: the minimum zoom level at which the layer will be visible
    • maxzoom: the maximum zoom level at which the layer will be visible
    • filter: [See Filter] a filter function to filter out features from the source layer
    • lch: use LCH coloring instead of RGB. Useful for color changing when the new color is very different from the old one
    • visible: whether the layer is visible or not
    • metadata: additional metadata. Used by style generators
    • opacity: the opacity of the raster. Choose between [0, 1], or pull out the value using a Property.
    • saturation: the saturation of the raster. Choose between [-1, 1], or pull out the value using a Property.
    • contrast: the contrast of the raster. Choose between [-1, 1], or pull out the value using a Property.
    • resampling: [See Resampling] The resampling method. Either nearest or linear
    • fadeDuration: The time it takes for each raster tile to fade in and out of view in milliseconds
    visible?: boolean

    Whether the layer is visible or not