Skip to content

ParticleLayer

ParticleLayer is a particle-animation layer extending CanvasLayer, used to draw particles that move over time. It provides interface methods to render particles. You can use it directly, but it cannot be serialized/deserialized with JSON; it is more recommended to extend it with a subclass and override getParticles().

js
import { Map, ParticleLayer } from "maptalks";

const map = new Map("map", { center: [0, 0], zoom: 2 });

const layer = new ParticleLayer("particle");

layer.getParticles = function (t) {
  return particles[t];
};

layer.addTo(map);

Constructor

js
new ParticleLayer(id, options?)

Parameters:

  • id String layer id.
  • options Object layer options (optional).

options

OptionTypeDescriptionDefault
animationBooleanwhether the layer is an animated layertrue
trailNumbertrail length (smaller means a longer trail)30
lineColorStringdefault particle color, #fff when unsetnull

Member Methods

  • getParticles(t?): {point, color?, r?}[] — interface to get particle positions at time t (override)
  • draw(context, view): void — draw particles on the current view

Events

Common layer events (show/hide, setopacity, add/remove, etc.) — see CanvasLayer / Layer.