GC.Spread.Sheets.Events

Class: Events

Spread.Sheets.Events

Constructors

constructor

Events

Constructors

constructor

• new Events()

Defines the events supported in SpreadJS.

Events

ActiveSheetChanged

• Static ActiveSheetChanged: string

Occurs when the user has changed the active sheet.

name GC.Spread.Sheets.Workbook#ActiveSheetChanged

param GC.Spread.Sheets.Worksheet oldSheet The old sheet.

param GC.Spread.Sheets.Worksheet newSheet The new sheet.

example

//This example creates log text for the ActiveSheetChanged event.
// Use web browser to see the console log text
spread.bind(GC.Spread.Sheets.Events.ActiveSheetChanged, function (sender, args) {
    console.log("Active sheet has been switched.");
});

ActiveSheetChanging

• Static ActiveSheetChanging: string

Occurs when the user is changing the active sheet.

name GC.Spread.Sheets.Workbook#ActiveSheetChanging

param GC.Spread.Sheets.Worksheet oldSheet The old sheet.

param GC.Spread.Sheets.Worksheet newSheet The new sheet.

param boolean cancel A value that indicates whether the operation should be canceled.

example

//This example stops the active sheet from changing.
spread.bind(GC.Spread.Sheets.Events.ActiveSheetChanging, function (sender, args) {
    //Cancel sheet switching.
    args.cancel = true;
});

BeforePrint

• Static BeforePrint: string

Occurs before the print

name GC.Spread.Sheets.WorkBook.BeforePrint

param Object iframe The print Dom

param boolean cancel Whether cancel print

example

//This example uses the 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

• Static ButtonClicked: string

Occurs when the user clicks a button, check box, or hyperlink in a cell.

name GC.Spread.Sheets.Workbook#ButtonClicked

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param number row The row index of the cell.

param number col The column index of the cell.

param GC.Spread.Sheets.SheetArea sheetArea The sheet area that contains the cell.

example

//This example creates a button cell.
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
activeSheet.setCellType(1,1,cellType);
//bind
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");
    }
});

CalculationProgress

• Static CalculationProgress: string

Occurs when the calculate with incrementalCalculation.

name GC.Spread.Sheets.Workbook#CalculationProgress

param number totalCells The count of total calculate cells.

param number pendingCells The count of cells needed to be calculated.

param number iterate The count of iterative calculation has done, only available when the iterative calculation.

example

//This example uses the CalculationProgress event, to log the calculation progress.
spread.options.incrementalCalculation = true;
spread.bind(GC.Spread.Sheets.Events.CalculationProgress, function (e, info) {
     var msg = "Calculate ";
     if (info.pendingCells === 0) {
         msg += "finished";
     } else if (info.iterate >= 0) {
         msg += info.pendingCells + " cells in iterative calculation round " + info.iterate;
     } else {
         msg += (info.totalCells - info.pendingCells) + "/" + info.totalCells + "cells";
     }
     console.log(msg)
});

CellChanged

• Static CellChanged: string

Occurs when a change is made to a cell in this sheet that may require the cell to be repainted.

name GC.Spread.Sheets.Worksheet#CellChanged

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param number row The row index of the cell.

param number col The column index of the cell.

param GC.Spread.Sheets.SheetArea sheetArea The sheetArea of the cell.

param string propertyName The name of the cell's property that has changed.

param boolean isUndo Whether this event is from a undo operation.

example

//This example uses the CellChanged event.
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

• Static CellClick: string

Occurs when the user presses down the left mouse button in a cell.

name GC.Spread.Sheets.Worksheet#CellClick

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param GC.Spread.Sheets.SheetArea sheetArea The sheet area the clicked cell is in.

param number row The row index of the clicked cell.

param number col The column index of the clicked cell.

example

//This example uses the CellClick event.
// Use web browser to see the console log text
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);
});
//bind
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

• Static CellDoubleClick: string

Occurs when the user presses down the left mouse button twice (double-clicks) in a cell.

