RasterLayer

class RasterLayer(layerId: String, sourceId: String) : Layer, RasterLayerDsl

Raster map textures such as satellite imagery.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

RasterLayer
Link copied to clipboard
fun RasterLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

bindTo
Link copied to clipboard
fun bindTo(delegate: StyleInterface)

Bind the layer to the Style.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)

Bind the layer to the map controller.

maxZoom
Link copied to clipboard
open override fun maxZoom(maxZoom: Double): RasterLayer

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

minZoom
Link copied to clipboard
open override fun minZoom(minZoom: Double): RasterLayer

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

rasterBrightnessMax
Link copied to clipboard
open override fun rasterBrightnessMax(rasterBrightnessMax: Expression): RasterLayer
open override fun rasterBrightnessMax(rasterBrightnessMax: Double): RasterLayer

Increase or reduce the brightness of the image. The value is the maximum brightness.

rasterBrightnessMaxTransition
Link copied to clipboard
open override fun rasterBrightnessMaxTransition(options: StyleTransition): RasterLayer

Set the RasterBrightnessMax property transition options

open override fun rasterBrightnessMaxTransition(block: StyleTransition.Builder.() -> Unit): RasterLayer
rasterBrightnessMin
Link copied to clipboard
open override fun rasterBrightnessMin(rasterBrightnessMin: Expression): RasterLayer
open override fun rasterBrightnessMin(rasterBrightnessMin: Double): RasterLayer

Increase or reduce the brightness of the image. The value is the minimum brightness.

rasterBrightnessMinTransition
Link copied to clipboard
open override fun rasterBrightnessMinTransition(options: StyleTransition): RasterLayer

Set the RasterBrightnessMin property transition options

open override fun rasterBrightnessMinTransition(block: StyleTransition.Builder.() -> Unit): RasterLayer
rasterContrast
Link copied to clipboard
open override fun rasterContrast(rasterContrast: Expression): RasterLayer
open override fun rasterContrast(rasterContrast: Double): RasterLayer

Increase or reduce the contrast of the image.

rasterContrastTransition
Link copied to clipboard
open override fun rasterContrastTransition(options: StyleTransition): RasterLayer

Set the RasterContrast property transition options

open override fun rasterContrastTransition(block: StyleTransition.Builder.() -> Unit): RasterLayer
rasterFadeDuration
Link copied to clipboard
open override fun rasterFadeDuration(rasterFadeDuration: Expression): RasterLayer
open override fun rasterFadeDuration(rasterFadeDuration: Double): RasterLayer

Fade duration when a new tile is added.

rasterHueRotate
Link copied to clipboard
open override fun rasterHueRotate(rasterHueRotate: Expression): RasterLayer
open override fun rasterHueRotate(rasterHueRotate: Double): RasterLayer

Rotates hues around the color wheel.

rasterHueRotateTransition
Link copied to clipboard
open override fun rasterHueRotateTransition(options: StyleTransition): RasterLayer

Set the RasterHueRotate property transition options

open override fun rasterHueRotateTransition(block: StyleTransition.Builder.() -> Unit): RasterLayer
rasterOpacity
Link copied to clipboard
open override fun rasterOpacity(rasterOpacity: Expression): RasterLayer
open override fun rasterOpacity(rasterOpacity: Double): RasterLayer

The opacity at which the image will be drawn.

rasterOpacityTransition
Link copied to clipboard
open override fun rasterOpacityTransition(options: StyleTransition): RasterLayer

Set the RasterOpacity property transition options

open override fun rasterOpacityTransition(block: StyleTransition.Builder.() -> Unit): RasterLayer
rasterResampling
Link copied to clipboard
open override fun rasterResampling(rasterResampling: Expression): RasterLayer
open override fun rasterResampling(rasterResampling: RasterResampling): RasterLayer

The resampling/interpolation method to use for overscaling, also known as texture magnification filter

rasterSaturation
Link copied to clipboard
open override fun rasterSaturation(rasterSaturation: Expression): RasterLayer
open override fun rasterSaturation(rasterSaturation: Double): RasterLayer

Increase or reduce the saturation of the image.

rasterSaturationTransition
Link copied to clipboard
open override fun rasterSaturationTransition(options: StyleTransition): RasterLayer

Set the RasterSaturation property transition options

open override fun rasterSaturationTransition(block: StyleTransition.Builder.() -> Unit): RasterLayer
sourceLayer
Link copied to clipboard
open override fun sourceLayer(sourceLayer: String): RasterLayer

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): RasterLayer

Whether this layer is displayed.

Properties

layerId
Link copied to clipboard
open override val layerId: String
maxZoom
Link copied to clipboard
open override val maxZoom: Double?

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

minZoom
Link copied to clipboard
open override val minZoom: Double?

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

rasterBrightnessMax
Link copied to clipboard
val rasterBrightnessMax: Double?

Increase or reduce the brightness of the image. The value is the maximum brightness.

rasterBrightnessMaxAsExpression
Link copied to clipboard
val rasterBrightnessMaxAsExpression: Expression?

Increase or reduce the brightness of the image. The value is the maximum brightness.

rasterBrightnessMaxTransition
Link copied to clipboard
val rasterBrightnessMaxTransition: StyleTransition?

Transition options for RasterBrightnessMax.

rasterBrightnessMin
Link copied to clipboard
val rasterBrightnessMin: Double?

Increase or reduce the brightness of the image. The value is the minimum brightness.

rasterBrightnessMinAsExpression
Link copied to clipboard
val rasterBrightnessMinAsExpression: Expression?

Increase or reduce the brightness of the image. The value is the minimum brightness.

rasterBrightnessMinTransition
Link copied to clipboard
val rasterBrightnessMinTransition: StyleTransition?

Transition options for RasterBrightnessMin.

rasterContrast
Link copied to clipboard
val rasterContrast: Double?

Increase or reduce the contrast of the image.

rasterContrastAsExpression
Link copied to clipboard
val rasterContrastAsExpression: Expression?

Increase or reduce the contrast of the image.

rasterContrastTransition
Link copied to clipboard
val rasterContrastTransition: StyleTransition?

Transition options for RasterContrast.

rasterFadeDuration
Link copied to clipboard
val rasterFadeDuration: Double?

Fade duration when a new tile is added.

rasterFadeDurationAsExpression
Link copied to clipboard
val rasterFadeDurationAsExpression: Expression?

Fade duration when a new tile is added.

rasterHueRotate
Link copied to clipboard
val rasterHueRotate: Double?

Rotates hues around the color wheel.

rasterHueRotateAsExpression
Link copied to clipboard
val rasterHueRotateAsExpression: Expression?

Rotates hues around the color wheel.

rasterHueRotateTransition
Link copied to clipboard
val rasterHueRotateTransition: StyleTransition?

Transition options for RasterHueRotate.

rasterOpacity
Link copied to clipboard
val rasterOpacity: Double?

The opacity at which the image will be drawn.

rasterOpacityAsExpression
Link copied to clipboard
val rasterOpacityAsExpression: Expression?

The opacity at which the image will be drawn.

rasterOpacityTransition
Link copied to clipboard
val rasterOpacityTransition: StyleTransition?

Transition options for RasterOpacity.

rasterResampling
Link copied to clipboard
val rasterResampling: RasterResampling?

The resampling/interpolation method to use for overscaling, also known as texture magnification filter

rasterResamplingAsExpression
Link copied to clipboard
val rasterResamplingAsExpression: Expression?

The resampling/interpolation method to use for overscaling, also known as texture magnification filter

rasterSaturation
Link copied to clipboard
val rasterSaturation: Double?

Increase or reduce the saturation of the image.

rasterSaturationAsExpression
Link copied to clipboard
val rasterSaturationAsExpression: Expression?

Increase or reduce the saturation of the image.

rasterSaturationTransition
Link copied to clipboard
val rasterSaturationTransition: StyleTransition?

Transition options for RasterSaturation.

sourceId
Link copied to clipboard
val sourceId: String
sourceLayer
Link copied to clipboard
val sourceLayer: String?

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

visibility
Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.