Class Container

Hierarchy

Container

Constructors

constructor

new Container(engine, id, sourceOptions?): Container
Parameters
- engine: Engine
- id: string
- Optional sourceOptions: RecursivePartial<IOptions>
Returns Container
- Defined in engine/dist/types/Core/Container.d.ts:46

Properties

`Private` `Optional` _currentTheme

_currentTheme?: any

`Private` _delay

_delay: any

`Private` `Optional` _delayTimeout

_delayTimeout?: any

`Private` `Optional` _drawAnimationFrame

_drawAnimationFrame?: any

`Private` _duration

_duration: any

`Private` `Readonly` _engine

_engine: any

`Private` `Readonly` _eventListeners

_eventListeners: any

`Private` _firstStart

_firstStart: any

`Private` _initialSourceOptions

_initialSourceOptions: any

`Private` `Readonly` _intersectionManager

_intersectionManager: any

`Private` `Readonly` _intersectionObserver

_intersectionObserver: any

`Private` _lifeTime

_lifeTime: any

`Private` `Readonly` _nextFrame

_nextFrame: any

`Private` _options

_options: any

`Private` _paused

_paused: any

`Private` _sourceOptions

_sourceOptions: any

actualOptions

actualOptions: Options

`Readonly` canvas

canvas: Canvas

destroyed

destroyed: boolean

`Readonly` drawers

drawers: Map<string, IShapeDrawer>

fpsLimit

fpsLimit: number

`Readonly` id

id: string

interactivity

interactivity: IContainerInteractivity

`Optional` lastFrameTime

lastFrameTime?: number

pageHidden

pageHidden: boolean

`Readonly` particles

particles: Particles

pathGenerators

pathGenerators: Map<string, IMovePathGenerator>

`Readonly` plugins

plugins: Map<string, IContainerPlugin>

`Optional` responsiveMaxWidth

responsiveMaxWidth?: number

`Readonly` retina

retina: Retina

smooth

smooth: boolean

started

started: boolean

zLayers

zLayers: number

Accessors

options

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

sourceOptions

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

Methods

addClickHandler

addClickHandler(callback): void
Parameters
- callback: ((evt, particles?) => void)
  - - (evt, particles?): void
    - Parameters
      
      evt: Event
      
      Optional particles: Particle[]
      
      Returns void
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:49

addLifeTime

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

addPath

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

alive

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

destroy

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

draw

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

export

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

getAnimationStatus

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

handleClickMode

handleClickMode(mode): void
Parameters
- mode: string
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:57

init

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

loadTheme

loadTheme(name?): Promise<void>
Parameters
- Optional name: string
Returns Promise<void>
- Defined in engine/dist/types/Core/Container.d.ts:59

pause

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

play

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

refresh

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

reset

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

setNoise

setNoise(noiseOrGenerator?, init?, update?): void
Parameters
- Optional noiseOrGenerator: IMovePathGenerator | ((particle) => Vector)
- Optional init: (() => void)
  - - (): void
    - Returns void
- Optional update: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:64

setPath

setPath(pathOrGenerator?, init?, update?): void
Parameters
- Optional pathOrGenerator: IMovePathGenerator | ((particle) => Vector)
- Optional init: (() => void)
  - - (): void
    - Returns void
- Optional update: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in engine/dist/types/Core/Container.d.ts:65

start

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

stop

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

updateActualOptions

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

Class Container

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

engine: Engine

id: string

Optional sourceOptions: RecursivePartial<IOptions>

Returns Container

Properties

Private Optional _currentTheme

Private _delay

Private Optional _delayTimeout

Private Optional _drawAnimationFrame

Private _duration

Private Readonly _engine

Private Readonly _eventListeners

Private _firstStart

Private _initialSourceOptions

Private Readonly _intersectionManager

Private Readonly _intersectionObserver

Private _lifeTime

Private Readonly _nextFrame

Private _options

Private _paused

Private _sourceOptions

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

Accessors

options

Returns Options

sourceOptions

Returns undefined | RecursivePartial<IOptions>

Methods

addClickHandler

Parameters

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

Parameters

evt: Event

Optional particles: Particle[]

Returns void

Returns void

addLifeTime

Parameters

value: number

Returns void

addPath

Parameters

key: string

Optional generator: IMovePathGenerator

Optional override: boolean

Returns boolean

alive

Returns boolean

destroy

Returns void

draw

Parameters

force: boolean

Returns void

`Optional` sourceOptions: RecursivePartial<IOptions>

`Private` `Optional` _currentTheme

`Private` _delay

`Private` `Optional` _delayTimeout

`Private` `Optional` _drawAnimationFrame

`Private` _duration

`Private` `Readonly` _engine

`Private` `Readonly` _eventListeners

`Private` _firstStart

`Private` _initialSourceOptions

`Private` `Readonly` _intersectionManager

`Private` `Readonly` _intersectionObserver

`Private` _lifeTime

`Private` `Readonly` _nextFrame

`Private` _options

`Private` _paused

`Private` _sourceOptions

`Readonly` canvas

`Readonly` drawers

`Readonly` id

`Optional` lastFrameTime

`Readonly` particles

`Readonly` plugins

`Optional` responsiveMaxWidth

`Readonly` retina

`Optional` particles: Particle[]

`Optional` generator: IMovePathGenerator

`Optional` override: boolean

`Optional` options: Record<string, unknown>

`Optional` name: string

`Optional` force: boolean

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

`Optional` init: (() => void)

`Optional` update: (() => void)

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

`Optional` init: (() => void)

`Optional` update: (() => void)