name GC.Spread.Sheets.Worksheet#CellDoubleClick

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param GC.Spread.Sheets.SheetArea sheetArea The sheet area the clicked cell is in.

param number row The row index of the clicked cell.

param number col The column index of the clicked cell.

example

//This example uses the CellDoubleClick event.
// Use web browser to see the console log text
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);
});
//bind
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

• Static ClipboardChanged: string

Occurs when a Clipboard change occurs that affects Spread.Sheets.

name GC.Spread.Sheets.Worksheet#ClipboardChanged

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param Object copyData The data from Spread.Sheets that has been set into the clipboard.

param string copyData.text The text string of the clipboard.

param string copyData.html The html string of the clipboard.

param Array objects The copied floating objects, it contains picture, custom floating object, slicer, chart and shape.

example

//This example uses the ClipboardChanged event.
spread.bind(GC.Spread.Sheets.Events.ClipboardChanged, function (sender, args) {
    console.log("ClipboardChanged.", args);
});

ClipboardChanging

• Static ClipboardChanging: string

Occurs when the Clipboard is changing due to a Spread.Sheets action.

name GC.Spread.Sheets.Worksheet#ClipboardChanging

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param Object copyData The data from Spread.Sheets that is set into the clipboard.

param string copyData.text The text string of the clipboard.

param string copyData.html The html string of the clipboard.

param {@link GC.Spread.Sheets.Range[]} ranges The source ranges of the source sheet for current cut or copy operation.

param GC.Spread.Sheets.ClipboardActionType action Indicates the type of the current action.

param Array objects The coping floating objects, it contains picture, custom floating object, slicer, chart and shape.

param boolean cancel A value that indicates whether the operation should be canceled.

example

//This example uses the ClipboardChanging event.
spread.bind(GC.Spread.Sheets.Events.ClipboardChanging, function (sender, args) {
    console.log("ClipboardChanging", args);
});

ClipboardPasted

• Static ClipboardPasted: string

Occurs when the user pastes from the Clipboard.

name GC.Spread.Sheets.Worksheet#ClipboardPasted

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param GC.Spread.Sheets.Range cellRange The range that was pasted.

param GC.Spread.Sheets.ClipboardPasteOptions pasteOption The paste option that indicates what data is pasted from the clipboard: values, formatting, or formulas.

param Object pasteData The data from the clipboard that will be pasted into Spread.Sheets.

param string pasteData.text The text string of the clipboard.

param string pasteData.html The html string of the clipboard.

param string pasteData.image The image src string of the clipboard.

param GC.Spread.Sheets.Worksheet fromSheet the source sheet of data range.

param GC.Spread.Sheets.Range [fromRange] The source range of paste when copy or cut range.

param GC.Spread.Sheets.ClipboardActionType action Indicates the type of the current action.

param Array objects The pasted floating objects, it contains picture, custom floating object, slicer, chart and shape.

param GC.Spread.Sheets.InsertShiftCell [shiftCells] The shift cells option, if not shift cell, will be undefined.

example

//This example uses the ClipboardPasted event.
spread.bind(GC.Spread.Sheets.Events.ClipboardPasted, function (sender, args) {
    console.log("ClipboardPasted", args);
});

ClipboardPasting

• Static ClipboardPasting: string

Occurs when the user is pasting from the Clipboard.

name GC.Spread.Sheets.Worksheet#ClipboardPasting

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param GC.Spread.Sheets.Range cellRange The range to paste.

param GC.Spread.Sheets.ClipboardPasteOptions pasteOption The paste option that indicates what data is pasted from the clipboard: values, formatting, or formulas.

param Object pasteData The data from the clipboard that will be pasted into Spread.Sheets.

param string pasteData.text The text string of the clipboard.

param string pasteData.html The html string of the clipboard.

param string pasteData.image The image src string of the clipboard.

param GC.Spread.Sheets.Worksheet fromSheet the source sheet of data range.

param GC.Spread.Sheets.Range [fromRange] The source range of paste when copy or cut range.

