tsParticles - v4.0.0-beta.12
    Preparing search index...

    Interface AbsorberContainer

    interface AbsorberContainer {
        actualOptions: AbsorberOptions;
        addAbsorber?: (
            options: RecursivePartial<IAbsorber>,
            position?: ICoordinates,
        ) => Promise<AbsorberInstance>;
        addClickHandler?: (
            callback: (evt: Event, particles?: Particle[]) => void,
        ) => void;
        canvas: CanvasManager;
        destroyed: boolean;
        effectDrawers: Map<string, IEffectDrawer<Particle>>;
        fpsLimit: number;
        getAbsorber?: (idxOrName?: string | number) => AbsorberInstance | undefined;
        hdr: boolean;
        id: symbol;
        pageHidden: boolean;
        particleCreatedPlugins: IContainerPlugin[];
        particleDestroyedPlugins: IContainerPlugin[];
        particlePositionPlugins: IContainerPlugin[];
        particles: ParticlesManager;
        particleUpdaters: IParticleUpdater[];
        plugins: IContainerPlugin[];
        retina: Retina;
        shapeDrawers: Map<string, IShapeDrawer<Particle>>;
        started: boolean;
        zLayers: number;
        get animationStatus(): boolean;
        get options(): Options;
        get sourceOptions(): RecursivePartial<IOptions> | undefined;
        addLifeTime(value: number): void;
        alive(): boolean;
        destroy(remove?: boolean): void;
        dispatchEvent(type: string, data?: unknown): void;
        draw(force: boolean): void;
        export(
            type: string,
            options?: Record<string, unknown>,
        ): Promise<Blob | undefined>;
        init(): Promise<void>;
        initDrawersAndUpdaters(): Promise<void>;
        pause(): void;
        play(force?: boolean): void;
        refresh(): Promise<void>;
        reset(sourceOptions?: RecursivePartial<IOptions>): Promise<void>;
        start(): Promise<void>;
        stop(): void;
        updateActualOptions(): boolean;
    }

    Hierarchy

    • InteractivityContainer
      • AbsorberContainer
    Index

    Properties

    actualOptions addAbsorber? addClickHandler? canvas destroyed effectDrawers fpsLimit getAbsorber? hdr id pageHidden particleCreatedPlugins particleDestroyedPlugins particlePositionPlugins particles particleUpdaters plugins retina shapeDrawers started zLayers

    Accessors

    animationStatus options sourceOptions

    Methods

    addLifeTime alive destroy dispatchEvent draw export init initDrawersAndUpdaters pause play refresh reset start stop updateActualOptions

    Properties

    actualOptions: AbsorberOptions
    addAbsorber?: (
        options: RecursivePartial<IAbsorber>,
        position?: ICoordinates,
    ) => Promise<AbsorberInstance>
    addClickHandler?: (
        callback: (evt: Event, particles?: Particle[]) => void,
    ) => void
    canvas: CanvasManager
    destroyed: boolean
    effectDrawers: Map<string, IEffectDrawer<Particle>>
    fpsLimit: number
    getAbsorber?: (idxOrName?: string | number) => AbsorberInstance | undefined
    hdr: boolean
    id: symbol
    pageHidden: boolean
    particleCreatedPlugins: IContainerPlugin[]
    particleDestroyedPlugins: IContainerPlugin[]
    particlePositionPlugins: IContainerPlugin[]
    particles: ParticlesManager
    particleUpdaters: IParticleUpdater[]
    plugins: IContainerPlugin[]
    retina: Retina
    shapeDrawers: Map<string, IShapeDrawer<Particle>>
    started: boolean
    zLayers: number

    Accessors

    • get animationStatus(): boolean

      Returns boolean

    • get options(): Options

      Returns Options

    Methods

    • Parameters

      • value: number

      Returns void

    • Returns boolean

    • Parameters

      • Optionalremove: boolean

      Returns void

    • Parameters

      • type: string
      • Optionaldata: unknown

      Returns void

    • Parameters

      • force: boolean

      Returns void

    • Parameters

      • type: string
      • Optionaloptions: Record<string, unknown>

      Returns Promise<Blob | undefined>

    • Returns Promise<void>

    • Returns Promise<void>

    • Returns void

    • Parameters

      • Optionalforce: boolean

      Returns void

    • Returns Promise<void>

    • Returns Promise<void>

    • Returns void

    • Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods