Grid properties

Complete list

• rowData

  The source row array for the table. Pass a new array to replace a complete query result, or use applyTransaction for partial updates.

• columnDefs

  Defines column data fields, headings, sizes, visibility, and editing. Include column groups to create multi-level headers.

• context

  Passes shared app context to callbacks and the Grid API, such as app-managed permissions and services.

• components

  Registers local custom renderers, editors, filters, and other components for this Grid.

• externalFilter

  Determines whether each row passes conditions outside the Grid. Supply activation and row predicates or a lifecycle instance.

• componentTimeoutMs

  Maximum wait for preparing asynchronous user components. Handle delays and failures with componentError.

• csvImport

  Provides a CSV import button and column mapping flow. Explain whether importing replaces existing columns and data.

• pdfFontUrl

  An app-hosted TTF/OTF URL for characters absent from the default PDF font, such as Korean characters.

• pdfAutoFont

  Automatically resolves a PDF font when fontBytes is absent. Tries pdfFontUrl first, then local font access where available.

• formulas

  Evaluates cell strings beginning with = as formulas. A1 references use original column and row order, not display sorting.

• showFormulas

  Displays formula text instead of calculated results for review in a table with formulas enabled.

• formulaBar

  Shows a formula bar for inspecting and editing the active cell's source value or formula. Enter commits; Escape cancels.

• workbookId

  Identifies the workbook connecting multiple Grid sheets. Set it together with sheetName for cross-sheet references.

• sheetName

  Identifies this Grid sheet within a workbook. Review the effect of renaming it on formulas in other sheets.

• defaultColDef

  Defaults shared by all columns. Override individual values in columnDefs for specific columns.

• theme

  Sets Grid colors and appearance with a light/dark preset or a token object extending a preset.

• height

  Sets the Grid container height as a number or CSS length. Account for virtual scrolling and bottom tools.

• locale

  A Korean, English, or Japanese preset, or an object overriding default messages. Translate source data and column headings in your app.

• pagination

  Displays the table across multiple pages. Does not change the server data query strategy itself.

• pageSize

  Rows displayed per page. Distinguish the displayed row model, including group rows, from source data counts.

• pageSizeOptions

  The numeric choices available in the page-size selector.

• rowHeight

  Default row height in pixels. Choose a size suitable for text, cell editors, and touch targets.

• rowHeightFn

  Calculates individual row heights from row indices and data. Call refreshRowHeights when relevant data changes.

• virtualScroll

  Enables vertical virtualization, rendering rows near the viewport. Does not reduce total data downloads.

• quickFilter

  Displays a global search input. Use quickFilterText for an initial term or an external input.

• quickFilterText

  The quick-filter search string. Assign a new string from an external app search input too.

• quickFilterPlaceholder

  Guidance for the quick-filter input. Describe the searchable data scope clearly.

• quickFilterMode

  Combines terms with and, requiring all matches, or or, requiring any match.

• quickFilterRegex

  Interprets quick-filter input as a regular expression rather than ordinary text.

• quickFilterDebounce

  Delay before applying quick-filter input. Balances continuous typing throughput and responsiveness.

• showEmptyState

  Shows an empty-state message when no data exists. Distinguish request failures from valid empty results in your app.

• emptyMessage

  Message displayed when source data is empty.

• noMatchesMessage

  Message displayed when data exists but no rows match current search or filters.

• clearFiltersLabel

  Label for the clear-filters action in an empty-results view.

• loading

  Displays app data-request progress. Clear it after both success and failure.

• loadingMessage

  Description shown while loading.

• loadingMode

  Selects the Grid loading indicator. See LoadingMode for supported values.

• minLoadingDuration

  Minimum loading-indicator duration to avoid brief flashes.

• datasource

  Data provider for the infinite row model. Complete each requested range through its success or failure callback.

• cacheBlockSize

  Block size for requesting and caching remote rows.

• maxBlocksInCache

  Maximum cached blocks in the infinite row model. Balances memory use against repeat queries.

• serverSideDatasource

  Data provider for a row model where the server handles sorting, filtering, grouping, and related requests.

• serverSideGroupCols

  Columns grouped on the server, ordered from outermost group inward. An empty array represents flat data.

• serverSideTransactionWaitMs

  Delay for batching asynchronous server row transactions.