param GC.Spread.Sheets.ClipboardActionType action Indicates the type of the current action.

param Array objects The pasting floating objects, it contains picture, custom floating object, slicer, chart and shape.

param boolean cancel A value that indicates whether the operation should be canceled.

param GC.Spread.Sheets.InsertShiftCell [shiftCells] The shift cells option, if not shift cell, will be undefined.

example

//This example uses the ClipboardPasting event.
spread.bind(GC.Spread.Sheets.Events.ClipboardPasting, function (sender, args) {
    console.log("ClipboardPasting", args);
});

CollaborationEndRedo

• Static CollaborationEndRedo: string

After the redo in collaboration.

name GC.Spread.Sheets.Worksheet#CollaborationEndRedo

param object changeSet The redo operation object.

example

//This example.
workbook.bind(GC.Spread.Sheets.Events.CollaborationEndRedo, (sender, args) => {
    const changeSet = args.changeSet;
    console.log('redo changeSet is:' changeSet);
});

CollaborationEndUndo

• Static CollaborationEndUndo: string

After the undo in collaboration.

name GC.Spread.Sheets.Worksheet#CollaborationEndUndo

param object changeSet The undo operation object.

example

//This example.
workbook.bind(GC.Spread.Sheets.Events.CollaborationEndUndo, (sender, args) => {
    const changeSet = args.changeSet;
    console.log('undo changeSet is:' changeSet);
});

CollaborationStartRedo

• Static CollaborationStartRedo: string

Before the redo in collaboration.

name GC.Spread.Sheets.Worksheet#CollaborationStartRedo

param object changeSet The redo operation object.

example

//This example.
workbook.bind(GC.Spread.Sheets.Events.CollaborationStartRedo, (sender, args) => {
    const changeSet = args.changeSet;
    console.log('redo changeSet is:' changeSet);
});

CollaborationStartUndo

• Static CollaborationStartUndo: string

Before the undo in collaboration.

name GC.Spread.Sheets.Worksheet#CollaborationStartUndo

param object changeSet The undo operation object.

example

//This example.
workbook.bind(GC.Spread.Sheets.Events.CollaborationStartUndo, (sender, args) => {
    const changeSet = args.changeSet;
    console.log('undo changeSet is:' changeSet);
});

ColumnChanged

• Static ColumnChanged: string

Occurs when a change is made to a column or range of columns in this sheet that may require the column or range of columns to be repainted.

name GC.Spread.Sheets.Worksheet#ColumnChanged

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param number col The column index.

param GC.Spread.Sheets.SheetArea sheetArea The sheetArea of the column.

param string propertyName The name of the column's property that has changed.

param boolean isUndo Whether this event is from a undo operation.

example

//This example uses the ColumnChanged event.
activeSheet.bind(GC.Spread.Sheets.Events.ColumnChanged, function (e, info) {
    if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
        alert("Index (" + info.col + ")");
    }
});

ColumnChanging

• Static ColumnChanging: string

Occurs when before a change is made to a column or range of columns in this sheet that may require the column or range of columns to be repainted.

name GC.Spread.Sheets.Worksheet#ColumnChanging

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param number col The column index.

param GC.Spread.Sheets.SheetArea sheetArea The sheetArea of the column.

param string propertyName The name of the column's property that has changed.

example

//This example uses the ColumnChanging event.
activeSheet.bind(GC.Spread.Sheets.Events.ColumnChanging, function (e, info) {
    if(info.sheetArea === GC.Spread.Sheets.SheetArea.viewport){
        alert("Index (" + info.col + ")");
    }
});

ColumnWidthChanged

• Static ColumnWidthChanged: string

Occurs when the column width has changed.

name GC.Spread.Sheets.Worksheet#ColumnWidthChanged

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param Array colList The list of columns whose widths have changed.

param boolean header Whether the columns are row header columns.

example

