Class AnimatableColor

[[include:Options/Particles/Color.md]]

Hierarchy (View Summary)

OptionsColor
- AnimatableColor

Implements

Index

Constructors

Properties

animation value

Methods

Constructors

constructor

new AnimatableColor(): AnimatableColor
Returns AnimatableColor
Overrides OptionsColor.constructor
- Defined in Options/Classes/AnimatableColor.ts:17

Properties

animation

animation: HslAnimation

The color animation property

value

value: SingleOrMultiple<
    | SingleOrMultiple<string>
    | IRangeValueColor
    | IRangeRgb
    | IRangeHsl
    | IRangeHsv
    | IRangeHwb
    | IRangeLab
    | IRangeLch
    | IRangeOklab
    | IRangeOklch,
>

Color value, can be a single or an array of IValueColor, IRgb, IHsl or string

Methods

load

load(data?: RecursivePartial<IAnimatableColor>): void
This load method is used to load data in the classes used as generic
Parameters
- Optionaldata: RecursivePartial<IAnimatableColor>
  the input options
Returns void
Implementation of IOptionLoader.load
Overrides OptionsColor.load
- Defined in Options/Classes/AnimatableColor.ts:48

`Static`create

create(
source?: AnimatableColor,
data?: SingleOrMultiple<string> | RecursivePartial<IAnimatableColor>,
): AnimatableColor
Creates an animatable color from optional source and input data.
Parameters
- Optionalsource: AnimatableColor
  Existing color instance to clone from.
- Optionaldata: SingleOrMultiple<string> | RecursivePartial<IAnimatableColor>
  Color input data.
Returns AnimatableColor
A configured animatable color instance.
Overrides OptionsColor.create
- Defined in Options/Classes/AnimatableColor.ts:29