Extends
Members
(readonly) count :int
The number of items in the OrderedList
- Inherited From:
- Type:
- int
- Source:
Methods
add(item, orderIDopt) → {ClassList}
Same as OrderedList's add method, but makes sure that every item can appear only once
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
item |
* | ||
orderID |
int |
<optional> |
- Overrides:
- Source:
Returns:
ClassListthis
addAfter(item, reference) → {OrderedList}
Adds an item to the OrderedList exactly after the given reference item
Parameters:
Name | Type | Description |
---|---|---|
item |
* | |
reference |
* |
- Inherited From:
- Source:
Returns:
OrderedListthis
addBefore(item, reference) → {OrderedList}
Adds an item to the OrderedList exactly before the given reference item
Parameters:
Name | Type | Description |
---|---|---|
item |
* | |
reference |
* |
- Inherited From:
- Source:
Returns:
OrderedListthis
all() → {Array}
Returns an array of all the items
- Inherited From:
- Source:
Returns:
Arrayclear() → {OrderedList}
Removes all items from the OrderedList
- Inherited From:
- Source:
Returns:
OrderedListthis
each(callback, thisArgopt) → {OrderedList}
Executes a provided callback function once per item in ascending order
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
function | ||
thisArg |
* |
<optional> |
- Inherited From:
- Source:
Returns:
OrderedListthis
execute(callback, thisArgopt) → (nullable) {*}
Executes a provided callback function once per item in descending, stops when the callback's return value is not undefined and returns
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
function | ||
thisArg |
* |
<optional> |
- Inherited From:
- Source:
Returns:
*first() → (nullable) {*}
Returns the first element of the lowest orderID
- Inherited From:
- Source:
Returns:
*firstID() → (nullable) {int}
Returns the lowest orderID of the OrderedList
- Inherited From:
- Source:
Returns:
intgetOrderOf(item) → (nullable) {int}
Returns the orderID of the given item
Parameters:
Name | Type | Description |
---|---|---|
item |
* |
- Inherited From:
- Source:
Returns:
intgetOrders() → {Array}
Returns an array of all the orderIDs in ascending order
- Inherited From:
- Source:
Returns:
Arrayhas(item) → {Boolean}
Checks if the OrderedList contains a specific item
Parameters:
Name | Type | Description |
---|---|---|
item |
* |
- Inherited From:
- Source:
Returns:
Booleanlast() → (nullable) {*}
Returns the last element of the highest orderID
- Inherited From:
- Source:
Returns:
*lastID() → (nullable) {int}
Returns the highest orderID of the OrderedList
- Inherited From:
- Source:
Returns:
intremove(item) → (nullable) {*}
Removes an item from the OrderedList
Parameters:
Name | Type | Description |
---|---|---|
item |
* |
- Inherited From:
- Source:
Returns:
*removed
reOrder(item, orderID) → {OrderedList}
Changes the place of the given item to the given order
Parameters:
Name | Type | Description |
---|---|---|
item |
* | |
orderID |
int |
- Inherited From:
- Source:
Returns:
OrderedListthis
toggle(item, orderIDopt) → {ClassList}
Toggles an item
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
item |
String | ||
orderID |
Number |
<optional> |
Returns:
ClassListthis
toString() → {String}
Returns the string value of the classList
- Overrides:
- Source: