Skip to content

ColorList

Implementation of List specifically for managing colors.

See

List for the base List implementation.

Extends

Constructors

Constructor

ts
new ColorList(): ColorList;

Returns

ColorList

Inherited from

List.constructor

Properties

_easeFunction

ts
protected _easeFunction: EaseFunction | null = null;

Inherited from

List._easeFunction


_first

ts
protected _first:
  | ListNode<RGBAColor>
  | null = null;

Inherited from

List._first


_isStepped

ts
protected _isStepped: boolean = false;

Inherited from

List._isStepped


_list

ts
protected _list: ListStep<string>[] = [];

Inherited from

List._list


interpolate()

ts
interpolate: (time) => number;

Function to interpolate values from the list.

Parameters

time

number

Returns

number

Interpolated value.

Throws

If the interpolate method has not been set.

Inherited from

List.interpolate

Accessors

first

Get Signature

ts
get first(): ListNode<ListDataType>;

First node in the list.

Throws

If the list has not been initialized.

Returns

ListNode<ListDataType>

Inherited from

List.first


isInitialized

Get Signature

ts
get isInitialized(): boolean;

Indicates whether the list has been initialized.

Returns

boolean

Inherited from

List.isInitialized


isStepped

Get Signature

ts
get isStepped(): boolean;

Indicates whether the list uses stepped interpolation.

Returns

boolean

Set Signature

ts
set isStepped(value): void;
Parameters
value

boolean

Returns

void

Inherited from

List.isStepped


list

Get Signature

ts
get list(): ListStep<InputValue>[];

Gets the list steps.

Returns

ListStep<InputValue>[]

Inherited from

List.list

Methods

initialize()

ts
initialize(data): void;

Initializes the list from data.

Parameters

data

ListData<string>

Data to initialize the list with.

Returns

void

Overrides

List.initialize


initializeList()

ts
protected initializeList(data): void;

Initializes the list from data.

Parameters

data

ListData<string>

Data to initialize the list with.

Returns

void

Overrides

List.initializeList


reset()

ts
reset(): void;

Resets the list to an uninitialized state.

Returns

void

Inherited from

List.reset