MediaLayerOptions interface
Options used when rendering canvas, image, raster tile, and video layers
- Extends
Properties
contrast | A number between -1 and 1 that increases or decreases the contrast of the overlay.
Default |
fade |
The duration in milliseconds of a fade transition when a new tile is added.
Must be greater or equal to 0.
Default |
hue |
Rotates hues around the color wheel.
A number in degrees.
Default |
max |
A number between 0 and 1 that increases or decreases the maximum brightness of the overlay.
Default |
min |
A number between 0 and 1 that increases or decreases the minimum brightness of the overlay.
Default |
opacity | A number between 0 and 1 that indicates the opacity at which the overlay will be drawn.
Default |
saturation | A number between -1 and 1 that increases or decreases the saturation of the overlay.
Default |
Inherited Properties
filter | An expression specifying conditions on source features. Only features that match the filter are displayed. |
max |
An integer specifying the maximum zoom level to render the layer at.
This value is exclusive, i.e. the layer will be visible at |
min |
An integer specifying the minimum zoom level to render the layer at.
This value is inclusive, i.e. the layer will be visible at |
visible | Specifies if the layer is visible or not.
Default |
Property Details
contrast
A number between -1 and 1 that increases or decreases the contrast of the overlay.
Default 0
.
contrast?: number
Property Value
number
fadeDuration
The duration in milliseconds of a fade transition when a new tile is added.
Must be greater or equal to 0.
Default 300
.
fadeDuration?: number
Property Value
number
hueRotation
Rotates hues around the color wheel.
A number in degrees.
Default 0
.
hueRotation?: number
Property Value
number
maxBrightness
A number between 0 and 1 that increases or decreases the maximum brightness of the overlay.
Default 1
.
maxBrightness?: number
Property Value
number
minBrightness
A number between 0 and 1 that increases or decreases the minimum brightness of the overlay.
Default 0
.
minBrightness?: number
Property Value
number
opacity
A number between 0 and 1 that indicates the opacity at which the overlay will be drawn.
Default 1
.
opacity?: number
Property Value
number
saturation
A number between -1 and 1 that increases or decreases the saturation of the overlay.
Default 0
.
saturation?: number
Property Value
number
Inherited Property Details
filter
An expression specifying conditions on source features. Only features that match the filter are displayed.
filter?: Expression
Property Value
Inherited From LayerOptions.filter
maxZoom
An integer specifying the maximum zoom level to render the layer at.
This value is exclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom
.
Default 24
.
maxZoom?: number
Property Value
number
Inherited From LayerOptions.maxZoom
minZoom
An integer specifying the minimum zoom level to render the layer at.
This value is inclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom
.
Default 0
.
minZoom?: number
Property Value
number
Inherited From LayerOptions.minZoom
visible
Specifies if the layer is visible or not.
Default true
.
visible?: boolean
Property Value
boolean
Inherited From LayerOptions.visible