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

    Interface PointStyle

    Point 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
    • color: Color of the point. Input either a string pull out the value using a Property.
    • radius: radial size of the point in pixels. Input either a number pull out the value using a Property.
    • stroke: Color of the stroke. Input either a string pull out the value using a Property.
    • strokeWidth: the width of the stroke in pixels. Input either a number pull out the value using a Property.
    • opacity: the opacity of the point. Choose between [0, 1], or pull out the value using a Property.
    • geoFilter: [See GeoFilter] filter the geometry types that will be drawn.
    • interactive: boolean flag. If true, when hovering over the line, the property data will be sent to the UI via an Event
    • cursor: [See Cursor] the cursor to use when hovering over the line
    interface PointStyle {
        color?: string | Property<string>;
        cursor?: string;
        filter?: Filter;
        geoFilter?: GeoFilters;
        interactive?: boolean;
        layer?: string;
        lch?: boolean;
        maxzoom?: number;
        metadata?: unknown;
        minzoom?: number;
        name?: string;
        opacity?: number | Property<number>;
        radius?: number | Property<number>;
        source?: string;
        stroke?: string | Property<string>;
        strokeWidth?: number | Property<number>;
        type: "point";
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    color?: string | Property<string>

    A PAINT Property.

    "rgba(0, 0, 0, 0)"

    ex.

    { "color": "rgba(240, 2, 5, 1)" }
    

    ex.

    { "color": { "inputValue": { "key": "type", "fallback": "blue" } } }
    
    • 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 string itself or pull from feature properties using Property
    cursor?: string

    the cursor to use when hovering over the line. Defaults to "default"

    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" }
    ]
    }
    geoFilter?: GeoFilters

    Filter the geometry types that will be drawn. An empty array will support all geometry types. Ex. ["line"]: only draw lines Defaults to ['line', 'poly'].

    interactive?: boolean

    if true, when hovering over the line, the property data will be sent to the UI via an Event. Defaults to false

    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
    radius?: number | Property<number>

    A PAINT Property.

    1

    ex.

    { "radius": "rgba(240, 2, 5, 1)" }
    

    ex.

    { "radius": { "inputValue": { "key": "size", "fallback": "blue" } } }
    
    • 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
    source?: string

    The source used to generate the layer

    stroke?: string | Property<string>

    A PAINT Property.

    "rgba(0, 0, 0, 0)"

    ex.

    { "stroke": "rgba(240, 2, 5, 1)" }
    

    ex.

    { "stroke": { "inputValue": { "key": "stroke", "fallback": "blue" } } }
    
    • 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 string itself or pull from feature properties using Property
    strokeWidth?: number | Property<number>

    A PAINT Property.

    1

    ex.

    { "strokeWidth": "rgba(240, 2, 5, 1)" }
    

    ex.

    { "strokeWidth": { "inputValue": { "key": "strokeSize", "fallback": "blue" } } }
    
    • 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 strokeWidth itself or pull from feature properties using Property
    type: "point"

    Point 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
    • color: Color of the point. Input either a string pull out the value using a Property.
    • radius: radial size of the point in pixels. Input either a number pull out the value using a Property.
    • stroke: Color of the stroke. Input either a string pull out the value using a Property.
    • strokeWidth: the width of the stroke in pixels. Input either a number pull out the value using a Property.
    • opacity: the opacity of the point. Choose between [0, 1], or pull out the value using a Property.
    • geoFilter: [See GeoFilter] filter the geometry types that will be drawn. Options are point, line, poly.
    • interactive: boolean flag. If true, when hovering over the line, the property data will be sent to the UI via an Event
    • cursor: [See Cursor] the cursor to use when hovering over the line
    visible?: boolean

    Whether the layer is visible or not