Class Container

constructor

• new Container(engine, id, sourceOptions?): Container

• Parameters

  • engine: Engine
  • id: string
  • OptionalsourceOptions: RecursivePartial<IOptions>

  Returns Container

actualOptions

Readonlycanvas

destroyed

ReadonlyeffectDrawers

fpsLimit

Readonlyid

interactivity

pageHidden

Readonlyparticles

ReadonlypathGenerators

Readonlyplugins

Readonlyretina

ReadonlyshapeDrawers

started

zLayers

animationStatus

• get animationStatus(): boolean

• Returns boolean

options

• get options(): Options

• Returns Options

sourceOptions

• get sourceOptions(): undefined | RecursivePartial<IOptions>

• Returns undefined | RecursivePartial<IOptions>

addClickHandler

• addClickHandler(callback): void

• Parameters

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

      • Parameters

        • evt: Event
        • Optionalparticles: Particle[]

        Returns void

  Returns void

addLifeTime

• addLifeTime(value): void

• Parameters

  • value: number

  Returns void

addPath

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

• Parameters

  • key: string
  • generator: IMovePathGenerator
  • Optionaloverride: boolean

  Returns boolean

alive

• alive(): boolean

• Returns boolean

clearClickHandlers

• clearClickHandlers(): void

• Returns void

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

  • OptionalsourceOptions: RecursivePartial<IOptions>

  Returns Promise<void>

start

• start(): Promise<void>

• Returns Promise<void>

stop

• stop(): void

• Returns void

updateActualOptions

• updateActualOptions(): boolean

• Returns boolean