Ordered
The Ordered class represents a collection of tick values.
Constructors
new Ordered(order)
new Ordered(
order):Ordered
Constructs a new Ordered object.
Parameters
• order: OrderedData= {}
The initial tick values.
Returns
Source
Methods
changeComponent()
changeComponent(
id,key,tick):boolean
Changes the tick value of a component.
Parameters
• id: string
The ID of the component.
• key: string
The key of the component.
• tick: number
The new tick value.
Returns
boolean
Whether the operation was successful.
Source
reset()
reset(
order):void
Resets the tick values.
Parameters
• order: OrderedData= {}
The new tick values.
Returns
void
The Ordered object.
Source
upsertComponent()
upsertComponent(
id,key,tick):boolean
Inserts or updates the tick value of a component.
Parameters
• id: string
The ID of the component.
• key: string
The key of the component.
• tick: number
The new tick value.
Returns
boolean
Whether the operation was successful.
Source
Generated using typedoc-plugin-markdown and TypeDoc