• viewportDatasource

  Viewport model supplying data for visible row ranges. Implement initialization, range changes, and cleanup.

• rowDragManaged

  Lets the Grid manage reordering from row dragging. Review restrictions with sorting, filtering, and other row models.

• spanExportMode

  Chooses whether merged-cell copying and output include the origin value once or repeat it at every position.

• rowDragMultiRow

  Allows dragging multiple selected rows together. Also configure rowDrag on a column and row selection.

• rowDragText

  Builds drag feedback text from the row count and default label.

• cellChangeFlash

  Briefly highlights cells changed by editing, pasting, or transactions.

• enableCellChangeFlash

  Compatibility alias for cell change flashing. Do not assign a value that conflicts with cellChangeFlash.

• contextMenu

  Displays a cell context menu. Use built-in copy, row copy, and CSV actions or replace the list through a callback.

• columnMenu

  Enables a column action menu in column headers.

• find

  Finds and navigates matching positions in loaded, readable cells. This is not a search of the complete server data set.

• cellNotes

  Provides standalone notes for readable cells with stable IDs. Requires a storage adapter and Pro entitlement.

• cellNotesAdapter

  Implements standalone note loading and atomic revision-based saving. Does not automatically fall back to temporary built-in storage.

• batchEditToolbar

  Displays tools for starting, committing, and cancelling batch edits.

• columnMenuItems

  Builds column menu items from the current column context.

• contextMenuItemsCallback

  Returns cell context-menu items. Replaces the entire default list rather than appending to it.

• keyboardNavigation

  Configures keyboard navigation across cells and internal Grid features.

• rowSelection

  Disables row selection or enables single/multiple selection. Independent of cell range selection.

• getRowId

  Returns a stable, unique row ID. The same business row must retain its ID after sorting, filtering, and editing.

• selectionCheckbox

  Displays row selection checkboxes.

• showSelectionCheckbox

  Compatibility alias for selection checkboxes. Avoid conflicts with selectionCheckbox.

• shiftClickAdditive

  Chooses whether Shift-click range selection adds to the existing selection.

• rowHover

  Selects CSS-only hover highlighting, stateful hover with events, or no hover.

• resizableColumns

  Allows users to resize columns by dragging their boundaries.

• reorderableColumns

  Allows users to reorder columns by dragging headers.

• columnHiding

  Enables column hiding. Also provide a menu or panel for restoring hidden columns.

• hideableColumns

  Compatibility setting for column hiding. Keep it consistent with columnHiding.

• autoSizeOnDoubleClick

  Autosizes a column to its content when its boundary is double-clicked.

• multiSort

  Enables sorting by multiple columns. The sort model order defines priority.

• enableMultiSort

  Compatibility alias for multiple sorting. Keep it consistent with multiSort.

• headerFilterRow

  Displays a row of per-column filter controls below the headers.

• conditionBuilder

  Displays a condition builder combining conditions with AND and OR.

• virtualizeColumns

  Enables horizontal virtualization, rendering columns near the viewport.

• groupBy

  Groups rows with equal values. A string array creates nested groups in array order.

• pivotMode

  Enables pivot aggregation across row, column, and value axes. Configure all three axes too.

• pivotRowGroupColumns

  Fields forming the left-hand row axis of pivot results.

• pivotColumns

  Fields whose distinct values expand into pivot result columns at the top.

• pivotValueColumns

  Value fields aggregated at each pivot intersection.

• pivotAggFuncs

  Aggregate function names for each value field. Supports built-in and registered custom functions.

• pivotSubtotals

  Hides nested pivot subtotals or positions them above or below expanded groups.

• pivotGrandTotal

  Hides pivot grand totals or positions them at the top or bottom.

• pivotPanelShow

  Shows the pivot panel always, only in pivot mode, or never.

• pivotPanel

  Compatibility boolean for the pivot panel. true corresponds to pivotPanelShow: always.

• groupPanel

  Displays a panel where users drag columns to configure row grouping.

• getDataPath

  Builds a tree from a path array from root to the current node. Takes precedence over ID-based tree settings.

• treeIdField

  Node ID field in a parent-ID tree. Configure together with treeParentField.

• treeParentField

  Parent node ID field in a parent-ID tree.

• treeLabelField

  Display label field in a parent-ID tree. Defaults to the ID when omitted.

