Flash CS3 Documentation

ActionScript 2.0 Language Reference > ActionScript classes > Array > slice (Array.slice method)

slice (Array.slice method)

Returns a new array that consists of a range of elements from the original array, without modifying the original array. The returned array includes the startIndex element and all elements up to, but not including, the endIndex element.

If you don't pass any parameters, a duplicate of the original array is created.

Availability: ActionScript 1.0; Flash Player 5

Parameters

startIndex:Number [optional] - A number specifying the index of the starting point for the slice. If start is a negative number, the starting point begins at the end of the array, where -1 is the last element.

endIndex:Number [optional] - A number specifying the index of the ending point for the slice. If you omit this parameter, the slice includes all elements from the starting point to the end of the array. If end is a negative number, the ending point is specified from the end of the array, where -1 is the last element.

Returns

Array - An array that consists of a range of elements from the original array.

Example

The following example creates an array of five pets and uses slice() to populate a new array that contains only four-legged pets:

var myPets_array:Array = new Array("cat", "dog", "fish", "canary", "parrot");
var myFourLeggedPets_array:Array = new Array();
var myFourLeggedPets_array = myPets_array.slice(0, 2);
trace(myFourLeggedPets_array); // Returns cat,dog.
trace(myPets_array); // Returns cat,dog,fish,canary,parrot.

The following example creates an array of five pets, and then uses slice() with a negative start parameter to copy the last two elements from the array:

var myPets_array:Array = new Array("cat", "dog", "fish", "canary", "parrot");
var myFlyingPets_array:Array = myPets_array.slice(-2);
trace(myFlyingPets_array); // Traces canary,parrot.

The following example creates an array of five pets and uses slice() with a negative end parameter to copy the middle element from the array:

var myPets_array:Array = new Array("cat", "dog", "fish", "canary", "parrot");
var myAquaticPets_array:Array = myPets_array.slice(2,-2);
trace(myAquaticPets_array); // Returns fish.

Flash CS3