//This example uses the ColumnWidthChanged event.
activeSheet.bind(GC.Spread.Sheets.Events.ColumnWidthChanged, function (e, info) {
        alert("Column (" + info.colList + ")");
});

ColumnWidthChanging

• Static ColumnWidthChanging: string

Occurs when the column width is changing.

name GC.Spread.Sheets.Worksheet#ColumnWidthChanging

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param Array colList The list of columns whose widths are changing.

param boolean header Whether the columns are row header columns.

param boolean cancel A value that indicates whether the operation should be canceled.

example

//This example uses the ColumnWidthChanging event.
activeSheet.bind(GC.Spread.Sheets.Events.ColumnWidthChanging, function (e, info) {
        alert("Column (" + info.colList + ")");
});

CommentChanged

• Static CommentChanged: string

Occurs when any comment has changed.

name GC.Spread.Sheets.Worksheet#CommentChanged

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param GC.Spread.Sheets.Comments.Comment comment The comment that triggered the event.

param string propertyName The name of the comment's property that has changed.

example

//This example uses the CommentChanged event.
activeSheet.bind(GC.Spread.Sheets.Events.CommentChanged, function (e, info) {
    alert("changed");
});

CommentRemoved

• Static CommentRemoved: string

Occurs when the user has removed the comment.

name GC.Spread.Sheets.Worksheet#CommentRemoved

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param GC.Spread.Sheets.Comments.Comment comment The comment has been removed.

example

//This example uses the CommentRemoved event.
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

• Static CommentRemoving: string

Occurs when the user is removing any comment.

name GC.Spread.Sheets.Worksheet#CommentRemoving

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param GC.Spread.Sheets.Comments.Comment comment The comment is being removed.

param boolean cancel A value that indicates whether the operation should be canceled.

example

//This example prevents the comment from being removed.
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;
});

DataFetchCompleted

• Static DataFetchCompleted: string

Occurs when all tables from data manager fetched completely through the workbook opening or importing the sjs/json format file.

name GC.Spread.Sheets.Worksheet#DataFetchCompleted

param GC.Spread.Sheets.Workbook spread The workbook that triggered the event.

example

//This example uses the DataFetchCompleted event.
//In general, the DataFetchCompleted event is triggered after the successCallback of the workbook open method invoked.
//If doesn\u2019t use any table of data manager, and the Workbook contains a lot of Worksheet, the DataFetchCompleted event could be triggered before the successCallback of the workbook open method invoked.
let isOpenFinished = false, isDataFetchCompleted = false;
spread.bind(GC.Spread.Sheets.Events.DataFetchCompleted, function () {
    isDataFetchCompleted = true;
    if (isOpenFinished) {
        // do something with data fetched
    }
});
spread.open(file, function () {
    isOpenFinished = true;
    if (isDataFetchCompleted) {
        // do something with file opened
    }
}, function () { }, {});

DragDropBlock

• Static DragDropBlock: string

Occurs when the user is dragging and dropping a range of cells.

name GC.Spread.Sheets.Worksheet#DragDropBlock

param GC.Spread.Sheets.Worksheet sheet The sheet that triggered the event.

param string sheetName The sheet's name.

param number fromRow The row index of the top left cell of the source range (range being dragged).

param number fromCol The column index of the top left cell of the source range (range being dragged).

param number toRow The row index of the top left cell of the destination range (where selection is dropped).

param number toCol The column index of the bottom right cell of the destination range (where selection is dropped).

param number rowCount The row count of the cell range being dragged.

param number colCount The column count of the cell range being dragged.

param boolean copy Whether the source range is copied.

param boolean insert Whether the source range is inserted.

param GC.Spread.Sheets.CopyToOptions copyOption The CopyOption value for the drag and drop operation.

param boolean cancel A value that indicates whether the operation should be canceled.

example

//This example creates log text for the DragDropBlock event.
// Use web browser to see the console log text
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

• Static DragDropBlockCompleted: string

Occurs when the user completes dragging and dropping a range of cells.

name GC.Spread.Sheets.Worksheet#DragDropBlockCompleted