RasterParticleLayer

fun RasterParticleLayer(layerId: String, sourceId: String)

Companion

object Companion

Static variables and methods.

bindTo

fun bindTo(delegate: MapboxStyleManager)

Bind the layer to the Style.

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

Bind the layer to the map controller.

filter

open override fun filter(filter: Expression): RasterParticleLayer

A filter is a property at the layer level that determines which features should be rendered in a style layer.

maxZoom

open override fun maxZoom(maxZoom: Double): RasterParticleLayer

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

minZoom

open override fun minZoom(minZoom: Double): RasterParticleLayer

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

rasterParticleArrayBand

@MapboxExperimental

open override fun rasterParticleArrayBand(rasterParticleArrayBand: Expression): RasterParticleLayer

@MapboxExperimental

open override fun rasterParticleArrayBand(rasterParticleArrayBand: String): RasterParticleLayer

Displayed band of raster array source layer

rasterParticleColor

@MapboxExperimental

open override fun rasterParticleColor(rasterParticleColor: Expression): RasterParticleLayer

Defines a color map by which to colorize a raster particle layer, parameterized by the ["raster-particle-speed"] expression and evaluated at 256 uniformly spaced steps over the range specified by raster-particle-max-speed.

rasterParticleCount

@MapboxExperimental

open override fun rasterParticleCount(rasterParticleCount: Expression): RasterParticleLayer

@MapboxExperimental

open override fun rasterParticleCount(rasterParticleCount: Long): RasterParticleLayer

Defines the amount of particles per tile. Default value: 512. Minimum value: 1.

rasterParticleFadeOpacityFactor

@MapboxExperimental

open override fun rasterParticleFadeOpacityFactor(rasterParticleFadeOpacityFactor: Expression): RasterParticleLayer

@MapboxExperimental

open override fun rasterParticleFadeOpacityFactor(rasterParticleFadeOpacityFactor: Double): RasterParticleLayer

Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail. Default value: 0.98. Value range: 0, 1

rasterParticleFadeOpacityFactorTransition

@MapboxExperimental

open override fun rasterParticleFadeOpacityFactorTransition(options: StyleTransition): RasterParticleLayer

Set the RasterParticleFadeOpacityFactor property transition options

@MapboxExperimental

open override fun rasterParticleFadeOpacityFactorTransition(block: StyleTransition.Builder.() -> Unit): RasterParticleLayer

DSL for rasterParticleFadeOpacityFactorTransition.

rasterParticleMaxSpeed

@MapboxExperimental

open override fun rasterParticleMaxSpeed(rasterParticleMaxSpeed: Expression): RasterParticleLayer

@MapboxExperimental

open override fun rasterParticleMaxSpeed(rasterParticleMaxSpeed: Double): RasterParticleLayer

Defines the maximum speed for particles. Velocities with magnitudes equal to or exceeding this value are clamped to the max value. Default value: 1. Minimum value: 1.

rasterParticleResetRateFactor

@MapboxExperimental

open override fun rasterParticleResetRateFactor(rasterParticleResetRateFactor: Expression): RasterParticleLayer

@MapboxExperimental

open override fun rasterParticleResetRateFactor(rasterParticleResetRateFactor: Double): RasterParticleLayer

Defines a coefficient for a time period at which particles will restart at a random position, to avoid degeneration (empty areas without particles). Default value: 0.8. Value range: 0, 1

rasterParticleSpeedFactor

@MapboxExperimental

open override fun rasterParticleSpeedFactor(rasterParticleSpeedFactor: Expression): RasterParticleLayer

@MapboxExperimental

open override fun rasterParticleSpeedFactor(rasterParticleSpeedFactor: Double): RasterParticleLayer

Defines a coefficient for the speed of particles’ motion. Default value: 0.2. Value range: 0, 1

rasterParticleSpeedFactorTransition

@MapboxExperimental

open override fun rasterParticleSpeedFactorTransition(options: StyleTransition): RasterParticleLayer

