Class ConfettiOptions

constructor

• new ConfettiOptions(): ConfettiOptions

  Creates a new ConfettiOptions instance with default values

  Returns ConfettiOptions

angle

colors

count

decay

disableForReducedMotion

drift

flat

gravity

position

scalar

shapeOptions

shapes

spread

startVelocity

ticks

zIndex

origin

• get origin(): ICoordinates

  Returns ICoordinates

  the origin of the confetti

  Deprecated

  use position instead

• set origin(value: ICoordinates): void

  Parameters

  • value: ICoordinates

  Returns void

  Deprecated

  use position instead

particleCount

• get particleCount(): number

  Returns number

  the number of particles

  Deprecated

  use count instead

• set particleCount(value: number): void

  Parameters

  • value: number

  Returns void

  Deprecated

  use count instead

load

• load(data?: RecursivePartial<IConfettiOptions>): void

  Loads confetti options from the provided data

  Parameters

  • Optionaldata: RecursivePartial<IConfettiOptions>

  Returns void