[]
• new Events()
SpreadJSでサポートされているイベントを定義します。
• 静的
ActiveSheetChanged: string
ユーザーがアクティブシートを変更したときに発生します。
名前
GC.Spread.Sheets.Workbook#ActiveSheetChanged
パラメータ
GC.Spread.Sheets.Worksheet oldSheet
古いシート。
パラメータ
GC.Spread.Sheets.Worksheet newSheet
新しいシート。
実例
// 次のサンプルコードは、ActiveSheetChangedイベントのログテキストを作成します。
// ログテキストをコンソールに表示します。
spread.bind(GC.Spread.Sheets.Events.ActiveSheetChanged, function (sender, args) {
console.log("Active sheet has been switched.");
});
• 静的
ActiveSheetChanging: string
ユーザーがアクティブなシートを変更するときに発生します。
名前
GC.Spread.Sheets.Workbook#ActiveSheetChanging
パラメータ
GC.Spread.Sheets.Worksheet oldSheet
古いシート。
パラメータ
GC.Spread.Sheets.Worksheet newSheet
新しいシート。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、アクティブシートが変更されないようにします。
spread.bind(GC.Spread.Sheets.Events.ActiveSheetChanging, function (sender, args) {
// シートの切り替えをキャンセルします。
args.cancel = true;
});
• 静的
BeforePrint: string
印刷の前に発生します。
名前
GC.Spread.Sheets.WorkBook.BeforePrint
パラメータ
Object iframe
印刷用の Dom。
パラメータ
boolean cancel
印刷をキャンセルするかどうか。
実例
// 次のサンプルコードは、BeforePrintを使用します。
window.onload = function(){
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
spread.bind(GC.Spread.Sheets.Events.BeforePrint, function (e, data) {
alert(data.iframe + '\n' + 'cancel: ' + data.cancel);
});
}
• 静的
ButtonClicked: string
ユーザーがセルのボタン、コンボボックス、ハイパーリンクのいずれかをクリックするときに発生します。
名前
GC.Spread.Sheets.Workbook#ButtonClicked
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
セルの行インデックス。
パラメータ
number col
セルの列インデックス。
パラメータ
GC.Spread.Sheets.SheetArea sheetArea
セルを含むシート領域。
実例
// 次のサンプルコードは、ボタン型セルを作成します。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
activeSheet.setCellType(1,1,cellType);
// 連結
spread.bind(GC.Spread.Sheets.Events.ButtonClicked, function (e, args) {
var sheet = args.sheet, row = args.row, col = args.col;
var cellType = activeSheet.getCellType(row, col);
if (cellType instanceof GC.Spread.Sheets.CellTypes.Button) {
alert("Button Clicked");
}
});
• 静的
CellChanged: string
このシートのセルに、そのセルの再描画が必要となるような変更が加えられたときに発生します。
名前
GC.Spread.Sheets.Worksheet#CellChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
セルの行インデックス。
パラメータ
number col
セルの列インデックス。
パラメータ
GC.Spread.Sheets.SheetArea sheetArea
セルのシート領域。
パラメータ
string propertyName
変更されたセルのプロパティの名前。
パラメータ
boolean isUndo
このイベントが「元に戻す」操作から発生しましたかどうか。
実例
// 次のサンプルコードは、CellChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.CellChanged, function (e, info) {
if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
alert("Cell index (" + info.row + "," + info.col + ")");
}
});
• 静的
CellClick: string
ユーザーがセルの上でマウス左ボタンを押したときに発生します。
名前
GC.Spread.Sheets.Worksheet#CellClick
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.SheetArea sheetArea
クリックされたセルが存在するシート領域。
パラメータ
number row
クリックされたセルの行インデックス。
パラメータ
number col
クリックされたセルの列インデックス。
実例
// 次のサンプルコードは、CellClickイベントを使用します。
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.CellClick, function (sender, args) {
if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
console.log("The column header was clicked.");
}
if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
console.log("The row header was clicked.");
}
if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
console.log("The corner header was clicked.");
}
console.log("Clicked column index: " + args.col);
console.log("Clicked row index: " + args.row);
});
// 連結
activeSheet.bind(GC.Spread.Sheets.Events.CellDoubleClick, function (sender, args) {
if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
console.log("The column header was double clicked.");
}
if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
console.log("The row header was double clicked.");
}
if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
console.log("The corner header was double clicked.");
}
console.log("Double clicked column index: " + args.col);
console.log("Double clicked row index: " + args.row);
])
• 静的
CellDoubleClick: string
ユーザーがセルの上でマウス左ボタンを2回押したとき(ダブルクリックしたとき)に発生します。
名前
GC.Spread.Sheets.Worksheet#CellDoubleClick
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.SheetArea sheetArea
クリックされたセルが存在するシート領域。
パラメータ
number row
クリックされたセルの行インデックス。
パラメータ
number col
クリックされたセルの列インデックス。
実例
// 次のサンプルコードは、CellDoubleClickイベントを使用します。
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.CellClick, function (sender, args) {
if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
console.log("The column header was clicked.");
}
if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
console.log("The row header was clicked.");
}
if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
console.log("The corner header was clicked.");
}
console.log("Clicked column index: " + args.col);
console.log("Clicked row index: " + args.row);
});
// 連結
activeSheet.bind(GC.Spread.Sheets.Events.CellDoubleClick, function (sender, args) {
if(args.sheetArea === GC.Spread.Sheets.SheetArea.colHeader){
console.log("The column header was double clicked.");
}
if(args.sheetArea === GC.Spread.Sheets.SheetArea.rowHeader){
console.log("The row header was double clicked.");
}
if(args.sheetArea === GC.Spread.Sheets.SheetArea.corner){
console.log("The corner header was double clicked.");
}
console.log("Double clicked column index: " + args.col);
console.log("Double clicked row index: " + args.row);
});
• 静的
ClipboardChanged: string
Spread.Sheetsに影響を与えるクリップボードの変更が起こったときに発生します。
名前
GC.Spread.Sheets.Worksheet#ClipboardChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
Object copyData
クリップボードに設定されたSpread.Sheetsのデータ。
パラメータ
string copyData.text
クリップボードのテキスト文字列。
パラメータ
string copyData.html
クリップボードのhtml文字列。
パラメータ
Array objects
コピーされたフローティングオブジェクト。ピクチャ、カスタムフローティングオブジェクト、スライサー、チャート、シェイプが含まれています。
実例
// 次のサンプルコードは、ClipboardChangedイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.ClipboardChanged, function (sender, args) {
console.log("ClipboardChanged.", args);
});
• 静的
ClipboardChanging: string
Spread.Sheetsのアクションによってクリップボードが変更されるときに発生します。
名前
GC.Spread.Sheets.Worksheet#ClipboardChanging
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
Object copyData
クリップボードに設定するSpread.Sheetsのデータ。
パラメータ
string copyData.text
クリップボードのテキスト文字列。
パラメータ
string copyData.html
クリップボードのhtml文字列。
パラメータ
{@link GC.Spread.Sheets.Range[]} ranges
現在の切り取るまたはコピー操作のソースシートのソース範囲。
パラメータ
{@link GC.Spread.Sheet.ClipboardActionType} action
現在のアクションのタイプを示します。
パラメータ
Array objects
コピー中のフローティングオブジェクト。ピクチャ、カスタムフローティングオブジェクト、スライサー、チャート、シェイプが含まれています。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、ClipboardChangingイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.ClipboardChanging, function (sender, args) {
console.log("ClipboardChanging", args);
});
• 静的
ClipboardPasted: string
ユーザーがクリップボードから貼り付けたときに発生します。
名前
GC.Spread.Sheets.Worksheet#ClipboardPasted
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Range cellRange
貼り付けられた範囲。
パラメータ
GC.Spread.Sheets.ClipboardPasteOptions pasteOption
クリップボードからどのデータ(値、書式、数式)が貼り付けられるかを示す貼り付けオプション。
パラメータ
Object pasteData
Spread.Sheetsに貼り付けられるクリップボードのデータ。
パラメータ
string pasteData.text
クリップボードのテキスト文字列。
パラメータ
string pasteData.html
クリップボードのhtml文字列。
パラメータ
string pasteData.image
クリップボードの画像src文字列。
パラメータ
GC.Spread.Sheets.Worksheet fromSheet
データ範囲の元シート。
パラメータ
GC.Spread.Sheets.Range [fromRange]
範囲をコピーまたは切り取るときの貼り付けのソース範囲。
パラメータ
{@link GC.Spread.Sheet.ClipboardActionType} action
現在のアクションのタイプを示します。
パラメータ
Array objects
貼り付けたフローティングオブジェクト。 画像、カスタムフローティングオブジェクト、スライサー、チャート、シェイプが含まれています。
パラメータ
GC.Spread.Sheets.InsertShiftCell [shiftCells]
セルの移動オプション。 セルを移動しない場合、undefinedになります。
実例
// 次のサンプルコードは、ClipboardPastedイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.ClipboardPasted, function (sender, args) {
console.log("ClipboardPasted", args);
});
• 静的
ClipboardPasting: string
ユーザーがクリップボードから貼り付けるときに発生します。
名前
GC.Spread.Sheets.Worksheet#ClipboardPasting
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Range cellRange
貼り付ける範囲。
パラメータ
GC.Spread.Sheets.ClipboardPasteOptions pasteOption
クリップボードからどのデータ(値、書式、数式)が貼り付けられるかを示す貼り付けオプション。
パラメータ
Object pasteData
Spread.Sheetsに貼り付けられるクリップボードのデータ。
パラメータ
string pasteData.text
クリップボードのテキスト文字列。
パラメータ
string pasteData.html
クリップボードのhtml文字列。
パラメータ
string pasteData.image
クリップボードの画像src文字列。
パラメータ
GC.Spread.Sheets.Worksheet fromSheet
データ範囲の元シート。
パラメータ
GC.Spread.Sheets.Range [fromRange]
範囲をコピーまたは切り取るときの貼り付けのソース範囲。
パラメータ
{@link GC.Spread.Sheet.ClipboardActionType} action
現在のアクションのタイプを示します。
パラメータ
Array objects
貼り付け中のフローティングオブジェクト。 画像、カスタムフローティングオブジェクト、スライサー、チャート、シェイプが含まれています。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
パラメータ
GC.Spread.Sheets.InsertShiftCell [shiftCells]
セルの移動オプション。 セルを移動しない場合、undefinedになります。
実例
// 次のサンプルコードは、ClipboardPastingイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.ClipboardPasting, function (sender, args) {
console.log("ClipboardPasting", args);
});
• 静的
ColumnChanged: string
このシートの列または列範囲に、その列または列範囲の再描画が必要となるような変更が加えられたときに発生します。
名前
GC.Spread.Sheets.Worksheet#ColumnChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number col
列インデックス。
パラメータ
GC.Spread.Sheets.SheetArea sheetArea
列のシート領域。
パラメータ
string propertyName
変更された列のプロパティの名前。
パラメータ
boolean isUndo
このイベントが「元に戻す」操作から発生しましたかどうか。
実例
// 次のサンプルコードは、ColumnChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnChanged, function (e, info) {
if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
alert("Index (" + info.col + ")");
}
});
• 静的
ColumnChanging: string
このシートの列または列範囲を変更する前にに、その列または列範囲の再描画が必要となるような変更が加えられたときに発生します。
名前
GC.Spread.Sheets.Worksheet#ColumnChanging
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number col
列インデックス。
パラメータ
GC.Spread.Sheets.SheetArea sheetArea
列のシート領域。
パラメータ
string propertyName
変更された列のプロパティの名前。
実例
// 次のサンプルコードは、ColumnChangingイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnChanging, function (e, info) {
if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
alert("Index (" + info.col + ")");
}
});
• 静的
ColumnWidthChanged: string
列の幅が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#ColumnWidthChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
Array colList
幅が変更された列の配列リストを取得します。
パラメータ
boolean header
列が行ヘッダ列かどうか。
実例
// 次のサンプルコードは、ColumnWidthChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnWidthChanged, function (e, info) {
alert("Column (" + info.colList + ")");
});
• 静的
ColumnWidthChanging: string
列の幅が変更されるときに発生します。
名前
GC.Spread.Sheets.Worksheet#ColumnWidthChanging
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
Array colList
幅が変更される列のリスト。
パラメータ
boolean header
列が行ヘッダ列かどうか。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、ColumnWidthChangingイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.ColumnWidthChanging, function (e, info) {
alert("Column (" + info.colList + ")");
});
• 静的
CommentChanged: string
いずれかのコメントが変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#CommentChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Comments.Comment comment
イベントを発生させたコメント。
パラメータ
string propertyName
変更されたコメントのプロパティの名前。
実例
// 次のサンプルコードは、CommentChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.CommentChanged, function (e, info) {
alert("changed");
});
• 静的
CommentRemoved: string
ユーザーがコメントを削除した後に発生します。
名前
GC.Spread.Sheets.Worksheet#CommentRemoved
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Comments.Comment comment
削除されたコメント。
実例
// 次のサンプルコードは、CommentRemovedイベントを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("orange");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
activeSheet.bind(GC.Spread.Sheets.Events.CommentRemoved, function (e, info) {
console.log("sheet name: " + info.sheetName);
});
• 静的
CommentRemoving: string
ユーザーがいずれかのコメントを削除する前に発生します。
名前
GC.Spread.Sheets.Worksheet#CommentRemoving
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Comments.Comment comment
削除されるコメント。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
//次のサンプルコードは、コメントが削除されないようにします。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("orange");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
activeSheet.bind(GC.Spread.Sheets.Events.CommentRemoving, function (e, info) {
info.cancel = true;
});
• 静的
DragDropBlock: string
ユーザーがセル範囲をドラッグ&ドロップするときに発生します。
名前
GC.Spread.Sheets.Worksheet#DragDropBlock
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number fromRow
ソース範囲(ドラッグされている範囲)の左上セルの行インデックス。
パラメータ
number fromCol
ソース範囲(ドラッグされている範囲)の左上セルの列インデックス。
パラメータ
number toRow
宛先範囲(選択内容がドロップされる範囲)の左上セルの行インデックス。
パラメータ
number toCol
宛先範囲(選択内容がドロップされる範囲)の左上セルの列インデックス。
パラメータ
number rowCount
ドラッグされているセル範囲の行数。
パラメータ
number colCount
ドラッグされているセル範囲の列数。
パラメータ
boolean copy
ソース範囲をコピーするかどうか。
パラメータ
boolean insert
ソース範囲を挿入するかどうか。
パラメータ
GC.Spread.Sheets.CopyToOptions copyOption
ドラッグ&ドロップ操作のCopyOption値。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、DragDropBlockイベントのログテキストを作成します。
// ログテキストをコンソールに表示します。
var activeSheet = spread.getActiveSheet();
activeSheet.bind(GC.Spread.Sheets.Events.DragDropBlock, function (e, args) {
console.log("From Column:" + args.fromCol);
console.log("From Row:" + args.fromRow);
console.log("To Column:" + args.toCol);
console.log("To Row:" + args.toRow);
});
• 静的
DragDropBlockCompleted: string
ユーザーがセル範囲のドラッグ&ドロップを完了したときに発生します。
名前
GC.Spread.Sheets.Worksheet#DragDropBlockCompleted
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number fromRow
ソース範囲(ドラッグされている範囲)の左上セルの行インデックス。
パラメータ
number fromCol
ソース範囲(ドラッグされている範囲)の左上セルの列インデックス。
パラメータ
number toRow
宛先範囲(選択内容がドロップされる範囲)の左上セルの行インデックス。
パラメータ
number toCol
宛先範囲(選択内容がドロップされる範囲)の左上セルの列インデックス。
パラメータ
number rowCount
ドラッグされているセル範囲の行数。
パラメータ
number colCount
ドラッグされているセル範囲の列数。
パラメータ
boolean copy
ソース範囲をコピーするかどうか。
パラメータ
boolean insert
ソース範囲を挿入するかどうか。
パラメータ
GC.Spread.Sheets.CopyToOptions copyOption
ドラッグ&ドロップ操作のCopyOption値。
実例
// 次のサンプルコードは、DragDropBlockCompletedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.DragDropBlockCompleted, function (e, args) {
alert("From Column (" + args.fromCol + ")");
});
• 静的
DragFillBlock: string
ユーザーがセル範囲をドラッグフィルするときに発生します。
名前
GC.Spread.Sheets.Worksheet#DragFillBlock
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Range fillRange
フィル操作に使用する範囲。
パラメータ
GC.Spread.Sheets.Fill.AutoFillType autoFillType
フィル操作に使用するAutoFillType値。
パラメータ
GC.Spread.Sheets.Fill.FillDirection fillDirection
フィルの方向。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、DragFillBlockイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.DragFillBlock, function (e, info) {
alert("Direction (" + info.fillDirection + ")");
});
• 静的
DragFillBlockCompleted: string
ユーザーがセル範囲のドラッグフィルを完了したときに発生します。
名前
GC.Spread.Sheets.Worksheet#DragFillBlockCompleted
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Range fillRange
フィル操作に使用する範囲。
パラメータ
GC.Spread.Sheets.Fill.AutoFillType autoFillType
フィル操作に使用するAutoFillType値。
パラメータ
GC.Spread.Sheets.Fill.FillDirection fillDirection
フィルの方向。
実例
// 次のサンプルコードは、DragFillBlockCompletedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.DragFillBlockCompleted, function (e, info) {
alert("Type (" + info.autoFillType + ")");
});
• 静的
DragMerged: string
ユーザーがセルをドラッグしてマージした後に発生します。
名前
GC.Spread.Sheets.Worksheet#DragMerged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Range mergeRange
マージされる範囲。
実例
// 次のサンプルコードは、行インデックスを返します。
// マージするには[Ctrl]キーを押します。
$(document).keydown(function (e) {
if (e.keyCode === 17) {
spread.options.allowUserDragMerge = true;
}
});
$(document).keyup(function (e) {
if (e.keyCode === 17) {
spread.options.allowUserDragMerge = false;
}
});
activeSheet.bind(GC.Spread.Sheets.Events.DragMerging, function (e, data) {
var mergeRange = data.mergeRange;
alert(mergeRange.row);
});
activeSheet.bind(GC.Spread.Sheets.Events.DragMerged, function (e, data) {
var mergeRange = data.mergeRange;
alert(mergeRange.row);
});
• 静的
DragMerging: string
ユーザーがセルをドラッグしてマージする前に発生します。
名前
GC.Spread.Sheets.Worksheet#DragMerging
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Range mergeRange
マージされる範囲。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、行インデックスを返します。
// マージするには[Ctrl]キーを押します。
$(document).keydown(function (e) {
if (e.keyCode === 17) {
spread.options.allowUserDragMerge = true;
}
});
$(document).keyup(function (e) {
if (e.keyCode === 17) {
spread.options.allowUserDragMerge = false;
}
});
activeSheet.bind(GC.Spread.Sheets.Events.DragMerging, function (e, data) {
var mergeRange = data.mergeRange;
alert(mergeRange.row);
});
activeSheet.bind(GC.Spread.Sheets.Events.DragMerged, function (e, data) {
var mergeRange = data.mergeRange;
alert(mergeRange.row);
});
• 静的
EditChange: string
セルが編集モードのときにテキストが変更されると発生します。
名前
GC.Spread.Sheets.Worksheet#EditChange
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
セルの行インデックス。
パラメータ
number col
セルの列インデックス。
パラメータ
Object editingText
現在のエディタの値。
実例
// 次のサンプルコードは、EditChangeイベントのログテキストを作成します。
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.EditChange, function (sender, args) {
console.log("Cell (" + args.row + ", " + args.col + ") data has been changed.")
});
• 静的
EditEnded: string
セルが編集モードを終了したときに発生します。
名前
GC.Spread.Sheets.Worksheet#EditEnded
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
セルの行インデックス。
パラメータ
number col
セルの列インデックス。
パラメータ
Object editingText
現在のエディタの値。
パラメータ
boolean committed
値の変更がコミットされたかどうか。
実例
//次のサンプルコードは、EditStartingおよびEditEndedイベントのログテキストを作成します。
// ログテキストをコンソールに表示します。
var activeSheet = spread.getActiveSheet();
activeSheet.bind(GC.Spread.Sheets.Events.EditStarting, function (sender, args) {
console.log("Start cell editing.");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnded, function (sender, args) {
console.log("Finish cell editing.");
});
• 静的
EditEnding: string
セルが編集モードを終了するときに発生します。
名前
GC.Spread.Sheets.Worksheet#EditEnding
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
セルの行インデックス。
パラメータ
number col
セルの列インデックス。
パラメータ
Object editor
現在のエディタ。
パラメータ
Object editingText
現在のエディタの値。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
パラメータ
boolean committed
値の変更がコミットされたかどうか。
実例
// 次のサンプルコードは、EditEndingイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.EditStarting, function (sender, args) {
console.log("Start cell editing.");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnding, function (sender, args) {
console.log("EditEnding event.");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnded, function (sender, args) {
console.log("EditEnded event.");
});
• 静的
EditStarting: string
セルが編集モードに入るときに発生します。
名前
GC.Spread.Sheets.Worksheet#EditStarting
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
セルの行インデックス。
パラメータ
number col
セルの列インデックス。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
//次のサンプルコードは、EditStartingおよびEditEndedイベントのログテキストを作成します。
// ログテキストをコンソールに表示します。
var activeSheet = spread.getActiveSheet();
activeSheet.bind(GC.Spread.Sheets.Events.EditStarting, function (sender, args) {
console.log("Start cell editing.");
});
activeSheet.bind(GC.Spread.Sheets.Events.EditEnded, function (sender, args) {
console.log("Finish cell editing.");
});
• 静的
EditorStatusChanged: string
エディタのステータスが変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#EditorStatusChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.EditorStatus oldStatus
エディタの変更前のステータス。
パラメータ
GC.Spread.Sheets.EditorStatus newStatus
エディタの変更後のステータス。
実例
// 次のサンプルコードは、EditorStatusChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.EditorStatusChanged, function (e, info) {
alert("Column (" + info.newStatus + ")");
});
• 静的
EnterCell: string
セルにフォーカスが入ると発生します。
名前
GC.Spread.Sheets.Worksheet#EnterCell
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
フォーカスが入るセルの行インデックス。
パラメータ
number col
フォーカスが入るセルの列インデックス。
実例
// 次のサンプルコードは、EnterCellイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.EnterCell, function (e, info) {
alert("Cell (" + info.row + ", " + info.col +")");
});
• 静的
FloatingObjectChanged: string
いずれかのフローティングオブジェクトが変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#FloatingObjectsChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject
イベントを発生させたフローティングオブジェクト。
パラメータ
string propertyName
変更されたフローティングオブジェクトのプロパティの名前。
実例
// 次のサンプルコードは、FloatingObjectChangedイベントを使用します。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
activeSheet.bind(GC.Spread.Sheets.Events.FloatingObjectChanged, function (e, info) {
alert("changed");
});
• 静的
FloatingObjectLoaded: string
カスタムフローティングオブジェクトの内容がロードされたときに発生します。
名前
GC.Spread.Sheets.Worksheet#FloatingObjectLoaded
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject
イベントを発生させたカスタムフローティングオブジェクト。
パラメータ
HTMLElement element
カスタムフローティングオブジェクトのHTMLElement。
• 静的
FloatingObjectRemoved: string
ユーザーがフローティングオブジェクトを削除した後に発生します。
名前
GC.Spread.Sheets.Worksheet#FloatingObjectRemoved
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject
削除されたフローティングオブジェクト。
実例
// 次のサンプルコードは、FloatingObjectRemovedイベントを使用します。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
activeSheet.bind(GC.Spread.Sheets.Events.FloatingObjectRemoved, function (e, info) {
alert(info.sheetName);
});
• 静的
FloatingObjectRemoving: string
ユーザーがいずれかのフローティングオブジェクトを削除する前に発生します。
名前
GC.Spread.Sheets.Worksheet#FloatingObjectRemoving
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject
削除されるフローティングオブジェクト。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、FloatingObjectRemovingイベントを使用します。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
activeSheet.bind(GC.Spread.Sheets.Events.FloatingObjectRemoving, function (e, info) {
info.cancel = true;
});
• 静的
FloatingObjectSelectionChanged: string
フローティングオブジェクトの選択が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#FloatingObjectsSelectionChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.FloatingObjects.FloatingObject floatingObject
イベントを発生させたフローティングオブジェクト。
実例
// 次のサンプルコードは、FloatingObjectSelectionChangedイベントを使用します。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.FloatingObjectSelectionChanged, function (e, info) {
console.log("sheet name: " + info.sheetName);
});
• 静的
FormControlButtonClicked: string
ボタンフォームコントロールがクリックされたときに発生します。
名前
GC.Spread.Sheets.Worksheet#FormControlButtonClicked
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Shapes.Shape shape
イベントを発生させたシェイプ。
実例
// 次のサンプルコードは、FormControlButtonClickedイベントを使用します。
var shape = sheet.shapes.addFormControl("button", GC.Spread.Sheets.Shapes.FormControlType.button, 50, 50, 150, 100);
activeSheet.bind(GC.Spread.Sheets.Events.FormControlButtonClicked, function (e, info) {
console.log("event info: " + info);
});
• 静的
FormControlValueChanged: string
フォームコントロールの値が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#FormControlValueChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Shapes.Shape shape
イベントを発生させたシェイプ。
パラメータ
any newValue
フォームコントロールの新しい値。
パラメータ
any oldValue
フォーム コントロールの古い値。
実例
// 次のサンプルコードは、FormControlValueChangedイベントを使用します。
var shape = sheet.shapes.addFormControl('spin', GC.Spread.Sheets.Shapes.FormControlType.spinButton, 50, 50, 150, 100);
activeSheet.bind(GC.Spread.Sheets.Events.FormControlValueChanged, function (e, info) {
console.log("event info: " + info);
});
• 静的
InvalidOperation: string
無効な操作が実行されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#InvalidOperation
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.InvalidOperationType invalidType
どの操作が無効であったかを示します。
パラメータ
string message
無効な操作の説明。
パラメータ
GC.Spread.Sheets.Range [fillRange]
invalidTypeがdragFillの場合、範囲はフィル操作に使用されます。
実例
// 次のサンプルコードは、InvalidOperationイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.InvalidOperation, function (e, info) {
alert("Message (" + info.message + ")");
});
• 静的
LeaveCell: string
セルからフォーカスが離れると発生します。
名前
GC.Spread.Sheets.Worksheet#LeaveCell
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
フォーカスが離れるセルの行インデックス。
パラメータ
number col
フォーカスが離れるセルの列インデックス。
パラメータ
boolean cancel
操作をキャンセルするかどうか。
実例
// 次のサンプルコードは、LeaveCellイベントのログテキストを作成します。
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.LeaveCell, function (sender, args) {
console.log("The column index before moving: " + args.col);
console.log("The row index before moving: " + args.row);
});
• 静的
LeftColumnChanged: string
左列が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#LeftColumnChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number oldLeftCol
変更前の左列のインデックス。
パラメータ
number newLeftCol
変更後の左列のインデックス。
実例
//次のサンプルコードは、シート1とシート2の垂直および水平スクロールを同期させます。
var sheet1 = spread.getSheet(0),
sheet2 = spread.getSheet(1);
sheet1.bind(GC.Spread.Sheets.Events.TopRowChanged, function (sender, args) {
// シート1の一番上に表示されている行をシート2に設定します(垂直スクロールの同期)。
sheet2.showRow(args.newTopRow, GC.Spread.Sheets.VerticalPosition.top);
});
sheet1.bind(GC.Spread.Sheets.Events.LeftColumnChanged, function (sender, args) {
// シート1の一番左に表示されている列をシート2に設定します(水平スクロールの同期)。
sheet2.showColumn(args.newLeftCol, GC.Spread.Sheets.HorizontalPosition.left);
});
• 静的
OutlineColumnCheckStatusChanged: string
アウトライン列のチェックステータスが変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#OutlineColumnCheckStatusChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
アウトライン列の変更行インデックス。
パラメータ
number col
アウトライン列の変更列インデックス。
パラメータ
boolean status
アウトライン列の変更ステータス。
実例
// スパークラインを削除すると、変更が発生します。
activeSheet.bind(GC.Spread.Sheets.Events.OutlineColumnCheckStatusChanged, function (e, info) {
console.log("status: " + info.status);
});
• 静的
PictureChanged: string
いずれかのピクチャが変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#PictureChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.FloatingObjects.Picture picture
イベントを発生させたピクチャ。
パラメータ
string propertyName
変更されたピクチャのプロパティの名前。
実例
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
var activeSheet = spread.getActiveSheet();
activeSheet.pictures.add("f2","Event.png",2,2,6,6);
activeSheet.pictures.add("f1","tsoutline.png",3,0,6,6);
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.PictureChanged, function (e, info) {
console.log("Sheet: " + info.sheetName);
});
実例
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
var activeSheet = spread.getActiveSheet();
activeSheet.pictures.add("f2","Event.png",2,2,6,6);
activeSheet.pictures.add("f1","tsoutline.png",3,0,6,6);
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.PictureChanged, function (e, info) {
console.log("Property: " + info.propertyName);
});
• 静的
PictureSelectionChanged: string
ピクチャの選択が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#PictureSelectionChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.FloatingObjects.Picture picture
イベントを発生させたピクチャ。
実例
// 次のサンプルコードは、PictureSelectionChangedイベントを使用します。
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
var activeSheet = spread.getActiveSheet();
activeSheet.pictures.add("f2","Event.png",2,2,6,6);
activeSheet.pictures.add("f1","tsoutline.png",3,0,6,6);
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.PictureSelectionChanged, function (e, info) {
console.log("Sheet: " + info.sheetName);
});
• 静的
PivotTableChanged: string
ピボットテーブルのフィルター/並べ替え/折りたたみ/フィールドが変更された後に発生します。
名前
GC.Spread.Sheets.Worksheet#PivotTableChanged
パラメータ
string pivotTableName
PivotTableの名前。
パラメータ
string type
特定の操作名 (「filter」 | 「sort」 | 「collapse」 | 「fieldChanged」 | 「summarizedValueBy」 | 「showValueAs」 | 「dataPositionChanged」 | 「viewChanged」)。
パラメータ
string [fieldName]
変更されたフィールド名。
パラメータ
string [sourceName]
変更されたフィールド名。
パラメータ
boolean [oldValue]
ピボットテーブルは、前の属性(collapse、summaryValueBy、showValueAs)の値を変更します。
パラメータ
boolean [newValue]
ピボットテーブルは、前の属性(collapse、summaryValueBy、showValueAs)の値を変更します。
パラメータ
number [sortType]
ピボットテーブルの並べ替えは、属性(sort)の値を変更します。
パラメータ
Object [filterInfo]
ピボットテーブルフィルターは、属性(filter)の値を変更します。
パラメータ
number [clearType]
ピボットテーブルクリアフィルターは、属性(filter)の値を変更します。
パラメータ
number [oldArea]
古いピボットテーブルのフィールドの種類(fieldChanged)。
パラメータ
number [oldIndex]
古いピボットテーブルのフィールドインデックス(fieldChanged)。
パラメータ
number [newArea]
新しいピボットテーブルのフィールドの種類(fieldChanged)。
パラメータ
number [newIndex]
新しいピボットテーブルのフィールドインデックス(fieldChanged)。
パラメータ
string [viewName]
ピボットテーブルのビュー名(viewChanged)を適用します。
実例
// 次のサンプルコードは、PivotTableChangedの使用方法を示します。
sheet.bind(GC.Spread.Sheets.Events.PivotTableChanged, function (sender, args) {
alert("pivotTableName: " + args.pivotTableName + "changeType: " + args.type);
});
• 静的
RangeChanged: string
セル範囲が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#RangeChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
範囲の行インデックス。
パラメータ
number col
範囲の列インデックス。
パラメータ
number rowCount
範囲の行数。
パラメータ
number colCount
範囲の列数。
パラメータ
string[] tableNames
テーブル名のコレクション。
パラメータ
Object[] changedCells
データが変更されたセルの位置。各位置は行と列を持ちます。
パラメータ
GC.Spread.Sheets.RangeChangedAction action
RangeChangedイベントを発生させたアクションのタイプ。
パラメータ
boolean isUndo
このイベントが「元に戻す」操作から発生しましたかどうか。
実例
// 次のサンプルコードは、セル範囲が変更されたときにシート名とアクションをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.RangeChanged, function (sender, args) {
console.log(args.sheetName, args.action);
});
• 静的
RangeFilterCleared: string
列範囲のフィルタリング状態がクリアされた直後発生します。
名前
GC.Spread.Sheets.Worksheet#RangeFilterCleared
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number col
フィルタリング状態がクリアされたシートの列のインデックス。
実例
// 次のサンプルコードは、RangeFilterClearedイベントを使用します。
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
var cellRange =new GC.Spread.Sheets.Range(0, 0, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellRange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeFilterCleared, function (e, info) {
alert("Col (" + info.col + ")");
});
• 静的
RangeFilterClearing: string
列の範囲のフィルタリング状態が自動的にクリアされる直前に発生します。
名前
GC.Spread.Sheets.Worksheet#RangeFilterClearing
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number col
フィルタリング状態が自動的にクリアされるシートの列のインデックス。
実例
// 次のサンプルコードは、RangeFilterClearingイベントを使用します。
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
var cellRange =new GC.Spread.Sheets.Range(0, 0, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellRange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeFilterClearing, function (e, info) {
alert("Col (" + info.col + ")");
});
• 静的
RangeFiltered: string
列の自動フィルタリングが実行された直後に発生します。
名前
GC.Spread.Sheets.Worksheet#RangeFiltered
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number col
自動フィルタリングが実行された列のインデックス。
パラメータ
Array filterValues
列のフィルタリングに使用された値。
パラメータ
Array conditionInfo
列のフィルタリングに使用された条件ルール情報。
実例
// 次のサンプルコードは、RangeFilteredイベントを使用します。
var cellrange =new GC.Spread.Sheets.Range(0, 2, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeFiltered, function (e, info) {
alert("Col (" + info.col + ")");
});
• 静的
RangeFiltering: string
列の自動フィルタリングが実行される直前に発生します。
名前
GC.Spread.Sheets.Worksheet#RangeFiltering
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number col
自動的にフィルタリングされる列のインデックス。
パラメータ
Array filterValues
列のフィルタリングの基準となる値。
パラメータ
Object conditionInfo
列のフィルタリングの基準となる値。
実例
// 次のサンプルコードは、RangeFilteringイベントを使用します。
var cellrange =new GC.Spread.Sheets.Range(0, 2, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeFiltering, function (e, info) {
alert("Col (" + info.col + ")");
});
• 静的
RangeGroupStateChanged: string
ユーザーが行または列のアウトライン状態(範囲グループ)を変更した後に発生します。
名前
GC.Spread.Sheets.Worksheet#RangeGroupStateChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
boolean isRowGroup
このアウトライン(範囲グループ)が行のグループであるかどうか。
パラメータ
number index
状態が変更されたRangeGroupInfoオブジェクトのインデックス。
パラメータ
number level
状態が変更されたRangeGroupInfoオブジェクトのレベル。
実例
// 次のサンプルコードは、RangeGroupStateChangedイベントを使用します。
activeSheet.suspendPaint();
activeSheet.setRowCount(34);
activeSheet.setValue(0,0,"Western");
activeSheet.setValue(0,1,"Western");
activeSheet.setValue(0,2,"Western");
activeSheet.setValue(1,0,"A");
activeSheet.setValue(1,1,"B");
activeSheet.setValue(1,2,"C");
activeSheet.setValue(2,0,"A");
activeSheet.setValue(2,1,"B");
activeSheet.setValue(2,2,"C");
activeSheet.rowOutlines.group(0,2);
activeSheet.columnOutlines.group(0,1);
activeSheet.resumePaint();
activeSheet.bind(GC.Spread.Sheets.Events.RangeGroupStateChanged, function (e, info) {
alert("Level (" + info.level + ")");
});
• 静的
RangeGroupStateChanging: string
ユーザーが行または列のアウトライン状態(範囲グループ)を変更する前に発生します。
名前
GC.Spread.Sheets.Worksheet#RangeGroupStateChanging
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
boolean isRowGroup
このアウトライン(範囲グループ)が行のグループであるかどうか。
パラメータ
number index
状態が変更されるRangeGroupInfoオブジェクトのインデックス。
パラメータ
number level
状態が変更されるRangeGroupInfoオブジェクトのレベル。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、RangeGroupStateChangingイベントを使用します。
activeSheet.suspendPaint();
activeSheet.setRowCount(34);
activeSheet.setValue(0,0,"Western");
activeSheet.setValue(0,1,"Western");
activeSheet.setValue(0,2,"Western");
activeSheet.setValue(1,0,"A");
activeSheet.setValue(1,1,"B");
activeSheet.setValue(1,2,"C");
activeSheet.setValue(2,0,"A");
activeSheet.setValue(2,1,"B");
activeSheet.setValue(2,2,"C");
activeSheet.rowOutlines.group(0,2);
activeSheet.columnOutlines.group(0,1);
activeSheet.resumePaint();
activeSheet.bind(GC.Spread.Sheets.Events.RangeGroupStateChanging, function (e, info) {
alert("Level (" + info.level + ")");
});
• 静的
RangeSorted: string
列が自動ソートされた直後に発生します。
名前
GC.Spread.Sheets.Worksheet#RangeSorted
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number col
自動ソートが実行された列のインデックス。
パラメータ
boolean ascending
自動ソートが昇順かどうか。
実例
// 次のサンプルコードは、RangeSortedイベントを使用します。
activeSheet.setValue(0, 0, 10);
activeSheet.setValue(1, 0, 100);
activeSheet.setValue(2, 0, 50);
activeSheet.setValue(3, 0, 40);
activeSheet.setValue(4, 0, 80);
activeSheet.setValue(5, 0, 1);
activeSheet.setValue(6, 0, 65);
activeSheet.setValue(7, 0, 20);
activeSheet.setValue(8, 0, 30);
activeSheet.setValue(9, 0, 35);
var cellrange =new GC.Spread.Sheets.Range(0, 0, 5, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeSorted, function (e, info) {
alert("Col (" + info.col + ", " + info.ascending +")");
});
• 静的
RangeSorting: string
列の自動ソートが実行される直前に発生します。
名前
GC.Spread.Sheets.Worksheet#RangeSorting
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number col
自動的にソートされる列のインデックス。
パラメータ
boolean ascending
自動ソートが昇順かどうか。
パラメータ
boolean cancel
操作をキャンセルするかどうか。
パラメータ
GC.Spread.Sheets.Range range
自動ソートする範囲。
パラメータ
GC.Spread.Sheets.GroupSort groupSort
並べ替える時に使用するgroupSortレベル。デフォルトでは、並べ替える範囲に、グループが含まれている場合はグループレベルを使用し、グループが含まれていない場合はフラットレベルを使用します。
パラメータ
boolean ignoreHidden
非表示の値を無視して、表示値のみを並べ替えるかどうか。
パラメータ
Function compareFunction
ソート時に使用するカスタマイズされた関数。 値のソート時に使用されます。 関数(value1、value2){return 0;}
実例
// 次のサンプルコードは、RangeSortingイベントを使用します。
activeSheet.setValue(0, 0, 10);
activeSheet.setValue(1, 0, 100);
activeSheet.setValue(2, 0, 50);
activeSheet.setValue(3, 0, 40);
activeSheet.setValue(4, 0, 80);
activeSheet.setValue(5, 0, 1);
activeSheet.setValue(6, 0, 65);
activeSheet.setValue(7, 0, 20);
activeSheet.setValue(8, 0, 30);
activeSheet.setValue(9, 0, 35);
var cellrange =new GC.Spread.Sheets.Range(0, 0, 10, 1);
var hideRowFilter =new GC.Spread.Sheets.Filter.HideRowFilter(cellrange);
activeSheet.rowFilter(hideRowFilter);
activeSheet.bind(GC.Spread.Sheets.Events.RangeSorting, function (e, info) {
alert("Col (" + info.col + ", " + info.ascending +")");
info.groupSort = GC.Spread.Sheets.GroupSort.full; // 「フルレベル」ソートを使用します。
info.ignoreHidden = false; // 非表示の値で並べ替えます。
info.compareFunction = (obj1, obj2)=>{return obj1.toString().localeCompare(obj2.toString())};
});
• 静的
RowChanged: string
このシートの行または行範囲に、その行または行範囲の再描画が必要となるような変更が加えられたときに発生します。
名前
GC.Spread.Sheets.Worksheet#RowChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
行インデックス。
パラメータ
GC.Spread.Sheets.SheetArea sheetArea
行のシート領域。
パラメータ
string propertyName
変更された行のプロパティの名前。
パラメータ
boolean isUndo
このイベントが「元に戻す」操作から発生しましたかどうか。
実例
// 次のサンプルコードは、RowChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.RowChanged, function (e, info) {
alert("Row (" + info.row + ")");
});
• 静的
RowChanging: string
このシートの行または行範囲に変更を加える前に、その行または行範囲の再描画が必要となるような変更が加えられたときに発生します。
名前
GC.Spread.Sheets.Worksheet#RowChanging
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
行インデックス。
パラメータ
GC.Spread.Sheets.SheetArea sheetArea
行のシート領域。
パラメータ
string propertyName
変更された行のプロパティの名前。
実例
// 次のサンプルコードは、RowChangingイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.RowChanging, function (e, info) {
alert("Row (" + info.row + ")");
});
• 静的
RowHeightChanged: string
行の高さが変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#RowHeightChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
Array rowList
高さが変更された行の配列リスト。
パラメータ
boolean header
行が列ヘッダ行かどうか。
実例
// 次のサンプルコードは、RowHeightChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.RowHeightChanged, function (e, info) {
alert("Row List (" + info.rowList + ")");
});
• 静的
RowHeightChanging: string
行の高さが変更されるときに発生します。
名前
GC.Spread.Sheets.Worksheet#RowHeightChanging
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
Array rowList
高さが変更される行のリスト。
パラメータ
boolean header
行が列ヘッダ行かどうか。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、RowHeightChangingイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.RowHeightChanging, function (e, info) {
alert("Row List (" + info.rowList + ")");
});
• 静的
RowOperation: string
適用された行アクションが操作されたときに発生します。
名前
GC.Spread.Sheets.TableSheet.TableSheet#RowOperation
パラメータ
GC.Spread.Sheets.TableSheet.TableSheet sheet
イベントが発生したテーブルのシート。
パラメータ
string sheetName
テーブルシートの名前。
パラメータ
GC.Spread.Sheets.TableSheet.ActionType actionType
行上のアクションの種類。
パラメータ
number row
行インデックス。
実例
// 次のサンプルコードは、RowOperationイベントを使用します。
workbook.bind(GC.Spread.Sheets.Events.RowOperation, function (e, info) {
console.log(info.sheetName, info.actionType, info.row);
});
• 静的
SelectionChanged: string
シート上のセルの選択が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#SelectionChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
{@link GC.Spread.Sheets.Range[]} oldSelections
変更前の選択範囲。
パラメータ
{@link GC.Spread.Sheets.Range[]} newSelections
変更後の選択範囲。
実例
// 次のサンプルコードは、SelectionChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.SelectionChanged, function (e, info) {
alert("Name (" + info.sheetName + ")");
});
• 静的
SelectionChanging: string
シートのセルの選択範囲が変更されるときに発生します。
名前
GC.Spread.Sheets.Worksheet#SelectionChanging
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
{@link GC.Spread.Sheets.Range[]} oldSelections
変更前の選択範囲。
パラメータ
{@link GC.Spread.Sheets.Range[]} newSelections
変更後の選択範囲。
実例
// 次のサンプルコードは、SelectionChangingイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.SelectionChanging, function (e, info) {
// ログテキストをコンソールに表示します。
console.log("Name (" + info.sheetName + ")");
});
• 静的
ShapeChanged: string
いずれかのシェイプが変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#ShapeChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Shapes.Shape shape
イベントを発生させたシェイプ。
パラメータ
string propertyName
変更されたシェイプのプロパティの名前。
実例
// 次のサンプルコードは、ShapeChangedイベントを使用します。
var shape1 = activeSheet.shapes.add("shape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 20, 20, 200, 200);
activeSheet.bind(GC.Spread.Sheets.Events.ShapeChanged, function (e, info) {
alert("changed");
});
• 静的
ShapeRemoved: string
ユーザーがシェイプを削除した後に発生します。
名前
GC.Spread.Sheets.Worksheet#ShapeRemoved
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Shapes.Shape shape
削除されたシェイプ。
実例
// 次のサンプルコードは、ShapeRemovedイベントを使用します。
var shape = activeSheet.shapes.add("myShape", GC.Spread.Sheets.Shapes.AutoShapeType.diamond, 0, 90, 200, 200);
activeSheet.bind(GC.Spread.Sheets.Events.ShapeRemoved, function (e, info) {
alert(info.shape.name());
});
• 静的
ShapeRemoving: string
ユーザーがいずれかのシェイプを削除する前に発生します。
名前
GC.Spread.Sheets.Worksheet#ShapeRemoving
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Shapes.Shape shape
削除されるシェイプ。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、ShapeRemovingイベントを使用します。
var shape = sheet.shapes.add("myShape", GC.Spread.Sheets.Shapes.AutoShapeType.diamond, 0, 90, 200, 200);
activeSheet.bind(GC.Spread.Sheets.Events.ShapeRemoving, function (e, info) {
info.cancel = true;// シェイプは削除されません。
});
• 静的
ShapeSelectionChanged: string
シェイプの選択が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#ShapeSelectionChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Shapes.Shape shape
イベントを発生させたシェイプ。
実例
// 次のサンプルコードは、ShapeSelectionChangedイベントを使用します。
var shape = sheet.shapes.add("myShape", GC.Spread.Sheets.Shapes.AutoShapeType.diamond, 0, 90, 200, 200);
activeSheet.bind(GC.Spread.Sheets.Events.ShapeSelectionChanged, function (e, info) {
console.log("event info: " + info);
});
• 静的
SheetChanged: string
シートが変更された後に発生します。
名前
GC.Spread.Sheets.Worksheet#SheetChanged
パラメータ
string sheetName
シート名。
パラメータ
string propertyName
特定の操作の名前。
パラメータ
number sheetIndex
Worksheet コレクションまたは SheetTab コレクションに関連するシートインデックス。
パラメータ
number sheetPosition
すべての Worksheet と SheetTab を含む複合されたコレクションに関連するシート位置。
パラメータ
boolean oldValue
シートは前の属性(isVisible、isSelected ...)の値を変更します。
パラメータ
boolean newValue
シートは属性(isVisible、isSelected ...)の値を変更します。
実例
// 次のサンプルコードは、PivotTableChangedの使用方法を示します。
spread.bind(GC.Spread.Sheets.Events.SheetChanged, function (sender, args) {
var sheet = args.sheet;
});
• 静的
SheetChanging: string
シートが変更される前に発生します。
名前
GC.Spread.Sheets.Worksheet#SheetChanging
パラメータ
string sheetName
シート名。
パラメータ
string propertyName
特定の操作の名前。
パラメータ
number sheetIndex
Worksheet コレクションまたは SheetTab コレクションに関連するシートインデックス。
パラメータ
number sheetPosition
すべての Worksheet と SheetTab を含む複合されたコレクションに関連するシート位置。
パラメータ
boolean oldValue
シートは前の属性(isVisible、isSelected ...)の値を変更します。
パラメータ
boolean newValue
シートは属性(isVisible、isSelected ...)の値を変更します。
パラメータ
boolean cancel
現在の操作をキャンセルします。
実例
// 次のサンプルコードは、PivotTableChangedの使用方法を示します。
spread.bind(GC.Spread.Sheets.Events.SheetChanging, function (sender, args) {
var sheetIndex = args.sheetIndex;
args.cancel = true;
});
• 静的
SheetMoved: string
ユーザーがシートをドラッグして移動した後に発生します。
名前
GC.Spread.Sheets.Worksheet#SheetMoved
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number oldIndex
移動前のシートインデックス。
パラメータ
number newIndex
移動後のシートインデックス。
実例
// 次のサンプルコードは、SheetMovedイベントを使用します。
window.onload = function(){
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
var activeSheet = spread.getActiveSheet();
spread.bind(GC.Spread.Sheets.Events.SheetMoving, function (e, data) {
alert(data.sheetName + '\n' + 'oldIndex: ' + data.oldIndex + '\n' + 'newIndex: ' + data.newIndex + '\n' + 'cancel: ' + data.cancel);
});
spread.bind(GC.Spread.Sheets.Events.SheetMoved, function (e, data) {
alert(data.sheetName + '\n' + 'oldIndex: ' + data.oldIndex + '\n' + 'newIndex: ' + data.newIndex);
});
}
• 静的
SheetMoving: string
ユーザーがシートをドラッグして移動する前に発生します。
名前
GC.Spread.Sheets.Worksheet#SheetMoving
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number oldIndex
移動前のシートインデックス。
パラメータ
number newIndex
移動先のインデックスを示す値。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、SheetMovingイベントを使用します。
window.onload = function(){
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
var activeSheet = spread.getActiveSheet();
spread.bind(GC.Spread.Sheets.Events.SheetMoving, function (e, data) {
alert(data.sheetName + '\n' + 'oldIndex: ' + data.oldIndex + '\n' + 'newIndex: ' + data.newIndex + '\n' + 'cancel: ' + data.cancel);
});
spread.bind(GC.Spread.Sheets.Events.SheetMoved, function (e, data) {
alert(data.sheetName + '\n' + 'oldIndex: ' + data.oldIndex + '\n' + 'newIndex: ' + data.newIndex);
});
}
• 静的
SheetNameChanged: string
ユーザーがシート名を変更したときに発生します。
名前
GC.Spread.Sheets.Worksheet#SheetNameChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string oldValue
シートの古い名前。
パラメータ
string newValue
シートの新しい名前。
実例
// 次のサンプルコードは、SheetNameChangedイベントを使用します。
// ログテキストをコンソールに表示します。
spread.bind(GC.Spread.Sheets.Events.SheetNameChanging, function (sender, args) {
console.log(args.oldValue);
});
spread.bind(GC.Spread.Sheets.Events.SheetNameChanged, function (sender, args) {
console.log(args.newValue);
});
• 静的
SheetNameChanging: string
ユーザーがシート名を変更するときに発生します。
名前
GC.Spread.Sheets.Worksheet#SheetNameChanging
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string oldValue
シートの古い名前。
パラメータ
string newValue
シートの新しい名前。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、SheetNameChangingイベントを使用します。
// ログテキストをコンソールに表示します。
spread.bind(GC.Spread.Sheets.Events.SheetNameChanging, function (sender, args) {
console.log(args.oldValue);
});
spread.bind(GC.Spread.Sheets.Events.SheetNameChanged, function (sender, args) {
console.log(args.newValue);
});
• 静的
SheetTabClick: string
ユーザーがシートタブをクリックするときに発生します。
名前
GC.Spread.Sheets.Worksheet#SheetTabClick
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number sheetTabIndex
ユーザーがクリックしたシートタブのインデックス。
実例
// 次のサンプルコードは、SheetTabClickイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.SheetTabClick, function (e, info) {
alert("Index (" + info.sheetTabIndex + ")");
});
• 静的
SheetTabDoubleClick: string
ユーザーがシートタブをダブルクリックすると発生します。
名前
GC.Spread.Sheets.Worksheet#SheetTabDoubleClick
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number sheetTabIndex
ユーザーがダブルクリックしたシートタブのインデックス。
実例
// 次のサンプルコードは、SheetTabDoubleClickイベントを使用します。
spread.bind(GC.Spread.Sheets.Events.SheetTabDoubleClick, function (e, info) {
alert("Index (" + info.sheetTabIndex + ")");
});
• 静的
SlicerChanged: string
いずれかのスライサーが変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#SlicerChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Slicers.ISlicer slicer
イベントを発生させたスライサー。
パラメータ
string propertyName
変更されたスライサーのプロパティの名前。
実例
// 次のサンプルコードは、SlicerChangedイベントを使用します。
// テーブルを作成します。
datas = [
["1", "NewYork", "1968/6/8", "80", "180"],
["4", "NewYork", "1972/7/3", "72", "168"],
["4", "NewYork", "1964/3/2", "71", "179"],
["5", "Washington", "1972/8/8","80", "171"],
["6", "Washington", "1986/2/2", "89", "161"],
["7", "Washington", "2012/2/15", "71", "240"]];
var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
table.setColumnName(0, dataColumns[0]);
table.setColumnName(1, dataColumns[1]);
table.setColumnName(2, dataColumns[2]);
table.setColumnName(3, dataColumns[3]);
table.setColumnName(4, dataColumns[4]);
// スライサーをシートに追加し、スライサーインスタンスを返します。
var slicer = activeSheet.slicers.add("slicer1",table.name(),"Name");
// スライサーのプロパティを変更します。
slicer.width(200);
slicer.height(200);
slicer.position(new GC.Spread.Sheets.Point(100, 200));
slicer.style(GC.Spread.Sheets.Slicers.SlicerStyles.dark4());
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.SlicerChanged, function (e, info) {
console.log("name: " + info.propertyName);
});
• 静的
SparklineChanged: string
スパークラインが変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#SparklineChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Sparklines.Sparkline sparkline
プロパティが変更されたスパークライン。
実例
// スパークラインを削除すると、変更が発生します。
var data = new GC.Spread.Sheets.Range(1, 0, 8, 1);
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();
setting.options.showMarkers = true;
setting.options.lineWeight = 3;
setting.options.displayXAxis = true;
setting.options.showFirst = true;
setting.options.showLast = true;
setting.options.showLow = true;
setting.options.showHigh = true;
setting.options.showNegative = true;
setting.options.seriesColor = "Text 2 1";
setting.options.firstMarkerColor = "Text 2 3";
setting.options.negativeColor = "Accent 2 1";
setting.options.markersColor = "Accent 3 1";
setting.options.lowMarkerColor = "Accent 4 1";
setting.options.highMarkerColor = "Accent 6 1";
setting.options.lastMarkerColor = "Accent 6 6";
setting.options.axisColor = "Text 1 1";
activeSheet.addSpan(13, 0, 4, 3, null);
activeSheet.setSparkline(13, 0, data, GC.Spread.Sheets.Sparklines.DataOrientation.vertical, GC.Spread.Sheets.Sparklines.SparklineType.line, setting);
activeSheet.setValue(1, 0, 1);
activeSheet.setValue(2, 0, -2);
activeSheet.setValue(3, 0, -1);
activeSheet.setValue(4, 0, 6);
activeSheet.setValue(5, 0, 4);
activeSheet.setValue(6, 0, -4);
activeSheet.setValue(7, 0, 3);
activeSheet.setValue(8, 0, 8);
// ログテキストをコンソールに表示します。
activeSheet.bind(GC.Spread.Sheets.Events.SparklineChanged, function (e, info) {
console.log("name: " + info.sheetName);
});
$("#button1").click(function () {
activeSheet.removeSparkline(13, 0);
});
• 静的
TableColumnsChanged: string
ユーザーがテーブルに列を挿入/削除する場合に発生します。
名前
GC.Spread.Sheets.Worksheet#TableColumnsChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
GC.Spread.Sheets.Tables.Table table
行を挿入/削除するテーブル。
パラメータ
string propertyName
イベントを発生させる操作名。
パラメータ
number col
テーブルのインデックスに基づいて挿入/削除する最初列のインデックス。
パラメータ
number count
挿入/削除する列数。
パラメータ
boolean isAfter
指定した列インデックスの前または後に列を挿入するかどうか。 デフォルトの値はfalse(前に挿入すること)です。
実例
// 次のサンプルコードは、TableColumnsChangedイベントを使用します。
window.onload = function(){
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
var activeSheet = spread.getActiveSheet();
spread.bind(GC.Spread.Sheets.Events.TableColumnsChanged, function (e, data) {});
}
• 静的
TableFilterCleared: string
テーブル列のフィルタリング状態がクリアされた直後に発生します。
名前
GC.Spread.Sheets.Worksheet#TableFilterCleared
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Tables.Table table
自動的にフィルタリングされるテーブルの列。
パラメータ
number tableCol
フィルタリング状態がクリアされたテーブル列のインデックス。
実例
// 次のサンプルコードは、TableFilterClearedイベントを使用します。
activeSheet.tables.add("Table1", 0, 0, 3, 3, GC.Spread.Sheets.Tables.TableTheme.dark1);
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
activeSheet.bind(GC.Spread.Sheets.Events.TableFilterCleared, function (e, info) {
alert("Sheet (" + info.sheetName + ")");
});
• 静的
TableFilterClearing: string
テーブル列のフィルタリング状態が自動的にクリアされる直前に発生します。
名前
GC.Spread.Sheets.Worksheet#TableFilterCleared
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Tables.Table table
自動的にフィルタリングされるテーブルの列。
パラメータ
number tableCol
フィルタリング状態が自動的にクリアされるテーブル列のインデックス。
実例
// 次のサンプルコードは、TableFilterClearingイベントを使用します。
activeSheet.tables.add("Table1", 0, 0, 3, 3, GC.Spread.Sheets.Tables.TableTheme.dark1);
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
activeSheet.bind(GC.Spread.Sheets.Events.TableFilterClearing, function (e, info) {
alert("Sheet (" + info.sheetName + ")");
});
• 静的
TableFiltered: string
テーブル列が自動的にフィルタリングされた直後に発生します。
名前
GC.Spread.Sheets.Worksheet#TableFiltered
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Tables.Table table
自動的にフィルタリングされるテーブルの列。
パラメータ
number col
自動的にフィルタリングされる列のインデックス。
パラメータ
Array filterValues
列のフィルタリングの基準となる値。
パラメータ
Object conditionInfo
列のフィルタリングの基準となる値。
実例
// 次のサンプルコードは、TableFilteredイベントを使用します。
activeSheet.tables.add("Table1", 0, 0, 3, 3, GC.Spread.Sheets.Tables.TableTheme.dark1);
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
activeSheet.bind(GC.Spread.Sheets.Events.TableFiltered, function (e, info) {
alert("Sheet (" + info.sheetName + ")");
});
• 静的
TableFiltering: string
テーブル列が自動的にフィルタリングされる直前に発生します。
名前
GC.Spread.Sheets.Worksheet#TableFiltering
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
GC.Spread.Sheets.Tables.Table table
自動的にフィルタリングされるテーブルの列。
パラメータ
number col
自動的にフィルタリングされる列のインデックス。
パラメータ
Array filterValues
列のフィルタリングの基準となる値。
パラメータ
Object conditionInfo
列のフィルタリングの基準となる値。
実例
// 次のサンプルコードは、TableFilteringイベントを使用します。
activeSheet.tables.add("Table1", 0, 0, 3, 3, GC.Spread.Sheets.Tables.TableTheme.dark1);
activeSheet.getCell(0,0).text("Name");
activeSheet.getCell(0,1).text("Value");
activeSheet.getCell(0,2).text("T/F");
activeSheet.getCell(1,0).text("AW");
activeSheet.getCell(1,1).text("5");
activeSheet.getCell(1,2).text("T");
activeSheet.bind(GC.Spread.Sheets.Events.TableFiltering, function (e, info) {
alert("Sheet (" + info.sheetName + ")");
});
• 静的
TableResized: string
ユーザーがテーブルのサイズを変更した後に発生します。
名前
GC.Spread.Sheets.Worksheet#TableResized
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
GC.Spread.Sheets.Tables.Table table
サイズ変更されたテーブル。
パラメータ
GC.Spread.Sheets.Range oldRange
サイズ変更前のテーブル範囲。
パラメータ
GC.Spread.Sheets.Range newRange
サイズ変更後のテーブル範囲。
• 静的
TableResizing: string
ユーザーがサイズ変更ハンドラによってテーブルのサイズを変更する時に発生します。
名前
GC.Spread.Sheets.Worksheet#TableResizing
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
GC.Spread.Sheets.Tables.Table table
サイズ変更されるテーブル。
パラメータ
GC.Spread.Sheets.Range oldRange
サイズ変更前のテーブル範囲。
パラメータ
GC.Spread.Sheets.Range newRange
サイズ変更後のテーブル範囲。
実例
// 次のサンプルコードは、TableResizingイベントおよびTableResizedイベントを使用します。
window.onload = function(){
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
var activeSheet = spread.getActiveSheet();
spread.bind(GC.Spread.Sheets.Events.TableResizing, function (e, data) {});
spread.bind(GC.Spread.Sheets.Events.TableResized, function (e, data) {});
}
• 静的
TableRowsChanged: string
ユーザーがテーブルに行を挿入/削除する場合に発生します。
名前
GC.Spread.Sheets.Worksheet#TableRowsChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
GC.Spread.Sheets.Tables.Table table
行を挿入/削除するテーブル。
パラメータ
string propertyName
イベントを発生させる操作名。
パラメータ
number row
テーブルのインデックスに基づいて挿入/削除する最初行のインデックス。
パラメータ
number count
挿入/削除する行数。
パラメータ
boolean isAfter
指定した行インデックスの前または後に行を挿入するかどうか。 デフォルトの値はfalse(前に挿入すること)です。
パラメータ
Object[] deletedItem
バインドで削除された行のコレクション。配列内に削除されたデータ項目を指定します。
実例
// 次のサンプルコードは、TableRowsChangedイベントを使用します。
window.onload = function(){
var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
var activeSheet = spread.getActiveSheet();
spread.bind(GC.Spread.Sheets.Events.TableRowsChanged, function (e, data) {});
}
• 静的
TopRowChanged: string
先頭の行が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#TopRowChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number oldTopRow
変更前の一番上の行のインデックス。
パラメータ
number newTopRow
変更後の一番上の行のインデックス。
実例
//次のサンプルコードは、シート1とシート2の垂直および水平スクロールを同期させます。
var sheet1 = spread.getSheet(0),
sheet2 = spread.getSheet(1);
sheet1.bind(GC.Spread.Sheets.Events.TopRowChanged, function (sender, args) {
// シート1の一番上に表示されている行をシート2に設定します(垂直スクロールの同期)。
sheet2.showRow(args.newTopRow, GC.Spread.Sheets.VerticalPosition.top);
});
sheet1.bind(GC.Spread.Sheets.Events.LeftColumnChanged, function (sender, args) {
// シート1の一番左に表示されている列をシート2に設定します(水平スクロールの同期)。
sheet2.showColumn(args.newLeftCol, GC.Spread.Sheets.HorizontalPosition.left);
});
• 静的
TouchToolStripOpening: string
タッチツールバーがポップアップする前に発生します。
名前
GC.Spread.Sheets.Worksheet#TouchToolStripOpening
パラメータ
number x
The x-水平位置の座標。
パラメータ
number y
The y-垂直位置の座標。
パラメータ
boolean handled
タッチツールバーがポップアップしないようにする場合はtrue
。それ以外の場合は、デフォルト位置にツールバーが表示されます。
実例
// 次のサンプルコードは、TouchToolStripOpeningイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.TouchToolStripOpening, function (e, info) {
alert(info.x);
});
• 静的
UserFormulaEntered: string
ユーザーが数式を入力するときに発生します。
名前
GC.Spread.Sheets.Worksheet#UserFormulaEntered
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
ユーザーが数式を入力したセルの行インデックス。
パラメータ
number col
ユーザーが数式を入力したセルの列インデックス。
パラメータ
string formula
ユーザーが入力した数式。
パラメータ
boolean isCircularReference
入力された数式が循環参照です。
実例
// 次のサンプルコードは、UserFormulaEnteredイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.UserFormulaEntered, function (e, info) {
alert("Formula (" + info.formula + ")");
});
• 静的
ValidationError: string
適用されたセル値が無効なときに発生します。
名前
GC.Spread.Sheets.Worksheet#ValidationError
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
セルの行インデックス。
パラメータ
number col
セルの列インデックス。
パラメータ
GC.Spread.Sheets.DataValidation.DefaultDataValidator validator
エラーを発生させたデータバリデーター。
パラメータ
GC.Spread.Sheets.DataValidation.DataValidationResult validationResult
エラーの処理方法を決定するためにユーザーが設定できるポリシー。
実例
// 次のサンプルコードは、ValidationErrorイベントを使用します。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.cellValueCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.equalsTo);
nCondition.expected(0);
// 次のオプションがfalseの場合、検証は失敗し、赤のアラートが表示されます。
// 次のオプションがtrueの場合、空白セルはゼロとして扱われ、検証は成功します。
nCondition.treatNullValueAsZero(false);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition)
validator.ignoreBlank(false);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.wholeNumber)
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, null);
// セル(0,0)に別の値を入力します。ユーザーが無効な値を入力すると、このイベントが発生します。
activeSheet.bind("ValidationError", vError);
function vError(sender, args) {
alert("error");
}
• 静的
ValueChanged: string
サブエディタの値が変更されたときに発生します。
名前
GC.Spread.Sheets.Worksheet#ValueChanged
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number row
セルの行インデックス。
パラメータ
number col
セルの列インデックス。
パラメータ
Object oldValue
セルの古い値。
パラメータ
Object newValue
セルの新しい値。
実例
// 次のサンプルコードは、ValueChangedイベントを使用します。
activeSheet.bind(GC.Spread.Sheets.Events.ValueChanged, function (e, info) {
alert("Value (" + info.newValue + ")");
});
• 静的
ViewZoomed: string
ユーザーがズームを実行した後に発生します。
名前
GC.Spread.Sheets.Worksheet#ViewZoomed
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number newZoomFactor
変更後のズーム率。
パラメータ
number oldZoomFactor
変更前のズーム率。
実例
// 次のサンプルコードは、ViewZoomedイベントを使用します。
spread.options.allowUserZoom = true;
activeSheet.bind(GC.Spread.Sheets.Events.ViewZoomed, function (e, info) {
alert("Zoom (" + info.newZoomFactor + ")");
});
• 静的
ViewZooming: string
ユーザーがズームを実行するときに発生します。
名前
GC.Spread.Sheets.Worksheet#ViewZooming
パラメータ
GC.Spread.Sheets.Worksheet sheet
イベントを発生させたシート。
パラメータ
string sheetName
シート名。
パラメータ
number newZoomFactor
新しい表示倍率。ユーザーが、実際のズーム操作に介入するために変更を加えることができます。
パラメータ
number oldZoomFactor
変更前のズーム率。
パラメータ
boolean cancel
操作をキャンセルするかどうかを示す値。
実例
// 次のサンプルコードは、ViewZoomingイベントを使用して、最大のズームレベルを制限します。
spread.options.allowUserZoom = true;
activeSheet.bind(GC.Spread.Sheets.Events.ViewZooming, function (e, info) {
if (info.newZoomFactor >= 2) {
info.newZoomFactor = 2;
}
});