# Grid properties

Find 136 sy-grid Grid properties entries by name and open their descriptions, types, and examples.

Canonical: https://grid.syidax.com/docs/options/

<a id="index"></a>

## Complete list

- [rowData](https://grid.syidax.com/docs/options/rowData.md) — The source row array for the table. Pass a new array to replace a complete query result, or use applyTransaction for partial updates.
- [columnDefs](https://grid.syidax.com/docs/options/columnDefs.md) — Defines column data fields, headings, sizes, visibility, and editing. Include column groups to create multi-level headers.
- [context](https://grid.syidax.com/docs/options/context.md) — Passes shared app context to callbacks and the Grid API, such as app-managed permissions and services.
- [components](https://grid.syidax.com/docs/options/components.md) — Registers local custom renderers, editors, filters, and other components for this Grid.
- [externalFilter](https://grid.syidax.com/docs/options/externalFilter.md) — Determines whether each row passes conditions outside the Grid. Supply activation and row predicates or a lifecycle instance.
- [componentTimeoutMs](https://grid.syidax.com/docs/options/componentTimeoutMs.md) — Maximum wait for preparing asynchronous user components. Handle delays and failures with componentError.
- [csvImport](https://grid.syidax.com/docs/options/csvImport.md) — Provides a CSV import button and column mapping flow. Explain whether importing replaces existing columns and data.
- [pdfFontUrl](https://grid.syidax.com/docs/options/pdfFontUrl.md) — An app-hosted TTF/OTF URL for characters absent from the default PDF font, such as Korean characters.
- [pdfAutoFont](https://grid.syidax.com/docs/options/pdfAutoFont.md) — Automatically resolves a PDF font when fontBytes is absent. Tries pdfFontUrl first, then local font access where available.
- [formulas](https://grid.syidax.com/docs/options/formulas.md) — Evaluates cell strings beginning with = as formulas. A1 references use original column and row order, not display sorting.
- [showFormulas](https://grid.syidax.com/docs/options/showFormulas.md) — Displays formula text instead of calculated results for review in a table with formulas enabled.
- [formulaBar](https://grid.syidax.com/docs/options/formulaBar.md) — Shows a formula bar for inspecting and editing the active cell's source value or formula. Enter commits; Escape cancels.
- [workbookId](https://grid.syidax.com/docs/options/workbookId.md) — Identifies the workbook connecting multiple Grid sheets. Set it together with sheetName for cross-sheet references.
- [sheetName](https://grid.syidax.com/docs/options/sheetName.md) — Identifies this Grid sheet within a workbook. Review the effect of renaming it on formulas in other sheets.
- [defaultColDef](https://grid.syidax.com/docs/options/defaultColDef.md) — Defaults shared by all columns. Override individual values in columnDefs for specific columns.
- [theme](https://grid.syidax.com/docs/options/theme.md) — Sets Grid colors and appearance with a light/dark preset or a token object extending a preset.
- [height](https://grid.syidax.com/docs/options/height.md) — Sets the Grid container height as a number or CSS length. Account for virtual scrolling and bottom tools.
- [locale](https://grid.syidax.com/docs/options/locale.md) — A Korean, English, or Japanese preset, or an object overriding default messages. Translate source data and column headings in your app.
- [pagination](https://grid.syidax.com/docs/options/pagination.md) — Displays the table across multiple pages. Does not change the server data query strategy itself.
- [pageSize](https://grid.syidax.com/docs/options/pageSize.md) — Rows displayed per page. Distinguish the displayed row model, including group rows, from source data counts.
- [pageSizeOptions](https://grid.syidax.com/docs/options/pageSizeOptions.md) — The numeric choices available in the page-size selector.
- [rowHeight](https://grid.syidax.com/docs/options/rowHeight.md) — Default row height in pixels. Choose a size suitable for text, cell editors, and touch targets.
- [rowHeightFn](https://grid.syidax.com/docs/options/rowHeightFn.md) — Calculates individual row heights from row indices and data. Call refreshRowHeights when relevant data changes.
- [virtualScroll](https://grid.syidax.com/docs/options/virtualScroll.md) — Enables vertical virtualization, rendering rows near the viewport. Does not reduce total data downloads.
- [quickFilter](https://grid.syidax.com/docs/options/quickFilter.md) — Displays a global search input. Use quickFilterText for an initial term or an external input.
- [quickFilterText](https://grid.syidax.com/docs/options/quickFilterText.md) — The quick-filter search string. Assign a new string from an external app search input too.
- [quickFilterPlaceholder](https://grid.syidax.com/docs/options/quickFilterPlaceholder.md) — Guidance for the quick-filter input. Describe the searchable data scope clearly.
- [quickFilterMode](https://grid.syidax.com/docs/options/quickFilterMode.md) — Combines terms with and, requiring all matches, or or, requiring any match.
- [quickFilterRegex](https://grid.syidax.com/docs/options/quickFilterRegex.md) — Interprets quick-filter input as a regular expression rather than ordinary text.
- [quickFilterDebounce](https://grid.syidax.com/docs/options/quickFilterDebounce.md) — Delay before applying quick-filter input. Balances continuous typing throughput and responsiveness.
- [showEmptyState](https://grid.syidax.com/docs/options/showEmptyState.md) — Shows an empty-state message when no data exists. Distinguish request failures from valid empty results in your app.
- [emptyMessage](https://grid.syidax.com/docs/options/emptyMessage.md) — Message displayed when source data is empty.
- [noMatchesMessage](https://grid.syidax.com/docs/options/noMatchesMessage.md) — Message displayed when data exists but no rows match current search or filters.
- [clearFiltersLabel](https://grid.syidax.com/docs/options/clearFiltersLabel.md) — Label for the clear-filters action in an empty-results view.
- [loading](https://grid.syidax.com/docs/options/loading.md) — Displays app data-request progress. Clear it after both success and failure.
- [loadingMessage](https://grid.syidax.com/docs/options/loadingMessage.md) — Description shown while loading.
- [loadingMode](https://grid.syidax.com/docs/options/loadingMode.md) — Selects the Grid loading indicator. See LoadingMode for supported values.
- [minLoadingDuration](https://grid.syidax.com/docs/options/minLoadingDuration.md) — Minimum loading-indicator duration to avoid brief flashes.
- [datasource](https://grid.syidax.com/docs/options/datasource.md) — Data provider for the infinite row model. Complete each requested range through its success or failure callback.
- [cacheBlockSize](https://grid.syidax.com/docs/options/cacheBlockSize.md) — Block size for requesting and caching remote rows.
- [maxBlocksInCache](https://grid.syidax.com/docs/options/maxBlocksInCache.md) — Maximum cached blocks in the infinite row model. Balances memory use against repeat queries.
- [serverSideDatasource](https://grid.syidax.com/docs/options/serverSideDatasource.md) — Data provider for a row model where the server handles sorting, filtering, grouping, and related requests.
- [serverSideGroupCols](https://grid.syidax.com/docs/options/serverSideGroupCols.md) — Columns grouped on the server, ordered from outermost group inward. An empty array represents flat data.
- [serverSideTransactionWaitMs](https://grid.syidax.com/docs/options/serverSideTransactionWaitMs.md) — Delay for batching asynchronous server row transactions.
- [viewportDatasource](https://grid.syidax.com/docs/options/viewportDatasource.md) — Viewport model supplying data for visible row ranges. Implement initialization, range changes, and cleanup.
- [rowDragManaged](https://grid.syidax.com/docs/options/rowDragManaged.md) — Lets the Grid manage reordering from row dragging. Review restrictions with sorting, filtering, and other row models.
- [spanExportMode](https://grid.syidax.com/docs/options/spanExportMode.md) — Chooses whether merged-cell copying and output include the origin value once or repeat it at every position.
- [rowDragMultiRow](https://grid.syidax.com/docs/options/rowDragMultiRow.md) — Allows dragging multiple selected rows together. Also configure rowDrag on a column and row selection.
- [rowDragText](https://grid.syidax.com/docs/options/rowDragText.md) — Builds drag feedback text from the row count and default label.
- [cellChangeFlash](https://grid.syidax.com/docs/options/cellChangeFlash.md) — Briefly highlights cells changed by editing, pasting, or transactions.
- [enableCellChangeFlash](https://grid.syidax.com/docs/options/enableCellChangeFlash.md) — Compatibility alias for cell change flashing. Do not assign a value that conflicts with cellChangeFlash.
- [contextMenu](https://grid.syidax.com/docs/options/contextMenu.md) — Displays a cell context menu. Use built-in copy, row copy, and CSV actions or replace the list through a callback.
- [columnMenu](https://grid.syidax.com/docs/options/columnMenu.md) — Enables a column action menu in column headers.
- [find](https://grid.syidax.com/docs/options/find.md) — Finds and navigates matching positions in loaded, readable cells. This is not a search of the complete server data set.
- [cellNotes](https://grid.syidax.com/docs/options/cellNotes.md) — Provides standalone notes for readable cells with stable IDs. Requires a storage adapter and Pro entitlement.
- [cellNotesAdapter](https://grid.syidax.com/docs/options/cellNotesAdapter.md) — Implements standalone note loading and atomic revision-based saving. Does not automatically fall back to temporary built-in storage.
- [batchEditToolbar](https://grid.syidax.com/docs/options/batchEditToolbar.md) — Displays tools for starting, committing, and cancelling batch edits.
- [columnMenuItems](https://grid.syidax.com/docs/options/columnMenuItems.md) — Builds column menu items from the current column context.
- [contextMenuItemsCallback](https://grid.syidax.com/docs/options/contextMenuItemsCallback.md) — Returns cell context-menu items. Replaces the entire default list rather than appending to it.
- [keyboardNavigation](https://grid.syidax.com/docs/options/keyboardNavigation.md) — Configures keyboard navigation across cells and internal Grid features.
- [rowSelection](https://grid.syidax.com/docs/options/rowSelection.md) — Disables row selection or enables single/multiple selection. Independent of cell range selection.
- [getRowId](https://grid.syidax.com/docs/options/getRowId.md) — Returns a stable, unique row ID. The same business row must retain its ID after sorting, filtering, and editing.
- [selectionCheckbox](https://grid.syidax.com/docs/options/selectionCheckbox.md) — Displays row selection checkboxes.
- [showSelectionCheckbox](https://grid.syidax.com/docs/options/showSelectionCheckbox.md) — Compatibility alias for selection checkboxes. Avoid conflicts with selectionCheckbox.
- [shiftClickAdditive](https://grid.syidax.com/docs/options/shiftClickAdditive.md) — Chooses whether Shift-click range selection adds to the existing selection.
- [rowHover](https://grid.syidax.com/docs/options/rowHover.md) — Selects CSS-only hover highlighting, stateful hover with events, or no hover.
- [resizableColumns](https://grid.syidax.com/docs/options/resizableColumns.md) — Allows users to resize columns by dragging their boundaries.
- [reorderableColumns](https://grid.syidax.com/docs/options/reorderableColumns.md) — Allows users to reorder columns by dragging headers.
- [columnHiding](https://grid.syidax.com/docs/options/columnHiding.md) — Enables column hiding. Also provide a menu or panel for restoring hidden columns.
- [hideableColumns](https://grid.syidax.com/docs/options/hideableColumns.md) — Compatibility setting for column hiding. Keep it consistent with columnHiding.
- [autoSizeOnDoubleClick](https://grid.syidax.com/docs/options/autoSizeOnDoubleClick.md) — Autosizes a column to its content when its boundary is double-clicked.
- [multiSort](https://grid.syidax.com/docs/options/multiSort.md) — Enables sorting by multiple columns. The sort model order defines priority.
- [enableMultiSort](https://grid.syidax.com/docs/options/enableMultiSort.md) — Compatibility alias for multiple sorting. Keep it consistent with multiSort.
- [headerFilterRow](https://grid.syidax.com/docs/options/headerFilterRow.md) — Displays a row of per-column filter controls below the headers.
- [conditionBuilder](https://grid.syidax.com/docs/options/conditionBuilder.md) — Displays a condition builder combining conditions with AND and OR.
- [virtualizeColumns](https://grid.syidax.com/docs/options/virtualizeColumns.md) — Enables horizontal virtualization, rendering columns near the viewport.
- [groupBy](https://grid.syidax.com/docs/options/groupBy.md) — Groups rows with equal values. A string array creates nested groups in array order.
- [pivotMode](https://grid.syidax.com/docs/options/pivotMode.md) — Enables pivot aggregation across row, column, and value axes. Configure all three axes too.
- [pivotRowGroupColumns](https://grid.syidax.com/docs/options/pivotRowGroupColumns.md) — Fields forming the left-hand row axis of pivot results.
- [pivotColumns](https://grid.syidax.com/docs/options/pivotColumns.md) — Fields whose distinct values expand into pivot result columns at the top.
- [pivotValueColumns](https://grid.syidax.com/docs/options/pivotValueColumns.md) — Value fields aggregated at each pivot intersection.
- [pivotAggFuncs](https://grid.syidax.com/docs/options/pivotAggFuncs.md) — Aggregate function names for each value field. Supports built-in and registered custom functions.
- [pivotSubtotals](https://grid.syidax.com/docs/options/pivotSubtotals.md) — Hides nested pivot subtotals or positions them above or below expanded groups.
- [pivotGrandTotal](https://grid.syidax.com/docs/options/pivotGrandTotal.md) — Hides pivot grand totals or positions them at the top or bottom.
- [pivotPanelShow](https://grid.syidax.com/docs/options/pivotPanelShow.md) — Shows the pivot panel always, only in pivot mode, or never.
- [pivotPanel](https://grid.syidax.com/docs/options/pivotPanel.md) — Compatibility boolean for the pivot panel. true corresponds to pivotPanelShow: always.
- [groupPanel](https://grid.syidax.com/docs/options/groupPanel.md) — Displays a panel where users drag columns to configure row grouping.
- [getDataPath](https://grid.syidax.com/docs/options/getDataPath.md) — Builds a tree from a path array from root to the current node. Takes precedence over ID-based tree settings.
- [treeIdField](https://grid.syidax.com/docs/options/treeIdField.md) — Node ID field in a parent-ID tree. Configure together with treeParentField.
- [treeParentField](https://grid.syidax.com/docs/options/treeParentField.md) — Parent node ID field in a parent-ID tree.
- [treeLabelField](https://grid.syidax.com/docs/options/treeLabelField.md) — Display label field in a parent-ID tree. Defaults to the ID when omitted.
- [masterDetail](https://grid.syidax.com/docs/options/masterDetail.md) — Expands source rows into full-width detail panels, such as items beneath orders.
- [detailRowHeight](https://grid.syidax.com/docs/options/detailRowHeight.md) — Height of expanded detail panels in pixels.
- [detailCellRenderer](https://grid.syidax.com/docs/options/detailCellRenderer.md) — Builds detail content using the text, html, or vnode contract. Takes precedence over declarative nested Grids.
- [detailGridOptions](https://grid.syidax.com/docs/options/detailGridOptions.md) — Columns and options for an automatically generated nested Grid in the detail panel. Use with getDetailRowData.
- [getDetailRowData](https://grid.syidax.com/docs/options/getDetailRowData.md) — Returns detail rows for the expanded parent as an array or Promise. Reuses the result while the row remains expanded.
- [detailNestingLevel](https://grid.syidax.com/docs/options/detailNestingLevel.md) — Depth of nested detail Grids. Set by the parent for generated children and used to enforce recursion limits.
- [rangeSelection](https://grid.syidax.com/docs/options/rangeSelection.md) — Enables rectangular cell selection, independently of row selection. Supplies ranges for copying, filling, and chart integration.
- [clipboardEscapeFormulae](https://grid.syidax.com/docs/options/clipboardEscapeFormulae.md) — Escapes spreadsheet formula prefixes in outgoing clipboard text.
- [statusBar](https://grid.syidax.com/docs/options/statusBar.md) — Displays a basic row count or specified status panels below the table. true does not enable every aggregation panel.
- [sideBar](https://grid.syidax.com/docs/options/sideBar.md) — Configures column/filter tool panels and the initially open panel. true provides tabs; a string opens the specified panel.
- [rows](https://grid.syidax.com/docs/options/rows.md) — Compatibility input for source rows. Prefer rowData in new configurations and avoid conflicting inputs.
- [columns](https://grid.syidax.com/docs/options/columns.md) — Compatibility input for column definitions. Prefer columnDefs in new configurations.
- [maxRendered](https://grid.syidax.com/docs/options/maxRendered.md) — Limits the number of rows rendered at once, independently of the total data count.
- [engine](https://grid.syidax.com/docs/options/engine.md) — Requests automatic selection, standard JavaScript, or Pro processing. Inspect the actual result with getActiveTier.
- [proThreshold](https://grid.syidax.com/docs/options/proThreshold.md) — Data-size threshold for considering the Pro path during automatic engine selection.
- [unavailable](https://grid.syidax.com/docs/options/unavailable.md) — Chooses fallback execution or an error when the requested engine is unavailable.
- [brandLogo](https://grid.syidax.com/docs/options/brandLogo.md) — 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](https://grid.syidax.com/docs/options/collaborationRoom.md) — Collaboration room ID for sharing edits and presence. Connecting multiple devices requires remote service configuration.
- [realtimeUrl](https://grid.syidax.com/docs/options/realtimeUrl.md) — WebSocket URL for remote collaboration. When omitted, collaboration is limited to a same-page/process demo scope.
- [collabUserName](https://grid.syidax.com/docs/options/collabUserName.md) — User name shown to other collaboration participants.
- [collabUserColor](https://grid.syidax.com/docs/options/collabUserColor.md) — Distinctive color for the participant's cursor and presence indicators.
- [collabPresence](https://grid.syidax.com/docs/options/collabPresence.md) — Configures participant position and presence indicators.
- [collabConflictUi](https://grid.syidax.com/docs/options/collabConflictUi.md) — Configures user-facing conflict guidance for concurrent edits.
- [auditLog](https://grid.syidax.com/docs/options/auditLog.md) — Records row, cell, selection, and edit-history transitions in an audit log. Disabled by default and separate from long-term server retention.
- [auditLogMax](https://grid.syidax.com/docs/options/auditLogMax.md) — Maximum audit records retained in memory. Oldest records are removed when exceeded.
- [canReadCell](https://grid.syidax.com/docs/options/canReadCell.md) — Synchronous permission callback determining whether a cell can be read. Use alongside server access control.
- [maskedCellValue](https://grid.syidax.com/docs/options/maskedCellValue.md) — Masking text displayed in place of restricted cells.
- [canEditCell](https://grid.syidax.com/docs/options/canEditCell.md) — Determines edit permission from the row, column, current value, and app permissions.
- [conditionalFormats](https://grid.syidax.com/docs/options/conditionalFormats.md) — Rules changing matching cells' visual properties, such as backgrounds and text. Does not mutate source values.
- [conditionalFormatUi](https://grid.syidax.com/docs/options/conditionalFormatUi.md) — Provides a UI for adjusting conditional formatting rules.
- [validationRules](https://grid.syidax.com/docs/options/validationRules.md) — Defines required values, ranges, lists, patterns, custom validation, and other input checks.
- [invalidEditMode](https://grid.syidax.com/docs/options/invalidEditMode.md) — Selects allow to apply invalid values with errors, revert to restore previous values, or block to prevent commits.
- [maxSnapshots](https://grid.syidax.com/docs/options/maxSnapshots.md) — Maximum data snapshots retained in memory. Older snapshots may be removed.
- [collabPersistence](https://grid.syidax.com/docs/options/collabPersistence.md) — Disables local collaboration persistence or uses IndexedDB. Does not replace server backups.
- [initialState](https://grid.syidax.com/docs/options/initialState.md) — Versioned view state applied once during initial Grid setup. Use setState for runtime restoration.
- [editType](https://grid.syidax.com/docs/options/editType.md) — Selects single-cell editing or editing multiple cells as one row operation.
- [enableFillHandle](https://grid.syidax.com/docs/options/enableFillHandle.md) — Enables the fill handle at the corner of a selected range.
- [fillHandleAxes](https://grid.syidax.com/docs/options/fillHandleAxes.md) — Allows horizontal, vertical, or bidirectional filling.
- [fillHandleMode](https://grid.syidax.com/docs/options/fillHandleMode.md) — Chooses copying existing values or extending a sequence when filling.
- [alignedGrids](https://grid.syidax.com/docs/options/alignedGrids.md) — Specifies linked Grids for synchronized column layouts and related state. Inspect connection results and cycle restrictions in aligned Grid reports.
- [isFullWidthRow](https://grid.syidax.com/docs/options/isFullWidthRow.md) — Determines whether a row uses a full-width layout instead of individual column cells.
- [fullWidthCellRenderer](https://grid.syidax.com/docs/options/fullWidthCellRenderer.md) — Renderer for full-width row content. Uses a different input contract from regular cell renderers.
- [fullWidthRowHeight](https://grid.syidax.com/docs/options/fullWidthRowHeight.md) — Fixed height or per-row height function for full-width rows.
- [pinnedTopRowData](https://grid.syidax.com/docs/options/pinnedTopRowData.md) — Row data pinned above the scrolling table.
- [pinnedBottomRowData](https://grid.syidax.com/docs/options/pinnedBottomRowData.md) — Row data pinned below the scrolling table.