splice (Array.splice-Methode)

public splice(startIndex:Number, [deleteCount:Number], [value:Object]) : Array

Fügt einem Array Elemente hinzu bzw. entfernt diese. Bei dieser Methode werden Änderungen am Array vorgenommen, ohne eine Kopie zu erstellen.

Parameter

startIndex:Number - Eine Ganzzahl, die die Indexposition des Array-Elements angibt, an der der Einfüge- oder Löschvorgang beginnt. Sie können hier negative Ganzzahlen verwenden, um eine Position am Ende des Arrays anzugeben (so ist -1 das letzte Element des Arrays).

deleteCount:Number [optional] - Eine Ganzzahl, die die Anzahl der zu löschenden Elemente angibt. Diese Zahl schließt das im startIndex-Parameter angegebene Element ein. Wenn kein Wert für deleteCount angegeben ist, löscht die Methode alle Werte von startIndex bis zum letzten Array-Element. Wenn der Wert 0 lautet, werden keine Elemente gelöscht.

value:Object [optional] - Gibt die Werte an, die in das Array ab einem bestimmten vom startIndex-Parameter angegebenen Punkt eingefügt werden sollen.

Rückgabewerte

Array - Ein Array, das die aus dem ursprünglichen Array entfernten Elemente enthält.

Beispiel

Im folgenden Beispiel wird ein Array erstellt, aus dem mithilfe des Elementindex 1 als startIndex-Parameter Elemente herausgeschnitten werden sollen. Hierbei werden alle Elemente des Arrays nach dem ersten Element gelöscht, sodass nur das Element mit dem Index 0 im ursprünglichen Array verbleibt:

var myPets_array:Array = new Array("cat", "dog", "bird", "fish");
trace( myPets_array.splice(1) ); // Anzeige: dog,bird,fish
trace( myPets_array ); // cat

Im folgenden Beispiel wird ein Array erstellt, aus dem mithilfe des Elementindex 1 als startIndex-Parameter und der Zahl 2 als deleteCount-Parameter Elemente herausgeschnitten werden sollen. Hierbei werden die beiden auf das erste Element folgenden Elemente des Arrays gelöscht, sodass nur das erste und das letzte Element im ursprünglichen Array verbleiben:

var myFlowers_array:Array = new Array("roses", "tulips", "lilies", "orchids");
trace( myFlowers_array.splice(1,2 ) ); // Anzeige: tulips,lilies
trace( myFlowers_array ); // roses,orchids

Im folgenden Beispiel wird ein Array erstellt, aus dem mithilfe des Elementindex 1 als startIndex-Parameter, der Zahl 0 als deleteCount-Parameter und dem String chair als value-Parameter Elemente herausgeschnitten werden sollen. Hierbei werden keine Elemente aus dem ursprünglichen Array gelöscht, dafür wird der String chair mit dem Index 1 hinzugefügt:

var myFurniture_array:Array = new Array("couch", "bed", "desk", "lamp");
trace( myFurniture_array.splice(1,0, "chair" ) ); // Anzeige: leeres Array 
trace( myFurniture_array ); // Anzeige: couch,chair,bed,desk,lamp