Class OutModes

Out modes options class [[include:Options/Particles/OutModes.md]]

Hierarchy (View Summary)

OptionLoader<IOutModes>
- OutModes

Implements

IOutModes

Index

Constructors

Properties

bottom? default left? right? top?

Methods

Constructors

constructor

new OutModes(): OutModes
Returns OutModes
Inherited from OptionLoader.constructor

Properties

`Optional`bottom

bottom?: "none" | "bounce" | "out" | "destroy" | "split" | OutMode

Out mode for the bottom edge

default

default: "none" | "bounce" | "out" | "destroy" | "split" | OutMode = OutMode.out

Default out mode used when per-edge modes are not set

`Optional`left

left?: "none" | "bounce" | "out" | "destroy" | "split" | OutMode

Out mode for the left edge

`Optional`right

right?: "none" | "bounce" | "out" | "destroy" | "split" | OutMode

Out mode for the right edge

`Optional`top

top?: "none" | "bounce" | "out" | "destroy" | "split" | OutMode

Out mode for the top edge

Methods

`Protected`doLoad

doLoad(data: RecursivePartial<IOutModes>): void
Loads out modes from the given data
Parameters
- data: RecursivePartial<IOutModes>
  The data to handle
Returns void
Overrides OptionLoader.doLoad
- Defined in Options/Classes/Particles/Move/OutModes.ts:26

load

load(data?: RecursivePartial<IOutModes>): void
This load method is used to load data in the classes used as generic
Parameters
- Optionaldata: RecursivePartial<IOutModes>
  the input options
Returns void
Inherited from OptionLoader.load
- Defined in Utils/OptionLoader.ts:6