Spreadsheet Events

This section describes Spreadsheet-related events available in Model contexts.

Spreadsheet Cells Updated

This event fires when Spreadsheet cell data is updated.

Event Name:

spreadsheetCellsUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the updated Spreadsheet.

cells

Data Table

Cells. List of updated cells (see Cell).

updater

String

Updater. Name or login of the user who made the changes.

Spreadsheet Cells Values Updated

This event fires when Spreadsheet cell values or cell errors are updated.

Event Name:

spreadsheetCellsValuesUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the updated Spreadsheet.

cells

Data Table

Cells. List of updated cells.

The cells field contains records with rowIndex, columnIndex, oldValue, value, error, and updater. (see Cell).

Spreadsheet Cells Format Updated

This event fires when cell formats are updated in the Spreadsheet, for example by the Spreadsheet Formats Update function. The event reports format updates only. If a cell is updated as a whole, the Spreadsheet Cells Updated event fires instead. If only cell values change, the Spreadsheet Cells Values Updated event fires.

Event Name:

spreadsheetCellsFormatUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the updated Spreadsheet.

cells

Data Table

Cells. List of cells whose format was updated. The cells field contains records with rowIndex, columnIndex, and formatId, the identifier of the format applied to the cell (see Formats).

Spreadsheet Cells Style Updated

This event fires when cell styles are updated in the Spreadsheet, for example by the Spreadsheet Formats Update function. The event reports style updates only. If a cell is updated as a whole, the Spreadsheet Cells Updated event fires instead.

Event Name:

spreadsheetCellsStyleUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the updated Spreadsheet.

cells

Data Table

Cells. List of cells whose format was updated. The cells field contains records with rowIndex, columnIndex, and formatId, the identifier of the format applied to the cell (see Styles).

Spreadsheet Updated

This event fires after Spreadsheet changes are saved.

Event Name:

spreadsheetUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

context

String

Context. Spreadsheet context path.

name

String

Name. Name of the updated Spreadsheet.

updater

String

Updater. Name or login of the user who made the changes.

Spreadsheet Evaluating

This event fires when formula recalculation starts for Spreadsheet cells.

Event Name:

spreadsheetEvaluating

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

ranges

Data Table

Ranges. List of ranges whose formulas are being recalculated (see Range).

Spreadsheet Evaluated

This event fires when formula recalculation finishes for Spreadsheet cells.

Event Name:

spreadsheetEvaluated

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

ranges

Data Table

Ranges. List of ranges whose formulas were recalculated (see Range).

Spreadsheet Dimensions Updated

This event fires when Spreadsheet dimensions are updated.

Event Name:

spreadsheetDimensionsUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

action

Integer

Action. Dimension update action. Supported values:

  • 0 - insert

  • 1 - delete

  • 2 - move.

ranges

Data Table

Ranges. Updated dimension ranges.

Spreadsheet Dimensions Properties Updated

This event fires when Spreadsheet dimension properties are updated.

Event Name:

spreadsheetDimensionsPropertiesUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

dimension

Integer

Dimension. Dimension type. Supported values:

  • 0 - rows

  • 1 - columns.

dimensionMetadata

Data Table

Dimension Metadata. Updated dimension metadata (see Dimension Properties).

Spreadsheet Filtered Cells Updated

This event fires when Spreadsheet cell filtering changes.

Event Name:

spreadsheetFilteredCellsUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

rowIndexes

Data Table

Row Indexes. List of indexes of filtered rows.

Spreadsheet Formats Added

This event fires when Spreadsheet cell formats are added.

Event Name:

spreadsheetFormatsAdded

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

formats

Data Table

Formats. Added cell formats (see Formats).

Spreadsheet Formats Removed

This event fires when Spreadsheet cell formats are removed.

Event Name:

spreadsheetFormatsRemoved

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

formats

Data Table

Formats. Removed cell formats (see Formats).

Spreadsheet Styles Added

This event fires when Spreadsheet cell styles are added.

Event Name:

spreadsheetStylesAdded

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

styles

Data Table

Styles. Added cell styles (see Styles).

Spreadsheet Styles Removed

This event fires when Spreadsheet cell styles are removed.

Event Name:

spreadsheetStylesRemoved

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

styles

Data Table

Styles. Removed cell styles (see Styles).

Spreadsheet Locked By

This event fires when Spreadsheet editing is locked by another user.

Event Name:

spreadsheetLockedBy

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

context

String

Context. Spreadsheet context.

lockOwnerName

String

Lock Owner Name. Name of the user who locked the Spreadsheet.

Was this page helpful?