Class: Events

Sheets.Designer.Events

Table of contents

Constructors

• constructor

Events

• DesignerResetDone
• FileLoaded
• FileLoading

Constructors

constructor

• new Events()

Defines the events supported in SpreadJS designer.

Events

DesignerResetDone

• Static DesignerResetDone: string

Occurs when the designer has finished resetting, such as when creating a new file or switching templates. This event fires after all reset and loading operations are complete.

name GC.Spread.Sheets.Designer#DesignerResetDone

example

//This example uses the DesignerResetDone event.
let designer = GC.Spread.Sheets.Designer.findControl(document.getElementById("gc-designer-container"));
designer.bind(GC.Spread.Sheets.Designer.Events.DesignerResetDone, (event, data)=>{
  console.log("designer reset done");
 });

FileLoaded

• Static FileLoaded: string

Occurs when the file has loaded due to a Spread.Sheets.Designer file action.

name GC.Spread.Sheets.Designer#FileLoaded

param GC.Spread.Sheets.Designer designer The designer that triggered the event.

param GC.Spread.Sheets.Designer.FileType fileType The import file type.

example

//This example uses the FileLoaded event.
let designer = GC.Spread.Sheets.Designer.findControl(document.getElementById("gc-designer-container"));
designer.bind(GC.Spread.Sheets.Designer.Events.FileLoaded, (event, data)=>{
  console.log("file has loaded");
 });

FileLoading

• Static FileLoading: string

Occurs when the file is loading due to a Spread.Sheets.Designer file action.

name GC.Spread.Sheets.Designer#FileLoading

param GC.Spread.Sheets.Designer designer The designer that triggered the event.

param GC.Spread.Sheets.Designer.FileType fileType The import file type.

param string fileName The import file name.

param Object | string data The data from file json data or csv data or original file.

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

example

//This example uses the FileLoading event.
let designer = GC.Spread.Sheets.Designer.findControl(document.getElementById("gc-designer-container"));
designer.bind(GC.Spread.Sheets.Designer.Events.FileLoading, (event, data)=>{
  console.log("file is loading");
 });