Built-In Namespace Array
| Method Attributes | Method Name and Description |
|---|---|
|
add(o, n)
Add object to the end of the array
|
|
|
contains(o)
Check to see if the object exists in the array using indexOf
|
|
|
copy()
Copy array.
|
|
|
indexOf(o)
Returns the index position of the object within the array
|
|
|
remove(o)
Remove Object.
|
|
|
removeAt(i)
Remove At index.
|
Method Detail
add(o, n)
Add object to the end of the array
Defined in: SS.core.js.
Defined in: SS.core.js.
- Parameters:
- {Object} o
- Object to add
- {Boolean} n
- (Optional) Node check. True to only add the object is if is not already a member of the array, or false to add the object to the end of the array without checking. Default = false.
- Returns:
- null
{Boolean}
contains(o)
Check to see if the object exists in the array using indexOf
Defined in: SS.core.js.
Defined in: SS.core.js.
- Parameters:
- {Object} o
- Object to check existence of
- Returns:
- {Boolean} true if object exists in the array, else false.
{Array}
copy()
Copy array. Return an identical copy of this array
Defined in: SS.core.js.
Defined in: SS.core.js.
- Returns:
- {Array} Copy of the array
{Integer}
indexOf(o)
Returns the index position of the object within the array
Defined in: SS.core.js.
Defined in: SS.core.js.
- Parameters:
- {Object} o
- Object to be found
- Returns:
- {Integer} Index position of the found object, or -1 if not found
{Object}
remove(o)
Remove Object. Removes object from the array and returns it
Defined in: SS.core.js.
Defined in: SS.core.js.
- Parameters:
- {Object} o
- Object to be removed
- Returns:
- {Object} Removed object if it exists in the array, else null.
{Object}
removeAt(i)
Remove At index. Removes object from the array at the specified index
Defined in: SS.core.js.
Defined in: SS.core.js.
- Parameters:
- {Integer} i
- Index of the object to remove where i >= 0 and i < array.length
- Returns:
- {Object} Removed object at the index point prior to removal.