tsParticles - v4.2.1
    Preparing search index...

    Class Emitter

    [[include:Options/Plugins/Emitters.md]]

    Implements

    Index

    Constructors

    constructor

    Properties

    autoPlay direction? domId? fill life name? particles? position? rate shape size? spawn spawnFillColor? spawnStrokeColor? startCount

    Methods

    load

    Constructors

    Properties

    autoPlay: boolean = true

    Starts the emitter automatically

    direction?:
        | number
        | MoveDirection
        | MoveDirectionAlt
        | "bottom"
        | "bottomLeft"
        | "bottomRight"
        | "left"
        | "none"
        | "right"
        | "top"
        | "topLeft"
        | "topRight"
        | "outside"
        | "inside"

    The direction of the emitted particles

    domId?: string

    The DOM element id to link the emitter to an HTML element

    fill: boolean = true

    Sets if the particles will spawn at the emitter perimeter or inside the area

    life: EmitterLife = ...

    The emitter life options

    name?: string

    The emitter name

    particles?: SingleOrMultiple<RecursivePartial<IParticlesOptions>>

    Particles emitted customization

    position?: RecursivePartial<IRangedCoordinates>

    The relative position of the emitter

    rate: EmitterRate = ...

    The particles emitting rate options

    shape: EmitterShape = ...

    The emitter shape options

    size?: EmitterSize

    The size of the particles emitter area

    spawn: EmitterSpawn = ...

    The emitter spawn options

    spawnFillColor?: AnimatableColor

    The particle spawn fill color

    spawnStrokeColor?: AnimatableColor

    The particle spawn stroke color

    startCount: number = 0

    The number of starting particles of the emitter

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods