Class: AxList

AxList(valuenon-null, numValuesnon-null)

new AxList(valuenon-null, numValuesnon-null)

Creates a new list of items
Parameters:
Name Type Description
value *
numValues Integer
Source:

Methods

Add(value) → {*}

Adds an item with the given value to the end of the list
Parameters:
Name Type Description
value * The value to add to the list
Source:
Returns:
The value which was added
Type
*

Clear()

Clears the list. This method only sets the items counter to 0, without actually erasing data. Further insertion operations will put new items in place of the old ones.
Source:

Contains(value) → {Boolean}

Returns whether the list contains at least one item of the given value
Parameters:
Name Type Description
value * The value of the item to look for
Source:
Returns:
True if there is at least one item if the given value in the list
Type
Boolean

Copy(values, numValues)

Copies a given number of items from anoher list
Parameters:
Name Type Description
values AxList | Array The AxList or Array to copy values from
numValues Integer The number of values to copy
Source:

Copy_2(offset, values, valuesOffset, numValues)

Copies a given number of items from anoher list
Parameters:
Name Type Description
offset Integer The offset index at which to start copying the values into the list
values AxList | Array The AxList or Array to copy values from
valuesOffset Integer The index offset at which to start copying from the source values
numValues Integer The number of values to copy
Source:

Count(value) → {Integer}

Returns the the number of occurences of the given value in the list
Parameters:
Name Type Description
value * The value of the item to count
Source:
Returns:
The number of occurences of the value in the list
Type
Integer

EnsureCapacity(capacity)

If necessary, sets such a capacity of the list, so that it will be able to hold at least the given number of items without need to allocate new memory
Parameters:
Name Type Description
capacity Integer The capacity to set for the list
Source:

Get(index) → {*}

Gets the value at the given index
Parameters:
Name Type Description
index Integer The index at which to get a value
Source:
Returns:
The value at the given index
Type
*

IndexOf(value) → {Integer}

Returns the index of the first encountered item with the given value. If such item is not present, the return value is AxList.ListIndex_NotFound
Parameters:
Name Type Description
value * The value of the item to search for
Source:
Returns:
The index of the item where the given value was first encountered. If no such item was found, return value is AxList.ListIndex_NotFound
Type
Integer

Insert(index, value) → {*}

Inserts an item with the given value at the specified index of the list
Parameters:
Name Type Description
index Integer Index at which to insert the new item
value * The value to insert into the list
Source:
Returns:
The value which was inserted
Type
*

InsertRange(index, values)

Inserts a number of items form another list at the specified index
Parameters:
Name Type Description
index Integer Index at which to insert the new items
values AxList | Array values to insert
Source:

LastIndexOf(value) → {Integer}

Returns the index of the last encountered item with the given value. If such item is not present, the return value is AxList.ListIndex_NotFound
Parameters:
Name Type Description
value * The value of the item to search for
Source:
Returns:
The index of the item where the given value was last encountered. If no such item was found, return value is AxList.ListIndex_NotFound
Type
Integer

Move(originalIndex, newIndex, count)

Moves items from their original position and inserts them on a new position, shifting the items between
Parameters:
Name Type Description
originalIndex Integer Original index at which the items to be moved begin
newIndex Integer New index at which the items are to be moved
count Integer Number of items to move
Source:

Remove(value) → {Boolean}

Removes the first encountered item of the given value. Returns true if an item was removed or false otherwise
Parameters:
Name Type Description
value * The value to be removed at first occuring item of the list
Source:
Returns:
True if an item with the given value was removed from the array
Type
Boolean

RemoveAll(value) → {Integer}

Removes all items of the given value. Returns the number of items removed
Parameters:
Name Type Description
value * The value to be removed from the items of the list
Source:
Returns:
The number of items removed
Type
Integer

RemoveAt(index)

Removes the item at the given index
Parameters:
Name Type Description
index Integer The index at which to remove an item
Source:

RemoveRange(index, count)

Removes a number of consequent items from the list, starting from the given index
Parameters:
Name Type Description
index Integer The index at which to remove the items
count Integer The number of items to remove
Source:

Set(index, value)

Sets the value at the given index
Parameters:
Name Type Description
index Integer The index at which to set a value
value * The value to set at the given index in the list
Source:

SetCapacity(newCapacity)

Sets the lists' capacity to hold the given number of items without need to allocate new memory The contents of the list are kept
Parameters:
Name Type Description
newCapacity Integer The new capacity to set for the list
Source:

SetSize(numElements)

Sets the size of the list to the number of items
Parameters:
Name Type Description
numElements Integer The size in number of items to set
Source:

Size() → {Integer}

Returns the number of items in the list
Source:
Returns:
The number of items in the list
Type
Integer

Documentation generated by JSDoc 3.5.3 on Wed Jan 17 2018 17:06:57 GMT+0200 (FLE Standard Time)