Flash Lite 2 
Flash Lite 2.x ActionScript リファレンスガイド > ActionScript クラス > Array > sortOn (Array.sortOn メソッド)

sortOn (Array.sortOn メソッド)

public sortOn(fieldName: Object, [options: Object]) : Array

配列内のフィールド (複数のフィールドも可能) に基づいて、配列内のエレメントをソートします。配列は、次に示す特性を備えている必要があります。

fieldName パラメータを複数指定する場合、先頭のフィールドが第 1 ソートフィールド、2 番目のフィールドが第 2 ソートフィールド、(以下同様) と見なされます。ソートは Unicode 値に基づいて実行されます (ASCII は Unicode のサブセットです)。fieldName パラメータで指定されたフィールドが、比較対象のいずれのエレメントにも含まれていない場合、そのフィールドは undefined と見なされます。ソート済みの配列では、エレメントが連続的かつランダムに格納されます。

Array.sortOn() のデフォルトの動作は、次のようになります。

options パラメータを使用して、デフォルトのソート動作を上書きすることができます。単純な配列 (たとえば、1 つのフィールドだけを持つ配列) をソートする場合、または options パラメータでサポートされていないソート順序を指定する場合は、Array.sort() を使用します。

複数のフラグを渡すには、ビット単位の論理和 (OR) (|) 演算子で区切ります。

my_array.sortOn(someFieldName, Array.DESCENDING | Array.NUMERIC);

使用できるバージョン : ActionScript 1.0、Flash Lite 2.0

パラメータ

fieldName: Object - ソート値として使用するフィールドを指定するストリング、または、先頭のエレメントが第 1 ソートフィールド、2 番目が第 2 ソートフィールド、(以下同様) を表す配列。

options: Object (オプション) - ソート動作を変更する数値または定義済み定数の名前。複数指定する場合は、ビット単位の論理和 (OR) | 演算子で区切ります。options パラメータには次の値を指定できます。

数値形式 (2) ではなく、ストリング形式のフラグ (DESCENDING など) を使用すると、コードヒントが有効になります。

戻り値

Array - 戻り値は、次に示すように、指定されたパラメータによって異なります。

例

次の例では、新しい配列を作成し、その配列を name フィールドと city フィールドに基づいてソートします。最初の例では、第 1 ソート値に name を、第 2 ソート値に city を使用します。2 番目の例では、第 1 ソート値に city を、第 2 ソート値に name を使用します。 

var rec_array: Array = new Array();
rec_array.push({name: "john", city: "omaha", zip: 68144});
rec_array.push({name: "john", city: "kansas city", zip: 72345});
rec_array.push({name: "bob", city: "omaha", zip: 94010});
for(i=0; i<rec_array.length; i++){
    trace(rec_array[i].name + ", " + rec_array[i].city);
}
// 結果 : 
// john, omaha
// john, kansas city
// bob, omaha

rec_array.sortOn(["name", "city"]);
for(i=0; i<rec_array.length; i++){
    trace(rec_array[i].name + ", " + rec_array[i].city);
}
// 結果 : 
// bob, omaha
// john, kansas city
// john, omaha

rec_array.sortOn(["city", "name" ]);
for(i=0; i<rec_array.length; i++){
    trace(rec_array[i].name + ", " + rec_array[i].city);
}
// 結果 : 
// john, kansas city
// bob, omaha
// john, omaha

次の例では、オブジェクト配列を使用して、options パラメータの使用法を示します。

var my_array: Array = new Array();
my_array.push({password: "Bob", age: 29});
my_array.push({password: "abcd", age: 3});
my_array.push({password: "barb", age: 35});
my_array.push({password: "catchy", age: 4});

password フィールドに対してデフォルトのソートを実行すると、次の結果が生成されます。

my_array.sortOn("password");
// Bob
// abcd
// barb
// catchy

password フィールドに対して大文字と小文字を区別しないソートを実行すると、次の結果が生成されます。

my_array.sortOn("password", Array.CASEINSENSITIVE);
// abcd
// barb
// Bob
// catchy

password フィールドに対して、大文字と小文字を区別しない降順ソートを実行すると、次の結果が生成されます。

my_array.sortOn("password", Array.CASEINSENSITIVE | Array.DESCENDING);
// catchy
// Bob
// barb
// abcd

age フィールドに対してデフォルトのソートを実行すると、次の結果が生成されます。

my_array.sortOn("age");
// 29
// 3
// 35
// 4

age フィールドに対して数値ソートを実行すると、次の結果が生成されます。

my_array.sortOn("age", Array.NUMERIC);
// my_array[0].age = 3
// my_array[1].age = 4
// my_array[2].age = 29
// my_array[3].age = 35

age フィールドに対して数値の降順ソートを実行すると、次の結果が生成されます。

my_array.sortOn("age", Array.DESCENDING | Array.NUMERIC);
// my_array[0].age = 35
// my_array[1].age = 29
// my_array[2].age = 4
// my_array[3].age = 3

Array.RETURNEDINDEXARRAY ソートオプションを使用する場合は、別の配列に戻り値を代入する必要があります。元の配列は変更されません。

var indexArray: Array = my_array.sortOn("age", Array.RETURNINDEXEDARRAY);

関連項目

| ビット単位の論理和 (OR) 演算子, sort (Array.sort メソッド)