• masterDetail

  Expands source rows into full-width detail panels, such as items beneath orders.

• detailRowHeight

  Height of expanded detail panels in pixels.

• detailCellRenderer

  Builds detail content using the text, html, or vnode contract. Takes precedence over declarative nested Grids.

• detailGridOptions

  Columns and options for an automatically generated nested Grid in the detail panel. Use with getDetailRowData.

• getDetailRowData

  Returns detail rows for the expanded parent as an array or Promise. Reuses the result while the row remains expanded.

• detailNestingLevel

  Depth of nested detail Grids. Set by the parent for generated children and used to enforce recursion limits.

• rangeSelection

  Enables rectangular cell selection, independently of row selection. Supplies ranges for copying, filling, and chart integration.

• clipboardEscapeFormulae

  Escapes spreadsheet formula prefixes in outgoing clipboard text.

• statusBar

  Displays a basic row count or specified status panels below the table. true does not enable every aggregation panel.

• sideBar

  Configures column/filter tool panels and the initially open panel. true provides tabs; a string opens the specified panel.

• rows

  Compatibility input for source rows. Prefer rowData in new configurations and avoid conflicting inputs.

• columns

  Compatibility input for column definitions. Prefer columnDefs in new configurations.

• maxRendered

  Limits the number of rows rendered at once, independently of the total data count.

• engine

  Requests automatic selection, standard JavaScript, or Pro processing. Inspect the actual result with getActiveTier.

• proThreshold

  Data-size threshold for considering the Pro path during automatic engine selection.

• unavailable

  Chooses fallback execution or an error when the requested engine is unavailable.

• brandLogo

  Specifies the default logo, none, or a supported image data URL. Removal and replacement require grid.branding entitlement. Branding appears at the bottom right.

• collaborationRoom

  Collaboration room ID for sharing edits and presence. Connecting multiple devices requires remote service configuration.

• realtimeUrl

  WebSocket URL for remote collaboration. When omitted, collaboration is limited to a same-page/process demo scope.

• collabUserName

  User name shown to other collaboration participants.

• collabUserColor

  Distinctive color for the participant's cursor and presence indicators.

• collabPresence

  Configures participant position and presence indicators.

• collabConflictUi

  Configures user-facing conflict guidance for concurrent edits.

• auditLog

  Records row, cell, selection, and edit-history transitions in an audit log. Disabled by default and separate from long-term server retention.

• auditLogMax

  Maximum audit records retained in memory. Oldest records are removed when exceeded.

• canReadCell

  Synchronous permission callback determining whether a cell can be read. Use alongside server access control.

• maskedCellValue

  Masking text displayed in place of restricted cells.

• canEditCell

  Determines edit permission from the row, column, current value, and app permissions.

• conditionalFormats

  Rules changing matching cells' visual properties, such as backgrounds and text. Does not mutate source values.

• conditionalFormatUi

  Provides a UI for adjusting conditional formatting rules.

• validationRules

  Defines required values, ranges, lists, patterns, custom validation, and other input checks.

• invalidEditMode

  Selects allow to apply invalid values with errors, revert to restore previous values, or block to prevent commits.

• maxSnapshots

  Maximum data snapshots retained in memory. Older snapshots may be removed.

• collabPersistence

  Disables local collaboration persistence or uses IndexedDB. Does not replace server backups.

• initialState

  Versioned view state applied once during initial Grid setup. Use setState for runtime restoration.

• editType

  Selects single-cell editing or editing multiple cells as one row operation.

• enableFillHandle

  Enables the fill handle at the corner of a selected range.

• fillHandleAxes

  Allows horizontal, vertical, or bidirectional filling.

• fillHandleMode

  Chooses copying existing values or extending a sequence when filling.

• alignedGrids

  Specifies linked Grids for synchronized column layouts and related state. Inspect connection results and cycle restrictions in aligned Grid reports.

• isFullWidthRow

  Determines whether a row uses a full-width layout instead of individual column cells.

• fullWidthCellRenderer

  Renderer for full-width row content. Uses a different input contract from regular cell renderers.

• fullWidthRowHeight

  Fixed height or per-row height function for full-width rows.

• pinnedTopRowData

  Row data pinned above the scrolling table.

• pinnedBottomRowData

  Row data pinned below the scrolling table.