Methods

Complete list

• getAuditLog

  Reads audit records as an array, optionally filtered by type, sequence, or time. Returns an empty array when recording is disabled.

• clearAuditLog

  Clears retained audit records. Sequence numbers continue increasing and are not reused.

• getAuditLogAsCsv

  Converts audit records to CSV text for inspection or transfer without downloading a file.

• getAuditLogAsJson

  Reads audit records as a structured JSON array string. Use pretty for readable indentation.

• exportAuditLogAsCsv

  Downloads selected audit records as a CSV file.

• exportAuditLogAsJson

  Downloads selected audit records as a JSON file.

• openCellCommentPanel

  Opens a collaboration comment panel for a row ID and field. Separate from standalone cell note adapters.

• closeCellCommentPanel

  Closes the collaboration comment panel without deleting comment data.

• getApi

  Accesses the current Grid's typed API and app context. Read from a fully initialized element.

• getColumn

  Finds a current column object by ID. Returns null for missing columns and reflects live state rather than an initial columnDefs copy.

• getColumns

  Reads current column objects to connect widths, order, and visibility to your app.

• getColumnGroup

  Finds a current column group by ID. Returns null if absent.

• getColumnGroups

  Reads current column group objects.

• getRow

  Finds a row object by stable row ID, rather than display index.

• getDisplayedRowAtIndex

  Finds a row object by its current display index. Sorting, filtering, and grouping can change the row at an index.

• forEachRow

  Runs a callback for each row object. Use forEachDisplayedRow when display order matters.

• forEachDisplayedRow

  Iterates current displayed rows for app features that distinguish source order from display order.

• getWorkbookBinding

  Reads current workbook and sheet connection information, or null when disconnected.

• reconnectWorkbook

  Rebuilds the connection from current workbook settings and returns the result.

• disconnectWorkbook

  Disconnects the workbook. Review the effect on cross-sheet formula propagation.

• sortBy

  Sets one column's sorting. Omitted direction cycles sorting; null clears that column. Use setSortModel for the full multi-column model.

• setSortModel

  Replaces sort criteria and priorities together. An empty array clears all sorting.

• getSortModel

  Reads current sort columns, directions, and priorities.

• setQuery

  Passes query conditions to the processing engine. Review GridQuery and support in the active row model.

• getActiveTier

  Reads the actual active processing tier, which may differ from the requested engine mode.

• registerAggFunc

  Registers a named custom aggregate function. Use unique names because an existing function with the same name can be replaced.

• unregisterAggFunc

  Removes a registered custom aggregate function. Also update aggFunc settings in columns using it.

• getRegisteredAggFuncNames

  Reads currently registered aggregate function names.

• setRowGroupExpanded

  Expands or collapses a row group by its actual group key. Missing groups and unchanged states are ignored.

• expandAllRowGroups

  Expands all current row groups. Each changed group emits a toggle event.

• collapseAllRowGroups

  Collapses all collapsible row groups in the current data.

• setTreeNodeExpanded

  Expands or collapses a tree node by path. Leaf nodes and missing paths cannot be expanded.

• expandAllTreeNodes

  Expands all expandable nodes in the current tree.

• collapseAllTreeNodes

  Collapses all branch nodes in the current tree.

• setDetailRowExpanded

  Expands or collapses a detail panel by stable parent row ID.

• expandAllDetailRows

  Expands detail rows across all pages passing the current filter. Consider request volume with lazy loading.

• collapseAllDetailRows

  Collapses all open detail rows and cleans up their panel resources.

• setColumnGroupOpened

  Expands or collapses the specified column group header.

• getValidationErrors

  Reads row, field, value, and message information for current validation errors. Connect to save guidance or an error list.

• captureSnapshot

  Creates a named snapshot of current source data and returns its ID. Separate from saving column layouts.

• listSnapshots

  Reads metadata for retained data snapshots.

• deleteSnapshot

  Deletes a data snapshot and returns success without changing current data.

• diffSnapshots

  Compares two snapshots or a snapshot with current data. Omit the second ID to compare against current data.

• restoreSnapshot

  Restores source data from a snapshot. Does not automatically save to the server or restore view state.

• getCellRanges

  Reads current cell selection boundaries. Review the meaning of display row/column coordinates.

• copyRangeToClipboard

  Copies the selected range and returns success. Check browser permissions and user activation requirements.

