ソート時にアイテムを比較するために使用するメソッドです。 このプロパティを指定すると、このクラスで使用する SortField オブジェクトに指定した compareFunction プロパティはすべて無視されます。

比較関数には次のシグネチャが必要です。

         function [name](a:Object, b:Object, fields:Array=null):int

この関数は、以下を返す必要があります。

• a が b の前に現れるソート順の場合は -1 です。
• a が b の場合は 0。
• a が b の後に表示されるソート順の場合は 1 です。

内部比較関数に戻すには、この値を null に設定します。

fields 配列は、比較するオブジェクトフィールドを指定します。 通常は、フィールドリストを使い果たすか、ゼロではない値が返されるまで、このアルゴリズムはプロパティを比較します。 次に実際の使用例を示します。

        function myCompare(a:Object, b:Object, fields:Array=null):int
        {
            var result:int = 0;
            var i:int = 0;
            var propList:Array = fields ? fields : internalPropList;
            var len:int = propList.length;
            var propName:String;
            while (result == 0 && (i < len))
            {
                propName = propList[i];
                result = compareValues(a[propName], b[propName]);
                i++;
            }
            return result;
        }
             function compareValues(a:Object, b:Object):int
        {
            if (a == null && b == null)
                return 0;
                 if (a == null)
              return 1;
                 if (b == null)
               return -1;
                 if (a < b)
                return -1;
                 if (a > b)
                return 1;
                 return 0;
        }

デフォルト値は、ストリング、数値、日付を比較できる内部比較関数です。この比較関数では、昇順または降順での比較が可能で、ストリングの比較に関しては大文字と小文字の区別の有無を指定できます。 カスタム比較アルゴリズムが必要な場合にのみ、独自の関数を指定します。 このことは、通常、計算フィールドが表示で使用される場合にのみ該当します。

また、SortField クラスの compare プロパティを使用することで、各ソートフィールドに対して個別の比較関数を指定することもできます。 こうすれば、一部のフィールドにデフォルトの比較関数を適用し、別のフィールドには独自の比較関数を適用することが可能となります。

データのグループ化に使用するフィールドを指定する GroupingField オブジェクトの配列です。 配列内の GroupingField オブジェクトの順序によって、ソート時のフィールドの優先順位が決まります。

デフォルト値 : null.

関連項目

グループ化オブジェクトを決定するために、各グループノードで実行されるコールバック関数です。 デフォルトでは、新しいオブジェクトはグループノード用に作成されます。

グループノードに適切なオブジェクトを提供する groupingObjectFunction を指定できます。

メソッドシグネチャは次のとおりです。

      myGroupObjectFunction(label:String):Object

ここで、label には、そのグループノードについて表示される値が含まれます。 戻り値は、グループノードに使用されるオブジェクトです。

      private function groupObjFunction(label:String):Object
      {
          var obj:Object = {};
          obj.name = "Bob";
               return obj;
      }
      

階層を作成するためにフラットデータに追加されるフィールドの名前です。 各グループの最上位ノード（グループフィールドを表すノード）の値が、このプロパティで表されます。 このプロパティを使用して、異なる名前を指定します。

デフォルト値 : GroupLabel.

コンストラクタです。