Array Helpers

ArrayAdd

Adds an element to an existing array.

Syntax: ArrayAdd(input, element)

Returns the input array.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
element	Dynamic	True

ArrayAny

Returns true if the array contains any element or an element matches a specific value.

Syntax: ArrayAny(input, [ value ])

Returns true if the input has any elements or if 'value' is defined when any of the elements matches the value.

Return type: Boolean

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
value	Dynamic	False

ArrayConcat

Concatenates two arrays.

Syntax: ArrayConcat(array1, array2)

Returns the concatenated array.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
array1	Dynamic	True
array2	Dynamic	True

ArrayContains

Returns true if the array contains any element or an element matches a specific value.

Syntax: ArrayContains(input, [ value ])

Returns true if the input has any elements or if 'value' is defined when any of the elements matches the value.

Return type: Boolean

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
value	Dynamic	False

ArrayDistinct

Returns a new list with only unique elements. In other words; removes all duplicates.

Syntax: ArrayDistinct(input)

Returns the unique values of the input.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True

ArrayFilter

Returns a new list with elements that only matches the value. Matching-rules specified by filterType.

Syntax: ArrayFilter(input, value, [ filterType ])

Returns the list.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
value	Dynamic	True
filterType	Enum	False	ArrayFilterInclusiveType,ArrayFilterExclusiveType,ArrayFilterLessThanType,ArrayFilterGreaterThanType

ArrayFind

Returns a new list of indices of the matching values. Matching-rules specified by filterType.

Syntax: ArrayFind(input, value, [ filterType ])

Returns the list.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
value	Dynamic	True
filterType	Enum	False	ArrayFilterInclusiveType,ArrayFilterExclusiveType,ArrayFilterLessThanType,ArrayFilterGreaterThanType

ArrayGet

Gets the value on a specific index. A negative index will take from the end of the array.

Syntax: ArrayGet(input, index)

Return the value on that index.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
index	Number	True	Input,Number,SessionGet

ArrayIndex

Gets the value on a specific index. A negative index will take from the end of the array.

Syntax: ArrayIndex(input, index)

Return the value on that index.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
index	Number	True	Input,Number,SessionGet

ArrayLast

Gets the last value of the array with an optional offset.

Syntax: ArrayLast(input, [ offset ])

Return the last value of the array taking the offset into account.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
offset	Number	False	Input,Number,SessionGet

ArrayPop

Remove an item from the end of an array.

Syntax: ArrayPop(input)

Returns the input array.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True

ArrayRemove

Removes an element from a specified index.

Syntax: ArrayRemove(input, index)

Returns the input array.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
index	Number	True	Input,Number,SessionGet

ArrayReplace

Replaces a specific value with another value.

Syntax: ArrayReplace(input, oldValue, newValue)

The input with replaced values.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
oldValue	Dynamic	True
newValue	Dynamic	True

ArrayShift

Remove an item from the beginning of an array.

Syntax: ArrayShift(input)

The input without the first value

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True

ArraySort

Sorts the array values in ascending or descending order.

Syntax: ArraySort(input, [ descending ])

Returns the sorted array.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
descending	Boolean	False	True,IsTrue,False,IsFalse,Or,Branch,Equals,IsBiggerThan,IsSmallerThan,IsBiggerOrSmallerThan,IsAnyOrderOpen,IsOrderFilled,IsOrderOpen,IsTradeAmountEnough

ArraySum

Computes the sum of the array. Can be used in combination with a list of numbers or container results like GetAllOpenOrders() or GetAllFinishedOrders().

Syntax: ArraySum(input, [ key ])

Returns the sum of the array.

Return type: Number

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
key	String	False

ArrayUnshift

Adds an element to the beginning of an array.

Syntax: ArrayUnshift(input, element)

The input with the element added in front of the array

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
element	Dynamic	True

Count

Gets the length of an array or the number of occurrences within the array of a specific value.

Syntax: Count(input, [ value ])

Returns the length of an array or the number of occurrences within the array of a specific value.

Return type: Number

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
value	Dynamic	False

Grab

Grabs a range from the array. If count is not set, return all after the offset.

Syntax: Grab(input, offset, [ count ])

Specified range from the array.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
offset	Number	True	Input,Number,SessionGet
count	Number	False	Input,Number,SessionGet

Offset

Gets an offset amount of the given array.

Syntax: Offset(input, offset)

Returns the given array with the offset amount of data removed from it.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
offset	Number	True	Input,Number,SessionGet

Range

Grabs a range from the array. If count is not set, return all after the offset.

Syntax: Range(input, offset, [ count ])

Specified range from the array.

Return type: Dynamic

Parameter Name	Parameter Type	Required	Suggestions
input	Dynamic	True
offset	Number	True	Input,Number,SessionGet
count	Number	False	Input,Number,SessionGet

SourceManager

Stores numeric values in a collection. Only adds the new value when the candle on the specified interval closed. This results in interval based data.

Syntax: SourceManager(newValue, [ interval ], [ cap ], [ initialValues ])

Returns the numeric collection.

Return type: ListNumbers

Parameter Name	Parameter Type	Required	Suggestions
newValue	Number	True
interval	Number	False	InputInterval,Number,CurrentInterval
cap	Number	False
initialValues	ListNumbers	False