Class OptionsColor

[[include:Color.md]]

Hierarchy (View Summary)

OptionsColor
- AnimatableColor

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

new OptionsColor(): OptionsColor
Returns OptionsColor
- Defined in Options/Classes/OptionsColor.ts:35

Properties

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<IRangeColor>): void
This load method is used to load data in the classes used as generic
Parameters
- Optionaldata: RecursivePartial<IRangeColor>
  the input options
Returns void
Implementation of IOptionLoader.load
- Defined in Options/Classes/OptionsColor.ts:64

`Static`create

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