Interface AbsorberContainer

interface AbsorberContainer {
    actualOptions: AbsorberOptions;
    addAbsorber: ((options, position?) => Promise<AbsorberInstance>);
    canvas: Canvas;
    destroyed: boolean;
    effectDrawers: Map<string, IEffectDrawer<Particle>>;
    fpsLimit: number;
    getAbsorber: ((idxOrName?) => 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): void;
    addLifeTime(value): void;
    addPath(key, generator, override?): boolean;
    alive(): boolean;
    destroy(): void;
    draw(force): void;
    export(type, options?): Promise<undefined | Blob>;
    handleClickMode(mode): void;
    init(): Promise<void>;
    loadTheme(name?): Promise<void>;
    pause(): void;
    play(force?): void;
    refresh(): Promise<void>;
    reset(): Promise<void>;
    start(): Promise<void>;
    stop(): void;
    updateActualOptions(): boolean;
}

Hierarchy

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 destroy draw export handleClickMode init loadTheme pause play refresh reset start stop updateActualOptions

Properties

actualOptions

actualOptions: AbsorberOptions

addAbsorber

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

Type declaration

Readonly canvas

canvas: Canvas

destroyed

destroyed: boolean

Readonly effectDrawers

effectDrawers: Map<string, IEffectDrawer<Particle>>

fpsLimit

fpsLimit: number

getAbsorber

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

Type declaration

Readonly id

id: symbol

interactivity

interactivity: IContainerInteractivity

pageHidden

pageHidden: boolean

Readonly particles

particles: Particles

Readonly pathGenerators

pathGenerators: Map<string, IMovePathGenerator>

Readonly plugins

plugins: Map<string, IContainerPlugin>

Readonly retina

retina: Retina

Readonly shapeDrawers

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, particles?) => void)
        • (evt, particles?): void

        • Parameters

          • evt: Event
          • Optional particles: Particle[]

          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

destroy

  • destroy(): void

  • Returns void

draw

  • draw(force): void

  • Parameters

    • force: boolean

    Returns void

export

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

  • Parameters

    • type: string
    • Optional options: 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

    • Optional name: string

    Returns Promise<void>

pause

  • pause(): void

  • Returns void

play

  • play(force?): void

  • Parameters

    • Optional force: boolean

    Returns void

refresh

  • refresh(): Promise<void>

  • Returns Promise<void>

reset

  • reset(): Promise<void>

  • Returns Promise<void>

start

  • start(): Promise<void>

  • Returns Promise<void>

stop

  • stop(): void

  • Returns void

updateActualOptions

  • updateActualOptions(): boolean

  • Returns boolean

Settings

Member Visibility

Theme

On This Page