RasterParticleLayer

Particle animation driven by textures such as wind maps.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

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

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
open override fun rasterParticleArrayBand(rasterParticleArrayBand: Expression): RasterParticleLayer
open override fun rasterParticleArrayBand(rasterParticleArrayBand: String): RasterParticleLayer

Displayed band of raster array source layer

Link copied to clipboard
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.

Link copied to clipboard
open override fun rasterParticleCount(rasterParticleCount: Expression): RasterParticleLayer
open override fun rasterParticleCount(rasterParticleCount: Long): RasterParticleLayer

Defines the amount of particles per tile.

Link copied to clipboard
open override fun rasterParticleFadeOpacityFactor(rasterParticleFadeOpacityFactor: Expression): RasterParticleLayer
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.

Link copied to clipboard
open override fun rasterParticleMaxSpeed(rasterParticleMaxSpeed: Expression): RasterParticleLayer
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.

Link copied to clipboard
open override fun rasterParticleResetRateFactor(rasterParticleResetRateFactor: Expression): RasterParticleLayer
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).

Link copied to clipboard
open override fun rasterParticleSpeedFactor(rasterParticleSpeedFactor: Expression): RasterParticleLayer
open override fun rasterParticleSpeedFactor(rasterParticleSpeedFactor: Double): RasterParticleLayer

Defines a coefficient for the speed of particles’ motion.

Link copied to clipboard
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.

Link copied to clipboard
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.

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

Whether this layer is displayed.

Properties

Link copied to clipboard

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

Link copied to clipboard
open override val layerId: String
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.

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.

Link copied to clipboard

Displayed band of raster array source layer

Link copied to clipboard

Displayed band of raster array source layer

Link copied to clipboard

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.

Link copied to clipboard

Defines the amount of particles per tile.

Link copied to clipboard

Defines the amount of particles per tile.

Link copied to clipboard

Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail.

Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail.

Transition options for RasterParticleFadeOpacityFactor.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Defines a coefficient for a time period at which particles will restart at a random position, to avoid degeneration (empty areas without particles).

Defines a coefficient for a time period at which particles will restart at a random position, to avoid degeneration (empty areas without particles).

Link copied to clipboard

Defines a coefficient for the speed of particles’ motion.

Link copied to clipboard

Defines a coefficient for the speed of particles’ motion.

Link copied to clipboard

Transition options for RasterParticleSpeedFactor.

Link copied to clipboard
open override val slot: String?

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.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.

Link copied to clipboard

Whether this layer is displayed.

Extensions

Link copied to clipboard

Get the persistent property as Boolean.