• pasteFromClipboard

  Pastes clipboard content into the current target. Inspect applied and skipped cells in the result event.

• clearCellRanges

  Clears all cell selection ranges. Row selection is separate.

• refreshInfiniteCache

  Refetches the infinite row model's cache. Prepare updated server conditions and the data provider first.

• refreshRowHeights

  Recalculates row heights after content or height callback inputs change.

• scrollToTop

  Scrolls the Grid to the top.

• selectRows

  Sets selection for specified row IDs. Use stable IDs, not display indices.

• getSelectedRowIds

  Reads selected row IDs. Use dedicated server selection state APIs for server-wide selection.

• applyTransaction

  Adds, updates, and removes source rows by stable ID. Inspect results separately from app server saving.

• undo

  Undoes one recorded editing step and returns whether it ran.

• redo

  Redoes one undone step and returns whether it ran.

• clearHistory

  Clears undo/redo history without resetting current data values.

• connectCollabRoom

  Starts the configured collaboration room connection and returns synchronization state.

• preloadChunks

  Preloads feature code. Does not activate entitlements or prefetch data.

• disconnectCollabRoom

  Disconnects from the current collaboration room.

• getSyncStatus

  Reads current collaboration connection and synchronization state.

• getCollaborators

  Reads current collaboration participant information.

• addCellComment

  Adds a cell comment in an active collaboration session and returns its ID or null.

• getCellComments

  Reads collaboration comments associated with a row ID and field.

• setCellCommentResolved

  Changes a comment's resolved state and returns success.

• deleteCellComment

  Deletes a collaboration comment and returns success.

• getDataAsCsv

  Returns an object with CSV text and output row/column counts. Read the string from its csv field.

• exportDataAsCsv

  Downloads CSV using current export conditions and returns the export result.

• getDataAsExcel

  Generates XLSX content as Uint8Array bytes for app attachments, uploads, and similar uses.

• exportDataAsExcel

  Downloads an XLSX file using the specified sheet name, columns, and selection conditions.

• importCsvText

  Parses CSV text and replaces columns and source data. For appending rows, parse separately and use transactions.

• getDataAsPdf

  Returns PDF generation results without downloading. Prepare a suitable font for characters such as Korean text.

• exportDataAsPdf

  Downloads the table as PDF and returns generation results.

• importDataFromXlsx

  Parses file bytes into a workbook and returns XlsxImportResult. Read the Grid snapshot from the xlsxImported event.

• getContextMenuItems

  Calculates context-menu items for a displayed row and field.

• copyCellAt

  Copies the value at a displayed row and field and returns success.

• copyRowAt

  Copies a displayed row and returns success.

• getCellTooltipText

  Calculates actual tooltip text from the target cell and overflow context.

• getUndoRedoDepth

  Reads the number of available undo and redo steps.

• setColumnWidth

  Sets the current column width. Review minimum and maximum constraints too.

• resetColumnWidth

  Resets the specified column's user-adjusted width to its initial setting.

• getColumnWidth

  Reads the current column width, or null if the column is absent.

• setColumnPinned

  Pins a column left/right or unpins it.

• getColumnPinned

  Reads the column's current pinning direction.

• setColumnOrder

  Sets display order using column IDs.

• getColumnOrder

  Reads column IDs in current display order.

• hideColumn

  Hides a column without deleting source data or revoking read permission.

• showColumn

  Shows a hidden column.

• toggleColumnVisibility

  Toggles column visibility and returns the resulting state.

• setHiddenColumns

  Sets the list of hidden columns at once.

• resetColumnVisibility

  Resets column visibility to initial settings.

• getHiddenColumns

  Reads IDs of currently hidden columns.

• autoSizeColumn

  Measures currently available content and applies an appropriate width to one column.

• autoSizeAllColumns

  Autosizes all columns. Do not assume unloaded server values can be measured.

• getColumnState

  Reads serializable column width, order, visibility, sorting, and pinning state.

• applyColumnState

  Restores saved column state. Verify that IDs match current columns.

• getState

  Reads an immutable, versioned snapshot of the complete view state. Does not back up source row data.

• setState

  Restores complete or selected state slices and returns applied/issue reports. Only slices in appliedSlices were actually applied.

• getFilterModel

  Reads combined state across current filter families.

• setFilterModel

  Applies a validated combined filter model. null clears all filter families; inspect reports for invalid models.

