Class Options

Implements

Indexable

[name: string]: unknown

Index

Constructors

constructor

new Options(engine, container): Options
Parameters
- engine: Engine
- container: Container
Returns Options
- Defined in engine/dist/types/Options/Classes/Options.d.ts:47

Properties

autoPlay

autoPlay: boolean

`Readonly`background

background: Background

`Readonly`backgroundMask

backgroundMask: BackgroundMask

clear

clear: boolean

defaultThemes

defaultThemes: DefaultThemes

delay

delay: RangeValue

detectRetina

detectRetina: boolean

duration

duration: RangeValue

fpsLimit

fpsLimit: number

`Readonly`fullScreen

fullScreen: FullScreen

`Readonly`interactivity

interactivity: Interactivity

`Optional`key

key?: string

manualParticles

manualParticles: ManualParticle[]

`Optional`name

name?: string

`Readonly`particles

particles: ParticlesOptions

pauseOnBlur

pauseOnBlur: boolean

pauseOnOutsideViewport

pauseOnOutsideViewport: boolean

`Optional`preset

preset?: SingleOrMultiple<string>

responsive

responsive: Responsive[]

smooth

smooth: boolean

style

style: RecursivePartial<CSSStyleDeclaration>

`Readonly`themes

themes: Theme[]

zLayers

zLayers: number

Methods

load

load(data?): void
Parameters
- Optionaldata: RecursivePartial<IOptions>
Returns void
Implementation of IOptionLoader.load
- Defined in engine/dist/types/Options/Classes/Options.d.ts:48

setResponsive

setResponsive(width, pxRatio, defaultOptions): undefined | number
Parameters
- width: number
- pxRatio: number
- defaultOptions: IOptions
Returns undefined | number
- Defined in engine/dist/types/Options/Classes/Options.d.ts:49

setTheme

setTheme(name?): void
Parameters
- Optionalname: string
Returns void
- Defined in engine/dist/types/Options/Classes/Options.d.ts:50