以下のコードで示すように、sortRangeメソッドで指定した並び順にデータを並べ替えることができます。
ユーザーはコンテキストメニューからもソートまたはフィルタリングを行うことができます。
データ型の優先順位は、ブール値 > 文字列 > 数値 です。（例）TRUE > '4' > 8
ソートのカスタマイズ
ユーザーはコールバック関数を使用して、ソートのためのカスタマイズした比較メソッドを定義することができます。
以下のコードではソートのためのlocalCompareの使用方法を示しています。
セルの色でソート
ユーザーは、特別な並べ替え情報に従って、セルの色でセルをソートすることができます。この機能は、単色塗りつぶし、パターン塗りつぶし、グラデーション塗りつぶしをサポートします。次のコードは、backColorを使用してセルの色でソートする使用方法を示しています。
フォントの色でソート
ユーザーは、特別な並べ替え情報に従って、フォントの色でセルをソートすることができます。この機能は、塗りつぶしのみをサポートします。
ユーザーは、RangeSortingイベントが発生したときに使用するコールバック関数を定義できます。
グループのソート
groupSortオプションを使用して、グループ化したデータのソート方法を指定できます。グループのソート方法には次の種類があります。
flat：グループに関係なくデータを並べ替えます（従来通り）
group：グループの親項目をソートします。グループの子項目はソートされません
child：グループの子項目のみソートします
full：グループの親項目と子項目をすべてソートします
以下のコードではgroupSortオプションの使用方法を示しています。
また、RangeSortingイベントでgroupSortオプションを設定することもできます。
非表示を無視したソート
ソート時に非表示の値を無視するかどうかを設定できます。
ignoreHiddenがtrueに設定されている場合、SpreadJSはスキップし、非表示の値を移動しません。
ignoreHiddenがfalseに設定されている場合、SpreadJSは非表示の値を比較して移動します。
groupSortがgroup/child/fullに設定されている場合、SpreadJSは非表示の値を移動し、値を非表示に保ちます。
次のコードは、ignoreHiddenオプションの使用方法を示しています。
また、RangeSortingイベントでignoreHiddenオプションを設定することもできます。
デフォルトでは、ソート範囲にグループが含まれている場合、SpreadJSは groupモードでデータをソートします。その他の場合は、flatモードで非表示データを除外してソートします。
最後のソート状態を維持
最後に実行した並べ替え操作の設定はワークシートに記録され、getSortStateメソッドを使用して最終ソート状態を取得することができます。
以下のコードは、getSortStateメソッドの使用方法を示しています。
また、引数を渡さずに sortRange を呼び出して並べ替えを実行できるようになりました。この場合の並べ替えアクションは最後の並べ替え状態に基づいたものになります。
ユーザーは、sortRange をイベントと組み合わせて使用し、自動並べ替えを実装できます。
次のコードは、簡単なコード例を示しています。
上記のコードは、シートの値が変更されると自動的に呼び出されるので、シートの値が変更されるたびに並び替えが実行されます。
window.onload = function() {
var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'));
spread.suspendPaint();
spread.fromJSON(sjsData);
initSheet0(spread.getSheet(0));
initSheet1(spread.getSheet(1));
initSheet2(spread.getSheet(2));
initSheet3(spread.getSheet(3));
initSheet4(spread.getSheet(4));
initSheet5(spread.getSheet(5));
initSheet6(spread.getSheet(6));
initSheet7(spread.getSheet(7));
initSortStatePanel(spread);
spread.resumePaint();
};
const CELL_COLOR_MAPPING = {
red:"#FF0000",
green:"#00B050",
blue: "#00B0F0",
gradient: {
degree:90,
stops:[
{
color:"#ffffff",
position:0,
},
{
color:"#5B9BD5",
position:1,
}
]
},
pattern: {
patternColor:"",
type:14,
backgroundColor:""
}
}
const FONT_COLOR_MAPPING = {
red:"#FF0000",
blue:"#00B0F0",
purple:"#7030A0",
green:"#92D050",
null:""
}
function initSheet0(sheet) {
var style = sheet.getStyle(4, 7);
style.cellButtons= [{
useButtonStyle: true,
caption: "苗字で並べ替える",
width: 222,
command: function() {
sheet.sortRange(4, 0, 27, 5, true, [
{
index: 1,
ascending: true,
compareFunction: function (value1, value2) {
var str1 = value1.split(" ")[1], str2 = value2.split(" ")[1];
return str1.localeCompare(str2);
}
},
])
},
}];
sheet.setStyle(4, 7, style);
sheet.setRowHeight(4,35);
var grade = ["Freshmen", "Sophomore", "Junior", "Senior"];
var clothesSize = ["XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large"];
function compareList(obj1, obj2, list) {
var index1 = list.indexOf(obj1), index2 = list.indexOf(obj2);
if (index1 > index2) {
return 1;
} else if (index1 < index2) {
return -1;
} else {
return 0;
}
}
style = sheet.getStyle(5, 7);
style.cellButtons= [{
useButtonStyle: true,
caption: "Gradeで並べ替える",
width: 222,
command: function() {
sheet.sortRange(4, 0, 27, 5, true, [
{
index: 2,
ascending: true,
compareFunction: function (value1, value2) {
return compareList(value1, value2, grade);
}
},
])
},
}];
sheet.setStyle(5, 7, style);
sheet.setRowHeight(5,35);
style = sheet.getStyle(6, 7);
style.cellButtons= [{
useButtonStyle: true,
caption: "Tシャツのサイズで並べ替える",
width: 222,
command: function() {
sheet.sortRange(4, 0, 27, 5, true, [
{
index: 3,
ascending: true,
compareFunction: function (value1, value2) {
return compareList(value1, value2, clothesSize);
}
},
])
},
}];
sheet.setStyle(6, 7, style);
sheet.setRowHeight(6,35);
}
function initSheet1(sheet) {
function sortDomain (value1, value2) {
var str1 = value1.substr(value1.lastIndexOf(".") + 1), str2 = value2.substr(value2.lastIndexOf(".") + 1);
return str1.localeCompare(str2);
}
function sortIP (ip1, ip2) {
var value1 = ip1.split("."), value2 = ip2.split(".");
for (var i=0; i < 4; i++){
var num1 = parseInt(value1[i]), num2 = parseInt(value2[i]);
if (num1 > num2) {
return 1;
} else if (num1 < num2){
return -1;
}
}
return 0;
}
sheet.bind(GC.Spread.Sheets.Events.RangeSorting, function (e, info) {
if (info.col === 0) {
info.compareFunction = sortDomain;
} else if (info.col === 1) {
info.compareFunction = sortIP;
}
});
}
function initSheet2(sheet) {
sheet.bind(GC.Spread.Sheets.Events.RangeSorting, function (e, info) {
info.groupSort = GC.Spread.Sheets.GroupSort.full;
});
}
function initSheet3(sheet) {
sheet.outlineColumn.options({
columnIndex: 0,
showImage: false,
showIndicator: true,
showCheckBox: true,
maxLevel: 10
});
}
function initSheet4(sheet) {
var style = sheet.getStyle(1, 4);
style.cellButtons= [
{
useButtonStyle: true,
caption: "ignoreHidden = true",
command: function() {
sheet.sortRange(2, 0, 15, 1, true, [
{
index: 0,
ascending: sheet.getValue(1, 3) === '1',
},
], {ignoreHidden: true});
},
}, {
useButtonStyle: true,
caption: "ignoreHidden = false",
command: function() {
sheet.sortRange(2, 0, 15, 1, true, [
{
index: 0,
ascending: sheet.getValue(1, 3) === '1',
},
], {ignoreHidden: false});
},
}, {
useButtonStyle: true,
caption: "groupSort = group",
command: function() {
sheet.sortRange(2, 0, 15, 1, true, [
{
index: 0,
ascending: sheet.getValue(1, 3) === '1',
},
], {groupSort: GC.Spread.Sheets.GroupSort.group});
},
}];
sheet.setStyle(1, 4, style);
}
function initSheet5 (sheet){
sheet.setColumnWidth(4,120);
var style = new GC.Spread.Sheets.Style();
style.cellButtons = [{
caption: "セルの色で並べ替える",
useButtonStyle:true,
width: 120,
command: function (sheet) {
var value = sheet.getValue(15,3);
var order = sheet.getValue(15,4);
value = value ? value : "red";
order = order ? order : "top";
var color = CELL_COLOR_MAPPING[value];
sheet.sortRange(3,2,10,1,true,[{
index:2,
backColor:color,
order:order,
}])
}
}];
sheet.setStyle(16,4,style);
}
function initSheet6 (sheet){
sheet.setColumnWidth(4,120);
var style = new GC.Spread.Sheets.Style();
style.cellButtons = [{
caption:"フォントの色で並べ替える",
useButtonStyle:true,
width:120,
command:function (sheet){
var value = sheet.getValue(15,3);
var order = sheet.getValue(15,4);
value = value ? value : "red";
order = order ? order : "top";
var color = FONT_COLOR_MAPPING[value];
sheet.sortRange(3,2,10,1,true,[{
index:2,
fontColor:color,
order:order
}])
}
}];
sheet.setStyle(16,4,style);
}
function initSheet7(sheet) {
sheet.sortRange(2, 2, 10, 1, true, [{ index: 2, ascending: false, compareFunction: undefined }]);
sheet.setSelection(2, 2, 10, 1);
sheet.bind(GC.Spread.Sheets.Events.ValueChanged, function(e, info) {
let sortState = sheet.getSortState();
if (inSortStateRange(sortState, info.row, info.col)) {
sheet.sortRange();
}
});
}
function initSortStatePanel(spread) {
_getElementById('get_SortState_Btn').addEventListener('click', function() {
let sheet = spread.getActiveSheet();
let sortState = sheet.getSortState();
if (!sortState) {
return;
}
let { row, col, rowCount, colCount, byRow, sortConditions } = sortState;
if (sortState) {
let sortStateStr = '';
sortStateStr += "row: " + row + ",\n";
sortStateStr += "col: " + col + ",\n";
sortStateStr += "rowCount: " + rowCount + ",\n";
sortStateStr += "colCount: " + colCount + ",\n";
sortStateStr += "byRow: " + byRow + ",\n";
sortStateStr += "sortCondition: " + JSON.stringify(sortConditions); +"}\n";
document.getElementById("showEventArgs").value = sortStateStr;
}
});
}
function inSortStateRange(sortState, row, col) {
if (row >= sortState.row && row < sortState.row + sortState.rowCount && col >= sortState.col && col < sortState.col + sortState.colCount) {
return true;
}
return false;
}
function _getElementById(id) {
return document.getElementById(id);
}
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta name="spreadjs culture" content="ja-jp" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css" href="$DEMOROOT$/ja/purejs/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<script src="$DEMOROOT$/ja/purejs/node_modules/@mescius/spread-sheets/dist/gc.spread.sheets.all.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/ja/purejs/node_modules/@mescius/spread-sheets-resources-ja/dist/gc.spread.sheets.resources.ja.min.js" type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/data/sorting.js" type="text/javascript"></script>
<script src="$DEMOROOT$/spread/source/js/license.js" type="text/javascript"></script>
<script src="app.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="styles.css">
</head>
<body>
<div class="sample-tutorial">
<div id="ss" class="sample-spreadsheets"></div>
<div class="options-container">
<div id="settingsDiv">
<br/>
<label>このテキストボックスは、最後のソート操作に関するsortState情報を表示します。</label>
<br/>
<textarea id="showEventArgs" cols="85" rows="8" style="max-width: 98%"></textarea>
<div class="option-row">
<input type="button" id="get_SortState_Btn" value="ソート状態を取得する"/>
</div>
</div>
</div>
</div>
</body>
</html>
.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: calc(100% - 280px);
height: 100%;
overflow: hidden;
float: left;
}
.options-container {
float: right;
width: 280px;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
}
.option-row {
font-size: 14px;
padding: 5px;
margin-top: 10px;
}
label {
display: block;
margin-bottom: 6px;
}
input {
padding: 4px 6px;
}
input[type=button] {
margin-top: 6px;
display: block;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