• getCanonicalRanges

  Reads current selection as normalized ranges including stable row and column IDs.

• setCanonicalRanges

  Changes cell selection from normalized range input and returns the change result.

• startBatchEdit

  Starts batch editing to collect multiple cell changes for a single commit.

• isBatchEditing

  Checks whether batch editing is active.

• stageBatchCell

  Stages a batch value by row and column ID. Does not immediately persist final data.

• getPendingBatchCells

  Reads uncommitted batch editing cells.

• cancelBatchEdit

  Cancels pending batch edits and returns the cancelled item count.

• commitBatchEdit

  Validates and commits staged changes, reporting per-cell results.

• startRowEdit

  Starts full-row editing for a row ID.

• stopRowEdit

  Commits or cancels current row editing and returns a report.

• stageRowEditCell

  Sets a pending value for a column in the row currently being edited.

• getStateCaptureReport

  Reads omissions and issues from the latest view-state capture to assess saved-state completeness.

• fillRange

  Fills a target range from source values or patterns and reports applied and rejected results.

• getDisplayRowInfo

  Reads the displayed row kind, such as data, group, or detail.

• getPivotCombinationReport

  Reads activation, priority, and restriction decisions for the current combination of pivoting and other features.

• getPivotSecondaryColumns

  Reads the identity model of result columns created by the active client pivot, or null when no pivot is active.

• getGroupCheckStates

  Calculates group selection state. Returns rejection reasons when collapsed groups, missing row IDs, or other row models prevent a reliable result.

• startRowDrag

  Starts a row drag session through the public input contract. Check whether it started and any rejection reason.

• getRowDragSession

  Reads current row drag session progress.

• registerDropZone

  Registers a drop area for receiving rows and returns the registration result.

• unregisterDropZone

  Unregisters a drop area and returns success.

• getDropZones

  Reads current drop-area registration state.

• getDragSafetyReport

  Reports whether row dragging is safe under current settings and describes restrictions.

• setAlignedGrids

  Configures aligned Grid connections and returns the result.

• getAlignedGrids

  Reads connected Grids and alignment state.

• reparentRows

  Reparents tree rows and reports applied/rejected results. Check cycle, permission, and row-model restrictions.

• getFullWidthRowInfo

  Reads one full-width row's information, or the complete layout report when no argument is supplied.

• setPinnedRows

  Sets top/bottom pinned row data and returns the application result.

• getPinnedRows

  Reads current pinned row data as a report.

• getPinnedRowInfo

  Reads details of a specified pinned row.

• getRowSpan

  Reads calculated vertical span ranges.

• getCellSpan

  Reads horizontal and vertical span information for a cell.

• getSpanInteraction

  Inspects how merged cells interact with selection, copying, and related actions.

• getServerSideSelectionState

  Reads select-all conditions and exception IDs for the flat server row model. Reports a model mismatch for grouped models.

• getServerGroupSelectionState

  Reads hierarchical select-all and exception state for the grouped server row model.

• setServerSideSelectionState

  Replaces select-all conditions and exception IDs in the flat server row model.

• setServerGroupSelectionState

  Replaces hierarchical selection state in the grouped server row model.

• selectAllServerSide

  Sets server-wide selection conditions without materializing every server row in memory.

• selectServerGroupChildren

  Selects or deselects server descendants beneath a group-key path.

• refreshServerSide

  Refetches the specified server store scope and returns the result.

• applyServerSideTransaction

  Applies row changes to the server row model's cache, separately from saving server source data.

• applyServerSideTransactionAsync

  Queues a server row transaction asynchronously. Queue acceptance differs from final application.

• flushServerSideAsyncTransactions

  Processes pending server row transactions and returns a completion report.

• getServerSideStoreState

  Reads server store paths, states, and block caches. Assess loading through block counts and complete as well as state names.

• getServerPivotResultColumns

  Reads the server-supplied pivot result column model. Distinguish stale metadata from absent metadata.

• auditServerPivotResultColumns

  Checks whether server pivot column IDs used for charts, export, or restoration still exist in the current model.

• getWorkbookPropagationState

  Reads cross-sheet formula propagation connections, registrations, rejections, and latest publication information.

• flushWorkbookPropagation

  Processes pending workbook value propagation and returns the result.

• getWorkbookSnapshotReport

  Reads the last published workbook cells, hashes, and generations. Do not assume all Grid data was published.

• getWorkbookIntegrityReport

  Reads consistency checks for workbook connections and value propagation.

