tsParticles - v0.0.0
    Preparing search index...

    Interface Particles

    interface Particles {
        movers: IParticleMover[];
        quadTree: QuadTree;
        updaters: IParticleUpdater[];
        get count(): number;
        addParticle(
            position?: ICoordinates,
            overrideOptions?: RecursivePartial<IParticlesOptions>,
            group?: string,
            initializer?: (particle: Particle) => boolean,
        ): Particle | undefined;
        clear(): void;
        destroy(): void;
        drawParticles(delta: IDelta): void;
        filter(condition: (particle: Particle) => boolean): Particle[];
        find(condition: (particle: Particle) => boolean): Particle | undefined;
        get(index: number): Particle | undefined;
        init(): Promise<void>;
        initPlugins(): Promise<void>;
        push(
            nb: number,
            position?: ICoordinates,
            overrideOptions?: RecursivePartial<IParticlesOptions>,
            group?: string,
        ): void;
        redraw(): Promise<void>;
        remove(particle: Particle, group?: string, override?: boolean): void;
        removeAt(
            index: number,
            quantity?: number,
            group?: string,
            override?: boolean,
        ): void;
        removeQuantity(quantity: number, group?: string): void;
        setDensity(): void;
        setLastZIndex(zIndex: number): void;
        setResizeFactor(factor: IDimension): void;
        update(delta: IDelta): void;
    }
    Index

    Properties

    movers quadTree updaters

    Accessors

    count

    Methods

    addParticle clear destroy drawParticles filter find get init initPlugins push redraw remove removeAt removeQuantity setDensity setLastZIndex setResizeFactor update

    Properties

    movers: IParticleMover[]
    quadTree: QuadTree
    updaters: IParticleUpdater[]

    Accessors

    • get count(): number

      Returns number

    Methods

    • Returns void

    • Returns void

    • Parameters

      Returns void

    • Parameters

      • condition: (particle: Particle) => boolean

      Returns Particle[]

    • Parameters

      • condition: (particle: Particle) => boolean

      Returns Particle | undefined

    • Parameters

      • index: number

      Returns Particle | undefined

    • Returns Promise<void>

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • particle: Particle
      • Optionalgroup: string
      • Optionaloverride: boolean

      Returns void

    • Parameters

      • index: number
      • Optionalquantity: number
      • Optionalgroup: string
      • Optionaloverride: boolean

      Returns void

    • Parameters

      • quantity: number
      • Optionalgroup: string

      Returns void

    • Returns void

    • Parameters

      • zIndex: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods