Events

Complete list

• queryComplete

  Emitted when an engine query completes. Read results and actual execution tier from detail for performance and result feedback.

• sortChanged

  Emitted when sorting changes. Reflect the current model in app query conditions or saved view state.

• filterChanged

  Emitted when applied filters change. Distinguish from filterModified, which describes input changes.

• filterModified

  Emitted when filter input changes. Filters with an Apply button may not yet have updated result rows.

• conditionFilterChanged

  Emitted when the AND/OR condition tree changes. A null model means advanced conditions were cleared.

• conditionPresetsChanged

  Emitted when advanced condition presets change. Connect presets to user preference storage.

• columnGroupToggled

  Emitted when a column group header expands or collapses. Read groupId and open for its state.

• rowGroupToggled

  Emitted when a row group expands or collapses. Reuse the actual key in detail, not the display label.

• treeNodeToggled

  Emitted when tree expansion changes. Inspect the path and expanded state.

• detailRowToggled

  Emitted when a parent row's detail expansion changes.

• detailRowCreated

  Emitted when a detail panel is created. Connect app resources using its row ID and parent data.

• detailRowDestroyed

  Emitted when a detail panel is destroyed. Clean up app resources associated with its rowId too.

• rangeSelectionChanged

  Emitted when cell selection ranges change. Use the boundaries for copying or summaries.

• toolPanelToggled

  Emitted when column/filter tool panel visibility changes.

• csvImported

  Emitted after CSV import completes. Report the actual applied row and column counts to users.

• clipboardCopied

  Emitted after clipboard copying completes. Output text and ranges are available, so avoid logging sensitive values.

• clipboardPasted

  Reports paste results. Inspect applied/skipped counts, starting position, and actual changes together.

• paginationChanged

  Emitted when the page or page size changes. Synchronize external page indicators.

• quickFilterChanged

  Emitted when quick-filter conditions change. Synchronize external search input values if needed.

• emptyStateActionClicked

  Emitted when an empty-state action button is clicked. Connect the app flow appropriate to the action type.

• activeCellChanged

  Emitted when keyboard or pointer input changes the active cell. Separate from range or row selection.

• cellClicked

  Emitted on a cell click. Read the row, field, and input context from detail.

• cellDoubleClicked

  Emitted on a cell double-click. Avoid conflicts between starting editing and opening app details.

• rowClicked

  Emitted on a row click. Distinguish the click itself from the resulting selection.

• cellEditingRequested

  Emitted when cell editing is requested. Distinguish later cancellation, commit, and value-change events.

• cellEditingCancelled

  Emitted when cell editing is cancelled. Do not treat it as a successful server save.

• cellEditingCommitted

  Emitted when cell editing is committed. Also inspect cellValueChanged for actual value changes.

• formulaEvaluated

  Emitted when a formula result is calculated. Distinguish formula text from its result.

• formulaError

  Emitted when formula evaluation fails. Connect target and error information to a review UI.

• workbookBindingChanged

  Emitted when the Grid's workbook/sheet connection changes.

• workbookBindingError

  Emitted when a workbook connection cannot be configured. Inspect identifiers and connection errors.

• chunkLoading

  Emitted when feature code starts loading. Separate from row data query events.

• chunkLoaded

  Emitted when feature code has loaded.

• chunkLoadFailed

  Emitted when feature code loading fails. Use the error and feature name for retry or fallback guidance.

• componentError

  Reports custom component initialization or invocation errors. Handle them by target and phase rather than ignoring them.

• rowDataChanged

  Emitted when source row data changes. Different from a change in display sorting.

• cellValueChanged

  Emitted when an actual cell value changes. Use the row, field, and before/after values for saving or activity history.

• rowMoved

  Emitted when row order changes. Read the affected row and before/after indices.

• rowGroupChanged

  Emitted when row grouping changes. Inspect group fields and whether grouping was cleared.

• pivotPanelChanged

  Emitted when axes change in the pivot panel. Inspect the changed axis and current pivot state.

• pivotChanged

  Reports pivot configuration changes. Avoid duplicate saves from subscribing to both compatibility and panel events.

• pivotModeChanged

  Emitted when pivot mode is enabled or disabled.

• contextMenuItemClicked

  Emitted when a cell context-menu item runs. Read its item ID and target cell position.

• remoteEditApplied

  Emitted when a collaborator's edit is applied. Track its origin to avoid resending it as a local edit and creating a loop.

• presenceChanged

  Emitted when participant positions or presence change.

