Splice

From NSB App Studio
Jump to: navigation, search

Splice(array, index, howmany[, item])

Description

The splice() method adds/removes items to/from an array, and returns the removed item(s). This function changes the original array.

array: The name of an existing array.

index: An integer that specifies at what position to add/remove items, Use negative values to specify the position from the end of the array. Starts from 0.

howmany: The number of items to be removed. If set to 0, no items will be removed.

item: Optional. The new item(s) to be added to the array at index.

Example (Basic)

At position 2, remove 2 items:

fruits = ["Banana", "Orange", "Apple", "Mango"]
returnVal = Splice(fruits,2,2)
Print "Removed:", returnVal
Print "New value", fruits

'Add a new item
Splice(fruits,2,1,"Blueberry")
Print fruits

The result of fruits will be:

Removed: Apple,Mango
New value: Banana,Orange
Banana,Orange,BlueBerry

Example (JavaScript)

At position 2, remove 2 items:

var fruits = ["Banana", "Orange", "Apple", "Mango"];
fruits.splice(2,2);

The result of fruits will be:

Banana,Orange

Related Items

Array, Dim, LBound, Push, ReDim