splice (méthode Array.splice)

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

Ajoute et supprime des éléments dans un tableau. Cette méthode modifie le tableau sans faire de copie.

Disponibilité : ActionScript 1.0 ; Flash Lite 2.0

Paramètres

startIndex:Number - Un entier spécifiant l'index de la position d'insertion ou de suppression de l'élément dans le tableau. Vous pouvez spécifier un entier négatif pour définir une position par rapport à la fin du tableau (par exemple, la valeur -1 représente le dernier élément du tableau).

deleteCount:Number [facultatif] - Un entier spécifiant le nombre d'éléments à supprimer. Ce nombre inclut l'élément spécifié dans le paramètre startIndex. Si aucune valeur n'est spécifiée pour le paramètre deleteCount, la méthode supprime toutes les valeurs comprises entre l'élément startIndex et le dernier élément du tableau. Si la valeur est 0, aucun élément n'est supprimé.

value:Object [facultatif] - Spécifie les valeurs à insérer dans le tableau au point d'insertion défini dans le paramètre startIndex.

Valeur renvoyée

Array - Un tableau contenant les éléments supprimés du tableau original.

Exemple

L'exemple suivant crée un tableau et le relie à l'aide de l'élément index 1 pour le paramètre startIndex. Tous les éléments du tableau à partir du deuxième élément sont ainsi supprimés : seul l'élément à l'index 0 est conservé dans le tableau d'origine :

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

L'exemple suivant crée un tableau et le relie à l'aide de l'élément index 1 pour le paramètre startIndex et du nombre 2 pour le paramètre deleteCount. Deux éléments du tableau à partir du deuxième élément sont ainsi supprimés : seuls les premier et dernier éléments sont conservés dans le tableau d'origine :

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

L'exemple suivant crée un tableau et le relie à l'aide de l'élément index 1 pour le paramètre startIndex, du nombre 0 pour le paramètre deleteCount et de la chaîne chair pour le paramètre value. Aucun élément n'est supprimé du tableau d'origine et la chaîne chair est ajoutée à l'index 1 :

var myFurniture_array:Array = new Array("couch", "bed", "desk", "lamp");
trace( myFurniture_array.splice(1,0, "chair" ) ); // Affiche un tableau vide. 
trace( myFurniture_array ); // Affiche couch,chair,bed,desk,lamp