Set the RasterParticleSpeedFactor property transition options

@MapboxExperimental

open override fun rasterParticleSpeedFactorTransition(block: StyleTransition.Builder.() -> Unit): RasterParticleLayer

DSL for rasterParticleSpeedFactorTransition.

slot

open override fun slot(slot: String): RasterParticleLayer

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

sourceLayer

open override fun sourceLayer(sourceLayer: String): RasterParticleLayer

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

visibility

open override fun visibility(visibility: Expression): RasterParticleLayer

open override fun visibility(visibility: Visibility): RasterParticleLayer

Whether this layer is displayed.

filter

val filter: Expression?

A filter is a property at the layer level that determines which features should be rendered in a style layer.

layerId

open override val layerId: String

maxZoom

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

open override val minZoom: Double?

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

rasterParticleArrayBand

@MapboxExperimental

val rasterParticleArrayBand: String?

Displayed band of raster array source layer

rasterParticleArrayBandAsExpression

@MapboxExperimental

val rasterParticleArrayBandAsExpression: Expression?

Displayed band of raster array source layer

rasterParticleColor

@MapboxExperimental

val rasterParticleColor: Expression?

Defines a color map by which to colorize a raster particle layer, parameterized by the ["raster-particle-speed"] expression and evaluated at 256 uniformly spaced steps over the range specified by raster-particle-max-speed.

rasterParticleCount

@MapboxExperimental

val rasterParticleCount: Long?

Defines the amount of particles per tile. Default value: 512. Minimum value: 1.

rasterParticleCountAsExpression

@MapboxExperimental

val rasterParticleCountAsExpression: Expression?

Defines the amount of particles per tile. Default value: 512. Minimum value: 1.

rasterParticleFadeOpacityFactor

@MapboxExperimental

val rasterParticleFadeOpacityFactor: Double?

Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail. Default value: 0.98. Value range: 0, 1

rasterParticleFadeOpacityFactorAsExpression

@MapboxExperimental

val rasterParticleFadeOpacityFactorAsExpression: Expression?

Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail. Default value: 0.98. Value range: 0, 1

rasterParticleFadeOpacityFactorTransition

@MapboxExperimental

val rasterParticleFadeOpacityFactorTransition: StyleTransition?

Transition options for RasterParticleFadeOpacityFactor.

rasterParticleMaxSpeed

@MapboxExperimental

val rasterParticleMaxSpeed: Double?

Defines the maximum speed for particles. Velocities with magnitudes equal to or exceeding this value are clamped to the max value. Default value: 1. Minimum value: 1.

rasterParticleMaxSpeedAsExpression

@MapboxExperimental

val rasterParticleMaxSpeedAsExpression: Expression?

Defines the maximum speed for particles. Velocities with magnitudes equal to or exceeding this value are clamped to the max value. Default value: 1. Minimum value: 1.

rasterParticleResetRateFactor

@MapboxExperimental

val rasterParticleResetRateFactor: Double?

Defines a coefficient for a time period at which particles will restart at a random position, to avoid degeneration (empty areas without particles). Default value: 0.8. Value range: 0, 1

rasterParticleResetRateFactorAsExpression

@MapboxExperimental

val rasterParticleResetRateFactorAsExpression: Expression?

Defines a coefficient for a time period at which particles will restart at a random position, to avoid degeneration (empty areas without particles). Default value: 0.8. Value range: 0, 1

rasterParticleSpeedFactor

@MapboxExperimental

val rasterParticleSpeedFactor: Double?

Defines a coefficient for the speed of particles’ motion. Default value: 0.2. Value range: 0, 1

rasterParticleSpeedFactorAsExpression

@MapboxExperimental

val rasterParticleSpeedFactorAsExpression: Expression?

Defines a coefficient for the speed of particles’ motion. Default value: 0.2. Value range: 0, 1

rasterParticleSpeedFactorTransition

@MapboxExperimental

val rasterParticleSpeedFactorTransition: StyleTransition?

Transition options for RasterParticleSpeedFactor.