• applySpillFormula

  Atomically applies a dynamic array formula under the conflict policy. Inspect conflicts, rejections, and unrendered areas in the report.

• clearSpillFormula

  Clears a dynamic array formula's anchor cell and releases its occupied range.

• undoSpillTransaction

  Undoes a dynamic array formula transaction and returns the result.

• getSpillReport

  Inspects current dynamic array formulas and their occupied ranges.

• createRangeChart

  Creates an integrated chart from a selection or explicit source. Read chartId on success or the rejection reason on failure.

• updateChart

  Changes an existing chart's type, source range, or properties and returns the result.

• destroyChart

  Closes the specified chart and releases its resources.

• getChartRefs

  Reads IDs and states of active integrated charts.

• syncCharts

  Recalculates integrated chart data projections from the current Grid view.

• getChartMenuModel

  Reads the chart menu model available for the current selection and permissions.

• openChartToolPanel

  Opens the tool panel for choosing an available chart.

• closeChartToolPanel

  Closes the chart creation panel and cleans up its selection flow.

• getChartToolPanelReport

  Reads chart panel open, focus, and accessibility state.

• activateChartToolPanelItem

  Creates a chart by activating the currently focused chart panel item.

• getChartModels

  Captures active charts in a versioned envelope with capture issues. Pass the result's envelope to restoration.

• restoreChartModels

  Restores a saved chart envelope against the current Grid data contract and returns results.

• exportChartImage

  Requests image export for an integrated chart and returns the result.

• applyChartCrossFilter

  Applies chart selection actions to the Grid filter model.

• resetChartCrossFilter

  Clears chart-owned cross-filters while retaining the app's external filters.

• getChartAccessibleSummary

  Reads chart data summaries and accessibility checks.

• getChartFleetReport

  Reports the current chart set, open resources, and cleanup state.

• setHoveredRow

  Sets the row targeted by stateful hover. Does not change actual row selection.

• getHoveredRowId

  Reads the current hovered row ID or null.

• getActiveEditTransaction

  Reads the active cell editing transaction, or null when not editing.

• commitActiveEdit

  Commits current cell editing and returns success.

• cancelActiveEdit

  Cancels current cell editing and returns whether it ran.

• registerCellRenderer

  Registers a named cell renderer and returns the result.

• listRegisteredCellRenderers

  Reads available registered cell renderer names.

• unregisterCellRenderer

  Unregisters a named cell renderer.

• registerGridComponent

  Registers a custom Grid component under the public component contract.

• replaceGridComponent

  Replaces a registered custom component definition.

• unregisterGridComponent

  Unregisters a custom component and returns success.

• getRegisteredGridComponentNames

  Reads registered custom Grid component names.

• getCellRendererInstance

  Queries mounted cell renderer instances. Offscreen cells may be unmounted because of virtualization.

• destroyCellRendererInstance

  Destroys a specified mounted cell renderer instance.

• focusCellRendererInstance

  Moves focus into a mounted cell renderer and returns the result.

• getCellEditorInstance

  Reads the mounted cell editor instance and context, or null if no editor exists.

• getColumnFilterInstance

  Queries a column's custom filter instance. May return null if absent or not yet created.

• getColumnFilterModel

  Reads one column's current filter model.

• setColumnFilterModel

  Sets one column's filter model and returns the result. Separate from setFilterModel, which changes combined filter state.

• onFilterChanged

  Signals changed filter conditions and recalculates current row filtering.

• refreshExternalFilter

  Runs the external filter refresh lifecycle and returns success.

• destroyColumnFilter

  Destroys a column's filter instance.

• recreateColumnFilter

  Recreates a column's filter instance.

• setPivotColumns

  Replaces the pivot column axis through the validated update path and returns success.

• setValueColumns

  Replaces the pivot value axis through the validated update path and returns success.

• setConditionFilter

  Applies an advanced AND/OR condition tree. null clears it; inspect results for invalid models.

• getConditionFilter

  Reads the current advanced condition tree or null.

• setConditionPresets

  Sets advanced condition presets containing names and JSON.

• getConditionPresets

  Reads saved advanced condition presets.

• openToolPanel

  Opens a column/filter tool panel by ID and returns success.

• closeToolPanel

  Closes the open column/filter panel without clearing applied settings.

• getOpenedToolPanel

  Reads the open tool panel ID or null.