• collabConflictResolved

  Emitted when a concurrent editing conflict is resolved. Read the actual outcome before explaining it to users.

• collaboratorJoined

  Emitted when a participant joins the collaboration room.

• collaboratorLeft

  Emitted when a participant leaves. Update the app's participant list by ID.

• syncStatusChanged

  Emitted when collaboration synchronization changes. Distinguish connection state from completed persistent server saving.

• cellCommentsChanged

  Emitted when cell collaboration comments change. Read the row ID, field, and latest comments.

• commentMentioned

  Reports a mention in collaboration comments. Connect app notifications using the target cell and comment.

• auditLogChanged

  Emitted when an audit record is added. Read entry to connect your app's retention flow.

• conditionalFormatsChanged

  Emitted when conditional formatting rules change. Save rules as user preferences.

• cellValidationFailed

  Emitted when validation fails. Use the target cell, input, and message to guide corrections.

• snapshotCaptured

  Emitted when a data snapshot is created. Display the saved point using its ID, name, and row count.

• snapshotRestored

  Emitted when snapshot restoration completes. Does not indicate completed server saving.

• xlsxImported

  Emits the selected sheet's Grid snapshot after XLSX parsing. Apply snapshot.columnDefs and snapshot.rowData in your app if needed.

• historyChanged

  Emitted when undo/redo history changes. Update button availability and current depths.

• columnResized

  Emitted when column width changes. Include the current width in saved view state.

• columnReordered

  Emitted when column order changes.

• columnVisibilityChanged

  Emitted when column visibility changes.

• selectionChanged

  Emitted when row selection changes. Use selected IDs to define bulk-operation targets.

• rowHoverChanged

  Emitted when the stateful hovered row changes. Unlike CSS-only hover, the app can read this state.

• themeChanged

  Emitted when the Grid theme changes. Check it alongside the surrounding app theme.

• localeChanged

  Emitted when the Grid locale changes.

• gridObjectChanged

  Emitted when public objects such as rows and columns change. Read the target and changes from detail.

• stateUpdated

  Emitted when combined view state updates. Adjust persistence frequency in your app for frequent events.

• preDestroyed

  Provides state and capture issues before the Grid is destroyed. Use for saving view preferences and cleaning up resources.

• batchEditStart

  Emitted when batch editing starts. Open a staged-changes UI if needed.

• batchEditEnd

  Emitted when batch editing commits or cancels. Inspect the end reason and results.

• rowValueChanged

  Reports full-row value changes. Use when defining a save unit for an entire row.

• rowEditStart

  Emitted when full-row editing starts.

• rowEditStop

  Emitted when full-row editing ends. Distinguish commit from cancellation.

• fillStart

  Emitted when range filling starts.

• fillEnd

  Emitted when range filling ends. Explain applied, skipped, and rejected results to users.

• pivotCombinationConflict

  Emitted when pivot settings conflict with other features. Adjust app options based on the actual compatibility decision.

• pivotColumnsChanged

  Emitted when the pivot result column model changes. Update chart and export code using previous result column IDs.

• serverStoreUpdated

  Emitted when a server row store refreshes. Inspect its path and cache state.

• rowDragEnter

  Emitted when a row drag enters a target area.

• rowDragMove

  Emitted during row dragging. Avoid expensive save operations on every high-frequency event.

• rowDragLeave

  Emitted when a row drag leaves an area. Different from drag completion.

• rowDragEnd

  Emitted when row dragging ends. Inspect the applied result and drop position.

• rowDragCancel

  Emitted when row dragging is cancelled. Do not run completion actions or save server ordering.

• rowsTransferred

  Reports row transfers between drop areas. Inspect actual move, copy, and rejection results.

• spanConflict

  Emitted when cell spans conflict with other ranges or layouts.

• treeReparented

  Reports tree reparenting results. Connect to parent-relationship saving on your app server.

• pinnedRowsChanged

  Emitted when top/bottom pinned row data changes.

• rowLayoutRefused

  Emitted when a requested row layout cannot be applied. Adjust the combination according to the rejection reason.

• workbookValuesPropagated

  Emitted after cross-sheet value propagation. Inspect results and generation information.

• chartCreated

  Emitted when an integrated Grid chart is created. Manage your app's chart list by chart ID.

• chartRangeChanged

  Emitted when an integrated chart's source range changes.

• chartOptionsChanged

  Emitted when integrated chart settings change. Update saved chart models if needed.

• chartDestroyed

  Emitted when an integrated chart is destroyed. Clean up app-held references and external resources.