Public Events

[?]

Inherited Events

The Spreadsheet component is internally based on the Data Table component, so it inherits its shared events.

Custom Events

The following events are specific to the Spreadsheet component and describe Spreadsheet-related updates, recalculation state changes, and structural modifications.

Spreadsheet Cells Updated

This event fires when Spreadsheet cells are updated.

Event Name:

spreadsheetCellsUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

cells

Data Table

Cells. List of updated cells (see Cell).

updater

String

Updater. Name of the user who updated the cell value.

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

ranges

Data Table

Ranges. List of ranges for which cell formulas must be 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

ranges

Data Table

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

Spreadsheet Cells Values Updated

This event fires when Spreadsheet cell values change.

Event Name:

spreadsheetCellsValuesUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

rowIndex

Integer

Row Index. Index of the cell row.

columnIndex

Integer

Column Index. Index of the cell column.

oldValue

String

Old Value. If specified, contains the string representation of the cell value before the update.

value

String

Value. If specified, contains the string representation of the cell value after the update.

error

Data Table

Error. If specified, contains the description of the input formula execution error for the cell (see Cell Error).

updater

String

Updater. Name of the user who updated the cell value.

Spreadsheet Cells Values Validation Failed

This event fires when a value entered or pasted into a cell does not pass one of the validators defined in the cell format.

Event Name:

spreadsheetCellsValuesValidationFailed

Records:

1

Record Format:

Field Name

Field Type

Field Description

range

String

Range. Cell address or cell range address.

message

String

Message. Validation error description.

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 row indexes of the filtered rows.

Spreadsheet Updated

This event fires when Spreadsheet data is updated.

Event Name:

spreadsheetUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

context

String

Context. Spreadsheet context.

name

String

Name. Spreadsheet name.

updater

String

Updater. Name of the user who made the changes.

Spreadsheet Dimensions Updated

This event fires when Spreadsheet dimensions are updated.

Event Name:

spreadsheetDimensionsUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

action

Integer

Action. Dimension update action. Supported values:

  • 0 = insert

  • 1 = delete

  • 2 = move.

range

Data Table

Range. Updated dimension range data (see Dimension Range).

Spreadsheet Dimensions Properties Updated

This event fires when row or column properties are updated in the Spreadsheet.

Event Name:

spreadsheetDimensionsPropertiesUpdated

Records:

1

Record Format:

Field Name

Field Type

Field Description

name

String

Name. Name of the Spreadsheet.

dimension

Integer

Dimension Type. Supported values: 0 = rows, 1 = columns.

dimensionMetadata

Data Table

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

Spreadsheet Formats Added

This event fires when cell formats are added in the Spreadsheet.

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 cell formats are removed from the Spreadsheet.

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 cell styles are added in the Spreadsheet.

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 cell styles are removed from the Spreadsheet.

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).

Was this page helpful?