Interface AbsorberContainer

interface AbsorberContainer {
    actualOptions: AbsorberOptions;
    addAbsorber: ((options: RecursivePartial<IAbsorber>, position?: ICoordinates) => Promise<AbsorberInstance>);
    canvas: Canvas;
    destroyed: boolean;
    effectDrawers: Map<string, IEffectDrawer<Particle>>;
    fpsLimit: number;
    getAbsorber: ((idxOrName?: string | number) => undefined | AbsorberInstance);
    id: symbol;
    interactivity: IContainerInteractivity;
    pageHidden: boolean;
    particles: Particles;
    pathGenerators: Map<string, IMovePathGenerator>;
    plugins: Map<string, IContainerPlugin>;
    retina: Retina;
    shapeDrawers: Map<string, IShapeDrawer<Particle>>;
    started: boolean;
    zLayers: number;
    get animationStatus(): boolean;
    get options(): Options;
    get sourceOptions(): undefined | RecursivePartial<IOptions>;
    addClickHandler(callback: ((evt: Event, particles?: Particle[]) => void)): void;
    addLifeTime(value: number): void;
    addPath(key: string, generator: IMovePathGenerator, override?: boolean): boolean;
    alive(): boolean;
    clearClickHandlers(): void;
    destroy(remove?: boolean): void;
    draw(force: boolean): void;
    export(type: string, options?: Record<string, unknown>): Promise<undefined | Blob>;
    handleClickMode(mode: string): void;
    init(): Promise<void>;
    loadTheme(name?: string): 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 (view full)

Properties

actualOptions addAbsorber canvas destroyed effectDrawers fpsLimit getAbsorber id interactivity pageHidden particles pathGenerators plugins retina shapeDrawers started zLayers

Accessors

animationStatus options sourceOptions

Methods

addClickHandler addLifeTime addPath alive clearClickHandlers destroy draw export handleClickMode init loadTheme pause play refresh reset start stop updateActualOptions

Properties

actualOptions

actualOptions: AbsorberOptions

addAbsorber

addAbsorber: ((options: RecursivePartial<IAbsorber>, position?: ICoordinates) => Promise<AbsorberInstance>)

Readonlycanvas

canvas: Canvas

destroyed

destroyed: boolean

ReadonlyeffectDrawers

effectDrawers: Map<string, IEffectDrawer<Particle>>

fpsLimit

fpsLimit: number

getAbsorber

getAbsorber: ((idxOrName?: string | number) => undefined | AbsorberInstance)

Readonlyid

id: symbol

interactivity

interactivity: IContainerInteractivity

pageHidden

pageHidden: boolean

Readonlyparticles

particles: Particles

ReadonlypathGenerators

pathGenerators: Map<string, IMovePathGenerator>

Readonlyplugins

plugins: Map<string, IContainerPlugin>

Readonlyretina

retina: Retina

ReadonlyshapeDrawers

shapeDrawers: Map<string, IShapeDrawer<Particle>>

started

started: boolean

zLayers

zLayers: number

Accessors

animationStatus

  • get animationStatus(): boolean

  • Returns boolean

options

  • get options(): Options

  • Returns Options

sourceOptions

Methods

addClickHandler

  • addClickHandler(callback): void

  • Parameters

    • callback: ((evt: Event, particles?: Particle[]) => void)
        • (evt, particles?): void

        • Parameters

          Returns void

    Returns void

addLifeTime

  • addLifeTime(value): void

  • Parameters

    • value: number

    Returns void

addPath

  • addPath(key, generator, override?): boolean

  • Parameters

    Returns boolean

alive

  • alive(): boolean

  • Returns boolean

clearClickHandlers

destroy

  • destroy(remove?): void

  • Parameters

    • Optionalremove: boolean

    Returns void

draw

  • draw(force): void

  • Parameters

    • force: boolean

    Returns void

export

  • export(type, options?): Promise<undefined | Blob>

  • Parameters

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

    Returns Promise<undefined | Blob>

handleClickMode

  • handleClickMode(mode): void

  • Parameters

    • mode: string

    Returns void

init

  • init(): Promise<void>

  • Returns Promise<void>

loadTheme

  • loadTheme(name?): Promise<void>

  • Parameters

    • Optionalname: string

    Returns Promise<void>

pause

  • pause(): void

  • Returns void

play

  • play(force?): void

  • Parameters

    • Optionalforce: boolean

    Returns void

refresh

  • refresh(): Promise<void>

  • Returns Promise<void>

reset

  • reset(sourceOptions?): Promise<void>

  • Parameters

    Returns Promise<void>

start

  • start(): Promise<void>

  • Returns Promise<void>

stop

  • stop(): void

  • Returns void

updateActualOptions

  • updateActualOptions(): boolean

  • Returns boolean

Settings

Member Visibility

On This Page

Properties
Accessors
Methods