Class Options

constructor

• new Options(engine, container): Options

• Parameters

  • engine: Engine

  • container: Container

  Returns Options

autoPlay

background

backgroundMask

defaultThemes

delay

detectRetina

duration

fpsLimit

fullScreen

interactivity

manualParticles

Optional name

particles

pauseOnBlur

pauseOnOutsideViewport

Optional preset

responsive

smooth

style

themes

zLayers

backgroundMode

• get backgroundMode(): FullScreen

• Returns FullScreen

• set backgroundMode(value): void

• Parameters

  • value: FullScreen

  Returns void

fps_limit

• get fps_limit(): number

• Returns number

• set fps_limit(value): void

• Parameters

  • value: number

  Returns void

retina_detect

• get retina_detect(): boolean

• Returns boolean

• set retina_detect(value): void

• Parameters

  • value: boolean

  Returns void

load

• load(data?): void

• Parameters

  • Optional data: RecursivePartial<IOptions>

  Returns void

setResponsive

• setResponsive(width, pxRatio, defaultOptions): undefined | number

• Parameters

  • width: number

  • pxRatio: number

  • defaultOptions: IOptions

  Returns undefined | number

setTheme

• setTheme(name?): void

• Parameters

  • Optional name: string

  Returns void