Optional
colorDefine a color ramp to be used for a feature
sinebow
.
ex.
{
"colorRamp": [
{ "stop": 0, "color": "rgba(33,102,172,0)" },
{ "stop": 0.2, "color": "rgba(103,169,207, 0.85)" },
{ "stop": 0.4, "color": "rgb(209,229,240)" },
{ "stop": 0.6, "color": "rgb(253,219,199)" },
{ "stop": 0.8, "color": "rgb(239,138,98)" },
{ "stop": 1, "color": "rgb(178,24,43)" }
]
}
Optional
filterA 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" }
]
}
Optional
geoFilter the geometry types that will be drawn.
An empty array will support all geometry types.
Ex. ["line"]
: only draw lines
Defaults to ['line', 'poly']
(only points will be drawn).
Optional
intensityA PAINT Property
.
1
ex.
{ "intensity": 2.5 }
ex.
{ "intensity": { "inputValue": { "key": "strength", "fallback": 1 } } }
inputValue
: [See InputValue] access value in feature propertiesdataCondition
: [See DataCondition] filter based on feature property conditionsdataRange
: [See DataRange] filter based on feature property rangesinputRange
: [See InputRange] filter based on map conditions like "zoom", "lon", "lat", "angle", or "pitch"featureState
: [See FeatureState] filter based on feature statefallback
: if all else fails, use this value. A value of number
itself or pull from feature properties using PropertyOptional
layerThe source's layer. Default for JSON data
Optional
lchUse LCH coloring instead of RGB. Useful for color changing when the new color is very different from the old one
Optional
maxzoomThe maximum zoom level at which the layer will be visible
Optional
metadataAdditional metadata. Used by style generators.
Optional
minzoomThe minimum zoom level at which the layer will be visible
Optional
nameThe name of the layer - useful for sorting a layer on insert or for removal
Optional
opacityA PAINT Property
.
1
ex.
{ "opacity": 0.5 }
ex.
{ "opacity": { "inputValue": { "key": "opacity", "fallback": 1 } } }
inputValue
: [See InputValue] access value in feature propertiesdataCondition
: [See DataCondition] filter based on feature property conditionsdataRange
: [See DataRange] filter based on feature property rangesinputRange
: [See InputRange] filter based on map conditions like "zoom", "lon", "lat", "angle", or "pitch"featureState
: [See FeatureState] filter based on feature statefallback
: if all else fails, use this value. A value of number
itself or pull from feature properties using PropertyOptional
radiusA PAINT Property
.
1
ex.
{ "radius": 5 } }
ex.
{ "radius": { "inputValue": { "key": "size", "fallback": 3.5 } } }
inputValue
: [See InputValue] access value in feature propertiesdataCondition
: [See DataCondition] filter based on feature property conditionsdataRange
: [See DataRange] filter based on feature property rangesinputRange
: [See InputRange] filter based on map conditions like "zoom", "lon", "lat", "angle", or "pitch"featureState
: [See FeatureState] filter based on feature statefallback
: if all else fails, use this value. A value of number
itself or pull from feature properties using PropertyOptional
sourceThe source used to generate the layer
name
: the name of the layer, useful for sorting a layer on insert or for removalsource
: the name of the source whose data this layer will uselayer
: the source's layer. Defaults to "default" for JSON dataminzoom
: the minimum zoom level at which the layer will be visiblemaxzoom
: the maximum zoom level at which the layer will be visiblefilter
: [See Filter] a filter function to filter out features from the source layerlch
: use LCH coloring instead of RGB. Useful for color changing when the new color is very different from the old onevisible
: whether the layer is visible or notmetadata
: additional metadata. Used by style generatorsradius
: the radius of the heatmap in pixelsopacity
: the opacity of the heatmap. Choose between [0, 1], or pull out the value using a Property.intensity
: the intensity of the heatmapweight
: A weight multiplier to apply to each of the heatmap's pointsOptional
visibleWhether the layer is visible or not
Optional
weightA PAINT Property
.
1
ex.
{ "weight": 2.5 }
ex.
{ "weight": { "inputValue": { "key": "impact", "fallback": 1 } } }
inputValue
: [See InputValue] access value in feature propertiesdataCondition
: [See DataCondition] filter based on feature property conditionsdataRange
: [See DataRange] filter based on feature property rangesinputRange
: [See InputRange] filter based on map conditions like "zoom", "lon", "lat", "angle", or "pitch"featureState
: [See FeatureState] filter based on feature statefallback
: if all else fails, use this value. A value of number
itself or pull from feature properties using Property
Heatmap Layer Guide
Base Properties:
[See LayerStyleBase]
name
: the name of the layer, useful for sorting a layer on insert or for removalsource
: the name of the source whose data this layer will uselayer
: the source's layer. Defaults to "default" for JSON dataminzoom
: the minimum zoom level at which the layer will be visiblemaxzoom
: the maximum zoom level at which the layer will be visiblefilter
: [See Filter] a filter function to filter out features from the source layerlch
: use LCH coloring instead of RGB. Useful for color changing when the new color is very different from the old onevisible
: whether the layer is visible or notmetadata
: additional metadata. Used by style generatorsOptional paint properties:
radius
: the radius of the heatmap in pixelsopacity
: the opacity of the heatmap. Choose between [0, 1], or pull out the value using a Property.intensity
: the intensity of the heatmapOptional layout properties:
weight
: A weight multiplier to apply to each of the heatmap's pointsOptional properties:
geoFilter
: [See GeoFilter] filter the geometry types that will be drawn.colorRamp
: [See ColorRamp] Build a interpolation ramp to help the sensor data be converted into RGBA. May besinebow
orsinebow-extended