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

配列のエレメントを追加および削除します。このメソッドは、コピーを作成しないで、配列を変更します。

パラメータ

startIndex:Number - 挿入または削除を開始する配列エレメントのインデックスを示す整数。負の整数を指定すると、配列の末尾を基準として位置を指定できます (たとえば、-1 は配列の最後のエレメントです)。

deleteCount:Number (オプション) - 削除するエレメント数を示す整数。この数には、startIndex パラメータで指定するエレメントが含まれます。deleteCount パラメータに値を指定しないと、メソッドにより配列の startIndex エレメントから最後のエレメントまでの値がすべて削除されます。値として 0 を指定すると、エレメントは削除されません。

value:Object (オプション) - startIndex パラメータで指定した配列の挿入箇所に挿入する値を指定します。

戻り値

Array - 元の配列から削除したエレメントが含まれる配列。

例

次の例では、配列を 1 つ作成し、splice メソッドの startIndex パラメータにエレメントインデックス 1 を使用してスプライスします。これにより、2 番目以降のすべてのエレメントが配列から削除され、元の配列にはインデックス 0 だけが残ります。

var myPets_array:Array = new Array("cat", "dog", "bird", "fish");
trace( myPets_array.splice(1) ); // dog,bird,fish を表示します。
trace( myPets_array ); // cat

次の例では、配列を 1 つ作成し、splice メソッドの startIndex パラメータにエレメントインデックス 1 を、deleteCount パラメータに数値 2 を使用してスプライスします。これにより、2 番目以降の 2 つのエレメントが配列から削除され、元の配列には最初と最後のエレメントだけが残ります。

var myFlowers_array:Array = new Array("roses", "tulips", "lilies", "orchids");
trace( myFlowers_array.splice(1,2 ) ); // tulips,lilies を表示します。
trace( myFlowers_array ); // roses,orchids

次の例では、配列を 1 つ作成し、splice メソッドの startIndex パラメータにエレメントインデックス 1 を、deleteCount パラメータに数値 0 を、value パラメータにストリング chair 使用してスプライスします。この場合、元の配列からは何も削除されず、ストリング chair がインデックス 1 に追加されます。

var myFurniture_array:Array = new Array("couch", "bed", "desk", "lamp");
trace( myFurniture_array.splice(1,0, "chair" ) ); // 空の配列を表示します。 
trace( myFurniture_array ); // couch,chair,bed,desk,lamp を表示します