Class Container

constructor

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

• This is the core class, create an instance to have a new working particles manager

  Parameters

  • engine: Engine

    the engine used by container

  • id: string

    the id to identify this instance

  • Optional sourceOptions: RecursivePartial<IOptions>

    the options to load

  Returns Container

actualOptions

Readonly canvas

destroyed

Readonly drawers

fpsLimit

Readonly id

interactivity

Optional lastFrameTime

pageHidden

Readonly particles

pathGenerators

Readonly plugins

Optional responsiveMaxWidth

Readonly retina

smooth

started

zLayers

options

• get options(): Options

• The options used by the container, it's a full Options object

  Returns Options

  the options used by the container

sourceOptions

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

• The options that were initially passed to the container

  Returns undefined | RecursivePartial<IOptions>

  the source options passed to the container

addClickHandler

• addClickHandler(callback): void

• Adds a click handler to the container

  Parameters

  • callback: ((evt, particles?) => void)

    the callback to be called when the click event occurs

    • • (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

• Add a new path generator to the container

  Parameters

  • key: string

    the key to identify the path generator

  • Optional generator: IMovePathGenerator

    the path generator

  • override: boolean = false

    if true, override the existing path generator

  Returns boolean

  true if the path generator was added, false otherwise

alive

• alive(): boolean

• Returns boolean

destroy

• destroy(): void

• Destroys the current container, invalidating it

  Returns void

draw

• draw(force): void

• Draws a frame

  Parameters

  • force: boolean

  Returns void

export

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

• Parameters

  • type: string

  • options: Record<string, unknown> = {}

  Returns Promise<undefined | Blob>

getAnimationStatus

• getAnimationStatus(): boolean

• Gets the animation status

  Returns boolean

  true is playing, false is paused

handleClickMode

• handleClickMode(mode): void

• Handles click event in the container

  Parameters

  • mode: string

    click mode to handle

  Returns void

init

• init(): Promise<void>

• Initializes the container

  Returns Promise<void>

loadTheme

• loadTheme(name?): Promise<void>

• Loads the given theme, overriding the options

  Parameters

  • Optional name: string

    the theme name, if undefined resets the default options or the default theme

  Returns Promise<void>

pause

• pause(): void

• Pauses animations

  Returns void

play

• play(force?): void

• Starts animations and resume from pause

  Parameters

  • Optional force: boolean

  Returns void

refresh

• refresh(): Promise<void>

• Restarts the container, just a Container.stop/Container.start alias

  Returns Promise<void>

  the Promise of the start method

reset

• reset(): Promise<void>

• Returns Promise<void>

setNoise

• setNoise(noiseOrGenerator?, init?, update?): void

• Customise path generation

  Parameters

  • Optional noiseOrGenerator: IMovePathGenerator | ((particle) => Vector)

    the IMovePathGenerator object or a function that generates a Vector object from Particle

  • Optional init: (() => void)

    the IMovePathGenerator init function, if the first parameter is a generator function

    • • (): void

      • Returns void

  • Optional update: (() => void)

    the IMovePathGenerator update function, if the first parameter is a generator function

    • • (): void

      • Returns void

  Returns void

  Deprecated

  Use the new setPath

setPath

• setPath(pathOrGenerator?, init?, update?): void

• Customise path generation

  Parameters

  • Optional pathOrGenerator: IMovePathGenerator | ((particle) => Vector)

    the IMovePathGenerator object or a function that generates a Vector object from Particle

  • Optional init: (() => void)

    the IMovePathGenerator init function, if the first parameter is a generator function

    • • (): void

      • Returns void

  • Optional update: (() => void)

    the IMovePathGenerator update function, if the first parameter is a generator function

    • • (): void

      • Returns void

  Returns void

  Deprecated

  Use the new addPath

start

• start(): Promise<void>

• Starts the container, initializes what are needed to create animations and event handling

  Returns Promise<void>

stop

• stop(): void

• Stops the container, opposite to start. Clears some resources and stops events.

  Returns void

updateActualOptions

• updateActualOptions(): boolean

• Updates the container options

  Returns boolean

  true if the options were updated, false otherwise