Interface Container

interface Container {
    actualOptions: Options;
    canvas: Canvas;
    destroyed: boolean;
    effectDrawers: Map<string, IEffectDrawer<Particle>>;
    fpsLimit: number;
    hdr: boolean;
    id: symbol;
    pageHidden: boolean;
    particles: Particles;
    pathGenerators: Map<string, IMovePathGenerator>;
    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;
    addPath(
        key: string,
        generator: IMovePathGenerator,
        override?: boolean,
    ): boolean;
    alive(): boolean;
    destroy(remove?: boolean): void;
    draw(force: boolean): void;
    export(
        type: string,
        options?: Record<string, unknown>,
    ): Promise<Blob | undefined>;
    init(): Promise<void>;
    pause(): void;
    play(force?: boolean): void;
    refresh(): Promise<void>;
    reset(sourceOptions?: RecursivePartial<IOptions>): Promise<void>;
    start(): Promise<void>;
    stop(): void;
    updateActualOptions(): boolean;
}

Index

Properties

actualOptions

actualOptions: Options

`Readonly`canvas

canvas: Canvas

destroyed

destroyed: boolean

`Readonly`effectDrawers

effectDrawers: Map<string, IEffectDrawer<Particle>>

fpsLimit

fpsLimit: number

hdr

hdr: boolean

`Readonly`id

id: symbol

pageHidden

pageHidden: boolean

`Readonly`particles

particles: Particles

`Readonly`pathGenerators

pathGenerators: Map<string, IMovePathGenerator>

`Readonly`plugins

plugins: 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
- Defined in engine/dist/types/Core/Container.d.ts:43

options

get options(): Options
Returns Options
- Defined in engine/dist/types/Core/Container.d.ts:44

sourceOptions

get sourceOptions(): RecursivePartial<IOptions> | undefined
Returns RecursivePartial<IOptions> | undefined
- Defined in engine/dist/types/Core/Container.d.ts:45

Methods

addLifeTime

addLifeTime(value: number): void
Parameters
- value: number
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:46

addPath

addPath(key: string, generator: IMovePathGenerator, override?: boolean): boolean
Parameters
- key: string
- generator: IMovePathGenerator
- Optionaloverride: boolean
Returns boolean
- Defined in engine/dist/types/Core/Container.d.ts:47

alive

alive(): boolean
Returns boolean
- Defined in engine/dist/types/Core/Container.d.ts:48

destroy

destroy(remove?: boolean): void
Parameters
- Optionalremove: boolean
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:49

draw

draw(force: boolean): void
Parameters
- force: boolean
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:50

export

export(
type: string,
options?: Record<string, unknown>,
): Promise<Blob | undefined>
Parameters
- type: string
- Optionaloptions: Record<string, unknown>
Returns Promise<Blob | undefined>
- Defined in engine/dist/types/Core/Container.d.ts:51

init

init(): Promise<void>
Returns Promise<void>
- Defined in engine/dist/types/Core/Container.d.ts:52

pause

pause(): void
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:53

play

play(force?: boolean): void
Parameters
- Optionalforce: boolean
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:54

refresh

refresh(): Promise<void>
Returns Promise<void>
- Defined in engine/dist/types/Core/Container.d.ts:55

reset

reset(sourceOptions?: RecursivePartial<IOptions>): Promise<void>
Parameters
- OptionalsourceOptions: RecursivePartial<IOptions>
Returns Promise<void>
- Defined in engine/dist/types/Core/Container.d.ts:56

start

start(): Promise<void>
Returns Promise<void>
- Defined in engine/dist/types/Core/Container.d.ts:57

stop

stop(): void
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:58

updateActualOptions

updateActualOptions(): boolean
Returns boolean
- Defined in engine/dist/types/Core/Container.d.ts:59