SpreadJS製品ヘルプ
sortRange メソッド
GC.Spread.Sheets 名前空間 > Worksheet タイプ : sortRange メソッド
ソートするセルブロックの開始行のインデックス。
ソートするセルブロックの開始列のインデックス。
セルブロックの行数。
セルブロックの列数。
行単位でソートする場合はtrue、列単位でソートする場合はfalseに設定します。

以下の設定が使用できます。

sortInfo.index number型 ソートする列または行のインデックス。
sortInfo.ascending boolean型 ソート順序が昇順かどうか。
ソートする列または行のインデックス
並べ替えが値による場合か、またはカスタム並べ替えの場合、並べ替え順序が昇順であるかどうかを示します。
「top」と「bottom」のみをサポートします。 注文が「top」の場合、選択した色が一番上にグループ化されます。
並べ替えのフォントの色。
並べ替えの背景色。 このパラメータは、色文字列、グラデーション塗りつぶし、およびパターン塗りつぶしをサポートします。
ソート順が昇順かどうか。 function(value1、value2){return 0;}。
sortOptionは、ソートの詳細なパフォーマンスを示します。
グループ化されたデータでの並べ替える操作を示します。すべてのグループとその内部コンテンツを並べ替えるかどうか。
非表示の値を無視して、表示値のみを並べ替えるかどうか。
このシートのデータモデル内のセル範囲をソートします。
シンタックス
var instance = new GC.Spread.Sheets.Worksheet(name);
var value; // Type: boolean
value = instance.sortRange(row,
                           column,
                           rowCount,
                           columnCount,
                           byRows,
                           sortInfo,
                           sortInfo.index,
                           sortInfo.ascending,
                           sortInfo.order,
                           sortInfo.fontColor,
                           sortInfo.backColor,
                           sortInfo.compareFunction,
                           sortOption,
                           sortOption.groupSort,
                           sortOption.ignoreHidden);
function sortRange( 
   row : number,
   column : number,
   rowCount : number,
   columnCount : number,
   byRows : boolean,
   sortInfo : Object,
   sortInfo.index : number,
   sortInfo.ascending : boolean,
   sortInfo.order : string,
   sortInfo.fontColor : undefined,
   sortInfo.backColor : undefined,
   sortInfo.compareFunction : Function,
   sortOption : ISortOptions,
   sortOption.groupSort : groupSort,
   sortOption.ignoreHidden : boolean
) : boolean;

パラメータ

row
ソートするセルブロックの開始行のインデックス。
column
ソートするセルブロックの開始列のインデックス。
rowCount
セルブロックの行数。
columnCount
セルブロックの列数。
byRows
行単位でソートする場合はtrue、列単位でソートする場合はfalseに設定します。
sortInfo

以下の設定が使用できます。

sortInfo.index number型 ソートする列または行のインデックス。
sortInfo.ascending boolean型 ソート順序が昇順かどうか。
sortInfo.index
ソートする列または行のインデックス
sortInfo.ascending
並べ替えが値による場合か、またはカスタム並べ替えの場合、並べ替え順序が昇順であるかどうかを示します。
sortInfo.order
「top」と「bottom」のみをサポートします。 注文が「top」の場合、選択した色が一番上にグループ化されます。
sortInfo.fontColor
並べ替えのフォントの色。
sortInfo.backColor
並べ替えの背景色。 このパラメータは、色文字列、グラデーション塗りつぶし、およびパターン塗りつぶしをサポートします。
sortInfo.compareFunction
ソート順が昇順かどうか。 function(value1、value2){return 0;}。
sortOption
sortOptionは、ソートの詳細なパフォーマンスを示します。
sortOption.groupSort
グループ化されたデータでの並べ替える操作を示します。すべてのグループとその内部コンテンツを並べ替えるかどうか。
sortOption.ignoreHidden
非表示の値を無視して、表示値のみを並べ替えるかどうか。

戻り値の型

データのソートが成功した場合はtrue、それ以外の場合はfalse
使用例
次のサンプルコードは、範囲をソートします。
sheet.setValue(0,0,"112");
sheet.setValue(1,0,"10");
sheet.setValue(2,0,"223");
sheet.setValue(3,0,"20");
sheet.setValue(4,0,"334");
sheet.setValue(5,0,"30");
sheet.sortRange(0, 0, 6, 1, true, [
                {index:0, ascending:true}
                ]);
関連トピック

参照

Worksheet タイプ
データの並べ替え