tsParticles - v0.0.0
    Preparing search index...

    Interface IEmitter

    Particles emitter object options [[include:Options/Plugins/Emitters.md]]

    interface IEmitter {
        autoPlay: boolean;
        direction?:
            | number
            | "none"
            | "left"
            | "top"
            | "bottom"
            | "right"
            | "outside"
            | "inside"
            | MoveDirectionAlt
            | MoveDirection
            | "bottomLeft"
            | "bottomRight"
            | "topLeft"
            | "topRight";
        domId?: string;
        fill: boolean;
        life: IEmitterLife;
        name?: string;
        particles?: SingleOrMultiple<RecursivePartial<IParticlesOptions>>;
        position?: RecursivePartial<IRangedCoordinates>;
        rate: IEmitterRate;
        shape: IEmitterShape;
        size?: IEmitterSize;
        spawnColor?: IAnimatableColor;
        startCount: number;
    }

    Implemented by

    Index

    Properties

    autoPlay direction? domId? fill life name? particles? position? rate shape size? spawnColor? startCount

    Properties

    autoPlay: boolean

    Starts the emitter automatically

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

    The direction of the emitted particles, MoveDirection is the enum used for values

    domId?: string

    Using this id to link the emitter to an HTML element

    fill: boolean

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

    life: IEmitterLife

    The emitter life options

    name?: string

    The emitter name

    particles?: SingleOrMultiple<RecursivePartial<IParticlesOptions>>

    Particles emitted customization. These settings will overrides other particles settings for the particles emitted by this emitter Particles number options won't override anything, they will be ignored completely

    position?: RecursivePartial<IRangedCoordinates>

    The relative position (in percent) of the emitter, where particles spawns. If size is specified the position will be the center of the size options

    rate: IEmitterRate

    The particles emitting rate options

    shape: IEmitterShape

    The emitter shape type (circle or square)

    size?: IEmitterSize

    The size of the particles emitter area

    spawnColor?: IAnimatableColor

    The particle spawn color

    startCount: number

    The number of starting particles of the emitter

    Settings

    Member Visibility

    On This Page

    Properties