RasterLayer

Raster map textures such as satellite imagery.

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

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

RasterLayer
Link copied to clipboard

the ID of the layer

fun RasterLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

bindTo
Link copied to clipboard

Bind the layer to the Style.

override fun bindTo(delegate: StyleInterface)

Bind the layer to the map controller.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getCachedLayerProperties
Link copied to clipboard
override fun getCachedLayerProperties(): Value
hashCode
Link copied to clipboard
open override fun hashCode(): Int
maxZoom
Link copied to clipboard

Set the maxzoom property

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

Set the minzoom property

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

Set the RasterBrightnessMax property

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

Set the RasterBrightnessMax property transition options

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

Set the RasterBrightnessMin property

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

Set the RasterBrightnessMin property transition options

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

Set the RasterContrast property

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

Set the RasterContrast property transition options

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

Set the RasterFadeDuration property

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

Set the RasterHueRotate property

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

Set the RasterHueRotate property transition options

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

Set the RasterOpacity property

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

Set the RasterOpacity property transition options

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

Set the RasterResampling property

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

Set the RasterSaturation property

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

Set the RasterSaturation property transition options

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

Set the sourceLayer property

open override fun sourceLayer(sourceLayer: String): RasterLayer
toString
Link copied to clipboard
open override fun toString(): String
updateProperty
Link copied to clipboard
override fun updateProperty(property: PropertyValue<*>)
visibility
Link copied to clipboard

Set the Visibility property

open override fun visibility(visibility: Visibility): RasterLayer

Properties

layerId
Link copied to clipboard

the ID of the layer

open override val layerId: String
layerProperties
Link copied to clipboard

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>
maxZoom
Link copied to clipboard

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

Range: minimum: 0 maximum: 24

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

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

Range: minimum: 0 maximum: 24

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

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

val rasterBrightnessMax: Double?
rasterBrightnessMaxAsExpression
Link copied to clipboard

This is an Expression representation of "raster-brightness-max".

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

val rasterBrightnessMaxAsExpression: Expression?
rasterBrightnessMaxTransition
Link copied to clipboard

Transition options for RasterBrightnessMax.

val rasterBrightnessMaxTransition: StyleTransition?
rasterBrightnessMin
Link copied to clipboard

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

val rasterBrightnessMin: Double?
rasterBrightnessMinAsExpression
Link copied to clipboard

This is an Expression representation of "raster-brightness-min".

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

val rasterBrightnessMinAsExpression: Expression?
rasterBrightnessMinTransition
Link copied to clipboard

Transition options for RasterBrightnessMin.

val rasterBrightnessMinTransition: StyleTransition?
rasterContrast
Link copied to clipboard

Increase or reduce the contrast of the image.

val rasterContrast: Double?
rasterContrastAsExpression
Link copied to clipboard

This is an Expression representation of "raster-contrast".

Increase or reduce the contrast of the image.

val rasterContrastAsExpression: Expression?
rasterContrastTransition
Link copied to clipboard

Transition options for RasterContrast.

val rasterContrastTransition: StyleTransition?
rasterFadeDuration
Link copied to clipboard

Fade duration when a new tile is added.

val rasterFadeDuration: Double?
rasterFadeDurationAsExpression
Link copied to clipboard

This is an Expression representation of "raster-fade-duration".

Fade duration when a new tile is added.

val rasterFadeDurationAsExpression: Expression?
rasterHueRotate
Link copied to clipboard

Rotates hues around the color wheel.

val rasterHueRotate: Double?
rasterHueRotateAsExpression
Link copied to clipboard

This is an Expression representation of "raster-hue-rotate".

Rotates hues around the color wheel.

val rasterHueRotateAsExpression: Expression?
rasterHueRotateTransition
Link copied to clipboard

Transition options for RasterHueRotate.

val rasterHueRotateTransition: StyleTransition?
rasterOpacity
Link copied to clipboard

The opacity at which the image will be drawn.

val rasterOpacity: Double?
rasterOpacityAsExpression
Link copied to clipboard

This is an Expression representation of "raster-opacity".

The opacity at which the image will be drawn.

val rasterOpacityAsExpression: Expression?
rasterOpacityTransition
Link copied to clipboard

Transition options for RasterOpacity.

val rasterOpacityTransition: StyleTransition?
rasterResampling
Link copied to clipboard

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

val rasterResampling: RasterResampling?
rasterResamplingAsExpression
Link copied to clipboard

This is an Expression representation of "raster-resampling".

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

val rasterResamplingAsExpression: Expression?
rasterSaturation
Link copied to clipboard

Increase or reduce the saturation of the image.

val rasterSaturation: Double?
rasterSaturationAsExpression
Link copied to clipboard

This is an Expression representation of "raster-saturation".

Increase or reduce the saturation of the image.

val rasterSaturationAsExpression: Expression?
rasterSaturationTransition
Link copied to clipboard

Transition options for RasterSaturation.

val rasterSaturationTransition: StyleTransition?
sourceId
Link copied to clipboard

the ID of the source

val sourceId: String
sourceLayer
Link copied to clipboard

Source layer.

val sourceLayer: String?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?