Event listeners

Implementation

demo.on('event-name', function(data) {
    // do something...
})

Event list

Examples

• File open

  • Example

    demo.on('fileOpen', function(data) {
        // do something...
    })

  • If the event is successful, the following result is returned:

    {
        "success": true,
        "time": 111, // Open duration.
        "fileInfo": {
          name: "Seating Chart",
          officeType: "w",
          id: "64784347535"
        }
    }

  • If the event fails, the following result is returned:

    {
        "success": true,
        "time": 111,
        "reason": "InvalidLink", // An error code is returned on failure.
    }

• Error event

  • Example

    demo.on('error', function(data) {
        // do something...
    })

  • Returned result

    ```javascript
    {
        "reason": "InvalidLink", // An error code is returned on failure.
    }

    For more information about error codes, see Error codes.

• Header tab switch

  • Example

    demo.on('tabSwitch', function(data) {
        // do something...
    })

  • Returned result

    {
      tabKey: 1 // The ordinal number of the current tab.
    }

• File save status

  • Example

    demo.on('fileStatus', function() {
        // do something...
    })

  • Returned result

    {
      status: 0, // No document updates.
      status: 1, // Version saved. Triggered by manual save, scheduled save, or closing the page.
      status: 2, // Cannot save empty file. Triggered if file is empty after kernel save.
      status: 3, // Storage space is full.
      status: 4, // Saving in progress. Avoid frequent operations. Triggered when server-side save queue is full.
      status: 5, // Save failed.
      status: 6, // Saving file update. Triggered by save after content modification.
      status: 7, // Saved successfully. Triggered when modified content is saved.
    }

• Preview page limit

  • Example

    demo.on('previewLimit', function(result) {
        // do something...
    })

  • Returned result

    Note

    Because text documents use a stream layout, the exact number of actual pages cannot be determined. Therefore, the returned result contains only the total parameter.

    // Text document.
    {
        total: 4 // The number of limited pages.
    }
    // PDF and presentation documents.
    {
        total: 4, // The number of limited pages.
        realTotal: 10 // The total number of real pages.
    }

• Does the document include a table of contents?

  Example:

  demo.on('hasDocMap', function() {
      // If the document has a table of contents, the callback is executed.
  }) 

• Enter or exit full screen mode

  • Example

    demo.on('fullscreenchange', , function(result) {
        // do something...
    })

  • Returned result

    {
      status: 0, // Triggered when exiting full screen mode.
      status: 1, // Triggered when entering full screen mode.
    }

Error codes