| Package | Top Level |
| Class | public dynamic class Vector |
| Inheritance | Vector  Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
As with an Array, you can use the array access operator ([]) to
set or retrieve the value of a Vector element. Several Vector methods also
provide mechanisms for setting and retrieving element values. These include
push(), pop(), shift(), unshift(),
and others. The properties
and methods of a Vector object are similar — in most cases identical — to
the properties and methods of an Array. In most cases where you would use
an Array in which all the elements have the same data type, a Vector instance
is preferable. However, Vector instances are dense arrays, meaning it must have a value
(or null) in each index. Array instances
don't have this same restriction.
The Vector's base type is specified using postfix
type parameter syntax. Type parameter syntax is a sequence consisting of
a dot (.), left angle bracket (<), class name,
then a right angle bracket (>), as shown in this example:
In the first line of the example, the variable v is declared as a
Vector.<String> instance. In other words, it represents a Vector (an array)
that can only hold String instances and from which only String instances can be retrieved.
The second line constructs an instance of the same Vector type (that is, a
Vector whose elements are all String objects) and assigns it to v.
var v:Vector.<String>; v = new Vector.<String>();
A variable declared with the Vector.<T> data type can only store
a Vector instance that is constructed with the same base type
T. For example, a Vector that's constructed by calling
new Vector.<String>() can't be assigned to a variable
that's declared with the Vector.<int> data type. The base types must match exactly.
For example, the following code doesn't compile because the object's base type isn't
the same as the variable's declared base type (even though Sprite is a subclass of
DisplayObject):
// This code doesn't compile even though Sprite is a DisplayObject subclass var v:Vector.<DisplayObject> = new Vector.<Sprite>();
To convert a Vector with base type T to a Vector of a superclass of
T, use the Vector() global function.
In addition to the data type restriction, the Vector class has other restrictions that distinguish it from the Array class:
- A Vector is a dense array. Unlike an Array, which may have values in indices
0 and 7 even if there are no values in positions 1 through 6, a Vector must have
a value (or
null) in each index. - A Vector can optionally be fixed-length, meaning the number of elements it contains can't change.
- Access to a Vector's elements is bounds-checked. You can never read a value
from an index greater than the final element (
length - 1). You can never set a value with an index more than one beyond the current final index (in other words, you can only set a value at an existing index or at index[length]).
As a result of its restrictions, a Vector has three primary benefits over an Array instance whose elements are all instances of a single class:
- Performance: array element access and iteration are much faster when using a Vector instance than they are when using an Array.
- Type safety: in strict mode the compiler can identify data type errors. Examples
of data type errors include assigning a value of the incorrect data type to a Vector
or expecting the wrong data type when reading a value from a Vector.
Note, however, that when using the
push()method orunshift()method to add values to a Vector, the arguments' data types are not checked at compile time. Instead, they are checked at run time. - Reliability: runtime range checking (or fixed-length checking) increases reliability significantly over Arrays.
More examples
Creating a Vector instance
Inserting array elements
Retrieving values and removing array elements
Sorting an array
Querying an array
Arrays example: PlayList
Learn more
Basics of arrays
Indexed arrays
Associative arrays
Multidimensional arrays
Cloning arrays
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| fixed : Boolean
Indicates whether the length property of the Vector can
be changed. | Vector | ||
| length : uint
The range of valid indices available in the Vector. | Vector | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a Vector with the specified base type. | Vector | ||
Concatenates the Vectors specified in the parameters list with the elements
in this Vector and creates a new Vector. | Vector | ||
Executes a test function on each item in the Vector until an item is
reached that returns false for the specified function. | Vector | ||
Executes a test function on each item in the Vector and returns
a new Vector containing all items that return true for the
specified function. | Vector | ||
Executes a function on each item in the Vector. | Vector | ||
|
Indicates whether an object has a specified property defined. | Object | |
Searches for an item in the Vector and returns the index position of the item. | Vector | ||
Insert a single element into the Vector. | Vector | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Converts the elements in the Vector to strings, inserts the specified separator between the
elements, concatenates them, and returns the resulting string. | Vector | ||
Searches for an item in the Vector, working backward from the specified
index position, and returns the index position of the matching item. | Vector | ||
Executes a function on each item in the Vector, and returns a new Vector
of items corresponding to the results of calling the function on
each item in this Vector. | Vector | ||
pop():T
Removes the last element from the Vector and returns that element. | Vector | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
Adds one or more elements to the end of the Vector and returns
the new length of the Vector. | Vector | ||
Remove a single element from the Vector. | Vector | ||
Reverses the order of the elements in the Vector. | Vector | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
shift():T
Removes the first element from the Vector and returns that element. | Vector | ||
Returns a new Vector that consists of a range of elements from
the original Vector, without modifying the original Vector. | Vector | ||
Executes a test function on each item in the Vector until an
item is reached that returns true. | Vector | ||
Sorts the elements in the Vector object, and also returns a sorted Vector object. | Vector | ||
Adds elements to and removes elements from the Vector. | Vector | ||
Returns a string that represents the elements in the specified Vector. | Vector | ||
Returns a string that represents the elements in the Vector. | Vector | ||
Adds one or more elements to the beginning of the Vector and returns
the new length of the Vector. | Vector | ||
|
Returns the primitive value of the specified object. | Object | |
fixed | property |
fixed:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Indicates whether the length property of the Vector can
be changed. If the value is true, the length
property can't be changed. This means the following operations are not
allowed when fixed is true:
- setting the
lengthproperty directly - assigning a value to index position
length - calling a method that changes the
lengthproperty, including:pop()push()shift()unshift()splice()(if thesplice()call changes thelengthof the Vector).
Implementation
public function get fixed():Boolean public function set fixed(value:Boolean):voidlength | property |
length:uint| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
The range of valid indices available in the Vector.
A Vector instance has index positions up to but not including
the length value.
Every Vector element always has a value that is either an
instance of the base type or null. When the
length property is set to a value
that's larger than its previous value, additional elements are
created and populated with the default value appropriate to
the base type (null for reference types).
When the length property is set to a value
that's smaller than its previous value, all the elements
at index positions greater than or equal to the new length
value are removed from the Vector.
Implementation
public function get length():uint public function set length(value:uint):voidThrows
RangeError — If this property is changed
while fixed is true.
| |
RangeError — If this property is set to a value larger
than the maximum allowable index (232).
|
Vector | () | Constructor |
public function Vector(length:uint = 0, fixed:Boolean = false)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Creates a Vector with the specified base type.
When calling the Vector.<T>() constructor, specify the
base type using type parameter syntax. Type parameter syntax is a
sequence consisting of a dot (.), left angle bracket
(<), class name, then a right angle bracket
(>), as shown in this example:
var v:Vector.<String> = new Vector.<String>();
To create a Vector instance from an Array or another Vector (such as one with a different base type),
use the Vector() global function.
To create a pre-populated Vector instance, use the following syntax instead of using the parameters specified below:
// var v:Vector.<T> = new <T>[E0, ..., En-1 ,];
// For example:
var v:Vector.<int> = new <int>[0,1,2,];
The following information applies to this syntax:
- It is supported in Flash Professional CS5 and later, Flash Builder 4 and later, and Flex 4 and later.
- The trailing comma is optional.
- Empty items in the array are not supported; a statement such as
var v:Vector.<int> = new <int>[0,,2,]throws a compiler error. - You can't specify a default length for the Vector instance. Instead, the length is the same as the number of elements in the initialization list.
- You can't specify whether the Vector instance has a fixed length. Instead, use the
fixedproperty. - Data loss or errors can occur if items passed as values don't match the specified type. For example:
var v:Vector.<int> = new <int>[4.2]; // compiler error when running in strict mode
trace(v[0]); //returns 4 when not running in strict mode
length:uint (default = 0)null for reference types).
| |
fixed:Boolean (default = false)true) or
can be changed (false). This value can also be set using
the fixed property.
|
Related API Elements
concat | () | method |
AS3 function concat(... args):Vector.<T>| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Concatenates the Vectors specified in the parameters list with the elements in this Vector and creates a new Vector. The Vectors in the parameters list must have the same base type, or subtype, as this Vector. If you do not pass any parameters, the returned Vector is a duplicate (shallow clone) of the original Vector.
Parameters
... args — Zero or more Vectors of the base type, or subtype, of this Vector.
|
Vector.<T> — A Vector with the same base type as this Vector that contains
the elements from this Vector followed by elements from the Vectors
in the parameters list.
|
Throws
TypeError — If any argument is not a Vector of the base type,
or cannot be converted to a Vector of the base type.
|
More examples
every | () | method |
AS3 function every(callback:Function, thisObject:Object = null):Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Executes a test function on each item in the Vector until an item is
reached that returns false for the specified function.
You use this method to determine whether all items in a Vector meet
a criterion, such as having values less than a particular number.
For this method, the second parameter,
thisObject, must be null if the
first parameter, callback, is a method closure. That is
the most common way of using this method.
However, suppose you create a function on a frame on the main timeline using Flash Professional,
but you want it to be called in a different this context:
function myFunction(item:T, index:int, vector:Vector.<T>):Boolean {
// your code here
}
Suppose you then use the every()
method on a Vector called myVector:
myVector.every(myFunction, someObject);
Because myFunction is a member of the
main class of the SWF file, it cannot be executed in a different this context. Flash
runtimes throw an exception when this code runs. You can avoid this runtime error
by assigning the function to a variable, as follows:
var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):Boolean {
//your code here
};
myVector.every(myFunction, someObject);
Parameters
callback:Function — The function to run on each item in the Vector.
This function is invoked
with three arguments: the current item from the Vector, the index of the item,
and the Vector object:
function callback(item:T, index:int, vector:Vector.<T>):Boolean {
// your code here
}
The callback function should return a Boolean value. | |
thisObject:Object (default = null)this in the
callback function refers to when the function is called.
|
Boolean — A Boolean value of true if the specified function returns
true when called on all items in the Vector; otherwise, false.
|
Related API Elements
filter | () | method |
AS3 function filter(callback:Function, thisObject:Object = null):Vector.<T>| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Executes a test function on each item in the Vector and returns
a new Vector containing all items that return true for the
specified function. If an item returns false,
it is not included in the result Vector. The base type of the return
Vector matches the base type of the Vector on which the method is called.
For this method, the second parameter,
thisObject, must be null if the
first parameter, callback, is a method closure. That is
the most common way of using this method.
However, suppose you create a function on a frame on the main timeline using Flash Professional,
but you want it to be called in a different this context:
function myFunction(item:T, index:int, vector:Vector.<T>):Boolean {
// your code here
}
Suppose you then use the filter()
method on a Vector called myVector:
var result:Vector.<T> = myVector.filter(myFunction, someObject);
Because myFunction is a member of the
main class of the SWF file, it cannot be executed in a different this context. Flash
runtimes throw an exception when this code runs. You can avoid this runtime error
by assigning the function to a variable, as follows:
var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):Boolean {
//your code here
};
myVector.filter(myFunction, someObject);
Parameters
callback:Function — The function to run on each item in the Vector.
This function is invoked
with three arguments: the current item from the Vector, the index of the item,
and the Vector object:
function callback(item:T, index:int, vector:Vector.<T>):Boolean; | |
thisObject:Object (default = null)this in the
callback function refers to when the function is called.
|
Vector.<T> — A new Vector that contains all items from the original Vector
for which the callback function returned true.
|
Related API Elements
forEach | () | method |
AS3 function forEach(callback:Function, thisObject:Object = null):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Executes a function on each item in the Vector.
For this method, the second parameter,
thisObject, must be null if the
first parameter, callback, is a method closure. That is
the most common way of using this method.
However, suppose you create a function on a frame on the main timeline using Flash Professional,
but you want it to be called in a different this context:
function myFunction(item:T, index:int, vector:Vector.<T>):void {
// your code here
}
Suppose you then use the forEach()
method on a Vector called myVector:
myVector.forEach(myFunction, someObject);
Because myFunction is a member of the
main class of the SWF file, it cannot be executed in a different this context. Flash
runtimes throw an exception when this code runs. You can avoid this runtime error
by assigning the function to a variable, as follows:
var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):void {
//your code here
};
myVector.forEach(myFunction, someObject);
Parameters
callback:Function — The function to run on each item in the Vector.
This function is invoked
with three arguments: the current item from the Vector, the index of the item,
and the Vector object:
function callback(item:T, index:int, vector:Vector.<T>):void; Any return value from the function call is discarded. | |
thisObject:Object (default = null)this in the
callback function refers to when the function is called.
|
indexOf | () | method |
AS3 function indexOf(searchElement:T, fromIndex:int = 0):int| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Searches for an item in the Vector and returns the index position of the item.
The item is compared to the Vector elements using strict equality (===).
Parameters
searchElement:T — The item to find in the Vector.
| |
fromIndex:int (default = 0)length
+ fromIndex, meaning the search starts -fromIndex items
from the end and searches from that position forward to the end of the Vector.
|
int — A zero-based index position of the item in the Vector.
If the searchElement argument is not found,
the return value is -1.
|
Related API Elements
insertAt | () | method |
AS3 function insertAt(index:int, element:T):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 19, AIR 19 |
Insert a single element into the Vector. This method modifies the Vector without making a copy.
Parameters
index:int — An integer that specifies the position in the Vector
where the element is to be inserted. You can use a
negative integer to specify a position relative to the end of the Vector
(for example, -1 for the last element of the Vector).
| |
element:T |
Throws
RangeError — If this method is called while fixed is true.
|
join | () | method |
AS3 function join(sep:String = ","):String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Converts the elements in the Vector to strings, inserts the specified separator between the
elements, concatenates them, and returns the resulting string. A nested Vector is always
separated by a comma (,), not by the separator passed to the join() method.
Parameters
sep:String (default = ",") |
String — A string consisting of the elements of the Vector
converted to strings and separated by the specified string.
|
More examples
Related API Elements
lastIndexOf | () | method |
AS3 function lastIndexOf(searchElement:T, fromIndex:int = 0x7fffffff):int| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Searches for an item in the Vector, working backward from the specified
index position, and returns the index position of the matching item. The
item is compared to the Vector elements using strict equality (===).
Parameters
searchElement:T — The item to find in the Vector.
| |
fromIndex:int (default = 0x7fffffff)If this parameter is negative, it is treated as
|
int — A zero-based index position of the item in the Vector.
If the searchElement argument is not found,
the return value is -1.
|
Related API Elements
map | () | method |
AS3 function map(callback:Function, thisObject:Object = null):Vector.<T>| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Executes a function on each item in the Vector, and returns a new Vector
of items corresponding to the results of calling the function on
each item in this Vector. The result Vector has the same base
type and length as the original Vector.
The element at index i in the result Vector is the result of
the call on the element at index i in the original Vector.
For this method, the second parameter,
thisObject, must be null if the
first parameter, callback, is a method closure. That is
the most common way of using this method.
However, suppose you create a function on a frame on the main timeline, using Flash Professional
but you want it to be called in a different this context:
function myFunction(item:Object, index:int, vector:Vector.<T>):T {
// your code here
}
Suppose you then use the map()
method on a Vector called myVector:
myVector.map(myFunction, someObject);
Because myFunction is a member of the
main class of the SWF file, it cannot be executed in a different this context. Flash
runtimes throw an exception when this code runs. You can avoid this runtime error
by assigning the function to a variable, as follows:
var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):void {
//your code here
};
myVector.map(myFunction, someObject);
Parameters
callback:Function — The function to run on each item in the Vector.
This function is invoked
with three arguments: the current item from the Vector, the index of the item,
and the Vector object:
function callback(item:T, index:int, vector:Vector.<T>):T; | |
thisObject:Object (default = null)this in the
callback function refers to when the function is called.
|
Vector.<T> — A new Vector that contains the results of calling the function
on each item in this Vector. The result Vector has the same base type
and length as the original.
|
Related API Elements
pop | () | method |
AS3 function pop():T| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Removes the last element from the Vector and returns that element. The
length property of the Vector is decreased by one when
this function is called.
T — The value of the last element in the specified Vector.
|
Throws
RangeError — If this method is called while fixed is true.
|
More examples
Related API Elements
push | () | method |
AS3 function push(... args):uint| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Adds one or more elements to the end of the Vector and returns the new length of the Vector.
Because this function can accept multiple arguments, the data type of the arguments is not checked at compile time even in strict mode. However, if an argument is passed that is not an instance of the base type, an exception occurs at run time.
Parameters
... args — One or more values to append to the Vector.
|
uint — The length of the Vector after the new elements are added.
|
Throws
TypeError — If any argument is not an instance of the
base type T of the Vector.
| |
RangeError — If this method is called while fixed is true.
|
More examples
Related API Elements
removeAt | () | method |
AS3 function removeAt(index:int):T| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 19, AIR 19 |
Remove a single element from the Vector. This method modifies the Vector without making a copy.
Parameters
index:int — An integer that specifies the index of the element
in the Vector that is to be deleted. You can use a
negative integer to specify a position relative to the end of the Vector
(for example, -1 for the last element of the Vector).
|
T — The element that was removed from the original Vector.
|
Throws
RangeError — If the index
argument specifies an index to be deleted that's outside the Vector's bounds.
| |
RangeError — If this method is called while fixed is true.
|
reverse | () | method |
AS3 function reverse():Vector.<T>| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Reverses the order of the elements in the Vector. This method alters the Vector on which it is called.
ReturnsVector.<T> — The Vector with the elements in reverse order.
|
More examples
shift | () | method |
AS3 function shift():T| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Removes the first element from the Vector and returns that element. The remaining Vector elements are moved from their original position, i, to i - 1.
ReturnsT — The first element in the Vector.
|
Throws
RangeError — If fixed is true.
|
More examples
Related API Elements
slice | () | method |
AS3 function slice(startIndex:int = 0, endIndex:int = 16777215):Vector.<T>| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Returns a new Vector that consists of a range of elements from
the original Vector, without modifying the original Vector. The
returned Vector includes the startIndex element and
all elements up to, but not including, the endIndex element.
If you don't pass any parameters, the new Vector is a duplicate (shallow clone) of the original Vector. If you pass a value of 0 for both parameters, a new, empty Vector is created of the same type as the original Vector.
Parameters
startIndex:int (default = 0)startIndex is a negative number, the starting
point begins at the end of the Vector, where -1 is the last element.
| |
endIndex:int (default = 16777215)endIndex is a negative
number, the ending point is specified from the end of the Vector, where -1 is the
last element.
|
Vector.<T> — a Vector that consists of a range of elements from the original Vector.
|
More examples
some | () | method |
AS3 function some(callback:Function, thisObject:Object = null):Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Executes a test function on each item in the Vector until an
item is reached that returns true. Use this method
to determine whether any items in a Vector meet a criterion, such as
having a value less than a particular number.
For this method, the second parameter,
thisObject, must be null if the
first parameter, callback, is a method closure. That is
the most common way of using this method.
However, suppose you create a function on a frame on the main timeline,
but you want it to be called in a different this context:
function myFunction(item:Object, index:int, vector:Vector.<T>):Boolean {
// your code here
}
Suppose you then use the some()
method on a Vector called myVector:
myVector.some(myFunction, someObject);
Because myFunction is a member of the
main class of the SWF file, it cannot be executed in a different this context. Flash
runtimes throw an exception when this code runs. You can avoid this runtime error
by assigning the function to a variable, as follows:
var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):Boolean {
//your code here
};
myVector.some(myFunction, someObject);
Parameters
callback:Function — The function to run on each item in the Vector.
This function is invoked
with three arguments: the current item from the Vector, the index of the item,
and the Vector object:
function callback(item:T, index:int, vector:Vector.<T>):Boolean The callback function should return a Boolean value. | |
thisObject:Object (default = null)this in the
callback function refers to when the function is called.
|
Boolean — A Boolean value of true if any items in the Vector return
true for the specified function; otherwise, false.
|
Related API Elements
sort | () | method |
AS3 function sort(sortBehavior:*):Vector.<T>| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Sorts the elements in the Vector object, and also returns a sorted Vector object. This method sorts according to the parameter
sortBehavior, which is either a function that
compares two values, or a set of sorting options.
The method takes one parameter. The parameter is one of the following:
- a function that takes two arguments of the base type (
T) of the Vector and returns a Number:function compare(x:T, y:T):Number {}The logic of the function is that, given two elements
xandy, the function returns one of the following three values:- a negative number, if
xshould appear beforeyin the sorted sequence - 0, if
xequalsy - a positive number, if
xshould appear afteryin the sorted sequence
- a negative number, if
- a number which is a bitwise OR of the following values:
- 1 or
Array.CASEINSENSITIVE - 2 or
Array.DESCENDING - 4 or
Array.UNIQUESORT - 8 or
Array.RETURNINDEXEDARRAY - 16 or
Array.NUMERIC
If the value is 0, the sort works in the following way:
- Sorting is case-sensitive (Z precedes a).
- Sorting is ascending (a precedes b).
- The array is modified to reflect the sort order; multiple elements that have identical sort fields are placed consecutively in the sorted array in no particular order.
- All elements, regardless of data type, are sorted as if they were strings, so 100 precedes 99, because "1" is a lower string value than "9".
- 1 or
Parameters
sortBehavior:* — A Function or a Number value that determines the behavior
of the sort. A Function parameter specifies a comparison method.
A Number value specifies the sorting options.
|
Vector.<T> — A Vector object, with elements in the new order.
|
More examples
Related API Elements
splice | () | method |
AS3 function splice(startIndex:int, deleteCount:uint = 4294967295, ... items):Vector.<T>| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Adds elements to and removes elements from the Vector. This method modifies the Vector without making a copy.
Note: To override this method in a subclass of Vector,
use ...args for the parameters, as this example shows:
public override function splice(...args) {
// your statements here
}
Parameters
startIndex:int — An integer that specifies the index of the element
in the Vector where the insertion or deletion begins. You can use a
negative integer to specify a position relative to the end of the Vector
(for example, -1 for the last element of the Vector).
| |
deleteCount:uint (default = 4294967295)startIndex parameter.
If the value is 0, no elements are deleted.
| |
... items — An optional list of one or more comma-separated values
to insert into the Vector at the position specified in the startIndex parameter.
|
Vector.<T> — a Vector containing the elements that were removed from the original Vector.
|
Throws
RangeError — If the startIndex and deleteCount
arguments specify an index to be deleted that's outside the Vector's bounds.
| |
RangeError — If this method is called while fixed is true and the
splice() operation changes the length of the Vector.
|
More examples
toLocaleString | () | method |
public function toLocaleString():String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Returns a string that represents the elements in the specified Vector.
Every element in the Vector, starting with index 0 and ending with the
highest index, is converted to a concatenated string and separated by
commas. In the ActionScript 3.0 implementation, this method returns
the same value as the Vector.toString() method.
String — A string of Vector elements.
|
Related API Elements
toString | () | method |
public function toString():String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Returns a string that represents the elements in the Vector. Every element in the
Vector, starting with index 0 and ending with the highest index, is converted to a
concatenated string and separated by commas. To specify a custom separator,
use the Vector.join() method.
String — A string of Vector elements.
|
More examples
Related API Elements
unshift | () | method |
AS3 function unshift(... args):uint| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4 |
Adds one or more elements to the beginning of the Vector and returns the new length of the Vector. The other elements in the Vector are moved from their original position, i, to i + the number of new elements.
Because this function can accept multiple arguments, the data type of the arguments is not checked at compile time even in strict mode. However, if an argument is passed that is not an instance of the base type, an exception occurs at run time.
Parameters
... args — One or more instances of the base type of the Vector
to be inserted at the beginning of the Vector.
|
uint — An integer representing the new length of the Vector.
|
Throws
TypeError — If any argument is not an instance of the
base type T of the Vector.
| |
RangeError — If this method is called while fixed is true.
|
More examples
Related API Elements
Thu Dec 6 2018, 01:12 PM -08:00