apex-grid 3.4.0 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +439 -0
- package/LICENSE.md +125 -0
- package/README.md +107 -14
- package/components/cell.d.ts +30 -4
- package/components/cell.js +199 -53
- package/components/cell.js.map +1 -1
- package/components/filter-row.d.ts +2 -0
- package/components/filter-row.js +82 -28
- package/components/filter-row.js.map +1 -1
- package/components/grid.d.ts +257 -20
- package/components/grid.js +463 -99
- package/components/grid.js.map +1 -1
- package/components/group-header-row.js +28 -25
- package/components/group-header-row.js.map +1 -1
- package/components/header-row.d.ts +7 -5
- package/components/header-row.js +19 -9
- package/components/header-row.js.map +1 -1
- package/components/header.js +36 -22
- package/components/header.js.map +1 -1
- package/components/row.d.ts +19 -3
- package/components/row.js +96 -22
- package/components/row.js.map +1 -1
- package/components/toolbar.js +2 -1
- package/components/toolbar.js.map +1 -1
- package/components/virtualizer.d.ts +45 -1
- package/components/virtualizer.js +184 -3
- package/components/virtualizer.js.map +1 -1
- package/controllers/dom.d.ts +4 -4
- package/controllers/dom.js +40 -22
- package/controllers/dom.js.map +1 -1
- package/controllers/editing.d.ts +104 -37
- package/controllers/editing.js +230 -78
- package/controllers/editing.js.map +1 -1
- package/controllers/expansion.d.ts +14 -5
- package/controllers/expansion.js +24 -1
- package/controllers/expansion.js.map +1 -1
- package/controllers/filter.d.ts +10 -2
- package/controllers/filter.js +62 -17
- package/controllers/filter.js.map +1 -1
- package/controllers/history.d.ts +45 -8
- package/controllers/history.js +58 -20
- package/controllers/history.js.map +1 -1
- package/controllers/navigation.d.ts +68 -13
- package/controllers/navigation.js +196 -51
- package/controllers/navigation.js.map +1 -1
- package/controllers/pagination.d.ts +6 -0
- package/controllers/pagination.js +10 -2
- package/controllers/pagination.js.map +1 -1
- package/controllers/reorder.js +42 -24
- package/controllers/reorder.js.map +1 -1
- package/controllers/resize.d.ts +17 -2
- package/controllers/resize.js +16 -6
- package/controllers/resize.js.map +1 -1
- package/controllers/row-pin.d.ts +20 -2
- package/controllers/row-pin.js +16 -9
- package/controllers/row-pin.js.map +1 -1
- package/controllers/row-reorder.d.ts +31 -11
- package/controllers/row-reorder.js +117 -37
- package/controllers/row-reorder.js.map +1 -1
- package/controllers/selection.d.ts +11 -4
- package/controllers/selection.js +26 -11
- package/controllers/selection.js.map +1 -1
- package/controllers/sort.d.ts +22 -2
- package/controllers/sort.js +29 -23
- package/controllers/sort.js.map +1 -1
- package/controllers/state.d.ts +65 -10
- package/controllers/state.js +86 -6
- package/controllers/state.js.map +1 -1
- package/controllers/tree.d.ts +15 -10
- package/controllers/tree.js +0 -0
- package/controllers/tree.js.map +1 -1
- package/custom-elements.json +3589 -452
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/highlight.css +15 -8
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/ApexGrid.html +660 -0
- package/docs/classes/ApexGridPaginator.html +36 -0
- package/docs/classes/ApexGridToolbar.html +67 -0
- package/docs/functions/localize.html +2 -2
- package/docs/functions/setup.html +1 -2
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +105 -15
- package/docs/interfaces/ApexCellValidationFailedEvent.html +3 -2
- package/docs/interfaces/ApexCellValueChangedEvent.html +4 -2
- package/docs/interfaces/ApexCellValueChangingEvent.html +3 -2
- package/docs/interfaces/ApexColumnMovedEvent.html +2 -2
- package/docs/interfaces/ApexColumnMovingEvent.html +1 -1
- package/docs/interfaces/ApexDetailContext.html +2 -2
- package/docs/interfaces/ApexGridEventMap.html +9 -6
- package/docs/interfaces/ApexRowEditEndedEvent.html +2 -1
- package/docs/interfaces/ApexRowEditStartedEvent.html +2 -1
- package/docs/interfaces/ApexRowMovingEvent.html +9 -3
- package/docs/interfaces/ApexRowPinningEvent.html +1 -1
- package/docs/interfaces/ApexTreeRowExpandedEvent.html +4 -1
- package/docs/interfaces/ApexTreeRowExpandingEvent.html +4 -1
- package/docs/interfaces/BaseApexCellContext.html +1 -1
- package/docs/interfaces/BaseApexEditorContext.html +1 -1
- package/docs/interfaces/BaseColumnConfiguration.html +3 -3
- package/docs/interfaces/BaseFilterExpression.html +2 -2
- package/docs/interfaces/CSVExportOptions.html +13 -5
- package/docs/interfaces/DataPipelineConfiguration.html +2 -2
- package/docs/interfaces/EditingHistoryConfiguration.html +1 -1
- package/docs/interfaces/ExportFormat.html +2 -2
- package/docs/interfaces/ExportOptions.html +5 -3
- package/docs/interfaces/GridExpansionConfiguration.html +6 -2
- package/docs/interfaces/GridRowPinningConfiguration.html +1 -1
- package/docs/interfaces/GridRowReorderingConfiguration.html +2 -2
- package/docs/interfaces/PaginationConfiguration.html +1 -1
- package/docs/interfaces/PaginationState.html +1 -1
- package/docs/interfaces/SetStateResult.html +3 -2
- package/docs/interfaces/ValidatorContext.html +7 -2
- package/docs/media/_token-values.scss +118 -0
- package/docs/media/package.json +5 -5
- package/docs/media/state-persistence.html +0 -10
- package/docs/modules.html +1 -1
- package/docs/types/DataPipelineParams.html +2 -2
- package/docs/types/EditMode.html +2 -2
- package/docs/types/ExportSource.html +6 -4
- package/docs/types/GridLocaleText.html +1 -1
- package/docs/types/OperandKeys.html +9 -0
- package/docs/types/PaginationMode.html +1 -1
- package/docs/variables/EN_LOCALE.html +3 -3
- package/docs/variables/esLocale.html +1 -1
- package/i18n/en.d.ts +19 -0
- package/i18n/en.js +19 -0
- package/i18n/en.js.map +1 -1
- package/i18n/es.js +19 -0
- package/i18n/es.js.map +1 -1
- package/index.d.ts +2 -0
- package/index.js +2 -0
- package/index.js.map +1 -1
- package/internal/column-types.d.ts +27 -1
- package/internal/column-types.js +75 -49
- package/internal/column-types.js.map +1 -1
- package/internal/constants.d.ts +1 -2
- package/internal/constants.js +0 -4
- package/internal/constants.js.map +1 -1
- package/internal/document-styles.d.ts +30 -0
- package/internal/document-styles.js +48 -0
- package/internal/document-styles.js.map +1 -0
- package/internal/export.d.ts +39 -7
- package/internal/export.js +35 -34
- package/internal/export.js.map +1 -1
- package/internal/feature-module.d.ts +82 -3
- package/internal/feature-module.js +11 -0
- package/internal/feature-module.js.map +1 -1
- package/internal/index.d.ts +6 -4
- package/internal/index.js +5 -3
- package/internal/index.js.map +1 -1
- package/internal/normalize-case.d.ts +8 -1
- package/internal/normalize-case.js +3 -2
- package/internal/normalize-case.js.map +1 -1
- package/internal/state-snapshot.d.ts +60 -8
- package/internal/state-snapshot.js +87 -19
- package/internal/state-snapshot.js.map +1 -1
- package/internal/types.d.ts +17 -2
- package/internal/types.js.map +1 -1
- package/internal/utils.d.ts +48 -6
- package/internal/utils.js +35 -21
- package/internal/utils.js.map +1 -1
- package/internal/validators.js +1 -0
- package/internal/validators.js.map +1 -1
- package/operations/filter/operands/number.js +9 -6
- package/operations/filter/operands/number.js.map +1 -1
- package/operations/filter/operands/string.js +2 -3
- package/operations/filter/operands/string.js.map +1 -1
- package/operations/filter/types.d.ts +13 -1
- package/operations/filter/types.js.map +1 -1
- package/operations/filter.d.ts +6 -0
- package/operations/filter.js +23 -7
- package/operations/filter.js.map +1 -1
- package/operations/quick-filter.js +2 -5
- package/operations/quick-filter.js.map +1 -1
- package/operations/sort.d.ts +21 -2
- package/operations/sort.js +41 -14
- package/operations/sort.js.map +1 -1
- package/package.json +8 -4
- package/setup.d.ts +23 -11
- package/setup.js +19 -21
- package/setup.js.map +1 -1
- package/styles/_common.css.js +1 -1
- package/styles/_common.css.js.map +1 -1
- package/styles/_token-values.css.d.ts +1 -0
- package/styles/_token-values.css.js +3 -0
- package/styles/_token-values.css.js.map +1 -0
- package/styles/_tokens.css.js +1 -1
- package/styles/_tokens.css.js.map +1 -1
- package/styles/body-cell/body-cell.css.js +1 -1
- package/styles/body-cell/body-cell.css.js.map +1 -1
- package/styles/body-cell/cell-renderers.css.js +1 -1
- package/styles/body-cell/cell-renderers.css.js.map +1 -1
- package/styles/body-row/body-row.css.js +1 -1
- package/styles/body-row/body-row.css.js.map +1 -1
- package/styles/document-tokens.css.d.ts +1 -0
- package/styles/document-tokens.css.js +3 -0
- package/styles/document-tokens.css.js.map +1 -0
- package/styles/filter-row/filter-row.css.js +1 -1
- package/styles/filter-row/filter-row.css.js.map +1 -1
- package/styles/grid/_grid.base.css.js +1 -1
- package/styles/grid/_grid.base.css.js.map +1 -1
- package/styles/grid/grid.css.js +1 -1
- package/styles/grid/grid.css.js.map +1 -1
- package/styles/group-header-row/group-header-row.css.js +1 -1
- package/styles/group-header-row/group-header-row.css.js.map +1 -1
- package/styles/header-cell/header-cell.css.js +1 -1
- package/styles/header-cell/header-cell.css.js.map +1 -1
- package/styles/header-row/header-row.base.css.js +1 -1
- package/styles/header-row/header-row.base.css.js.map +1 -1
- package/styles/paginator/paginator.css.js +1 -1
- package/styles/paginator/paginator.css.js.map +1 -1
- package/styles/toolbar/toolbar.css.js +1 -1
- package/styles/toolbar/toolbar.css.js.map +1 -1
- package/tokens.css +78 -0
- package/LICENSE +0 -80
- package/docs/media/LICENSE +0 -80
- package/docs/media/_tokens.scss +0 -193
|
@@ -0,0 +1,660 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ApexGrid | apex-grid</title><meta name="description" content="Documentation for apex-grid"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">apex-grid</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ApexGrid</a></li></ul><h1>Class ApexGrid<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Apex grid is a web component for displaying data in a tabular format quick and easy.</p>
|
|
2
|
+
<p>Out of the box it provides row virtualization, sort and filter operations (client and server side),
|
|
3
|
+
the ability to template cells and headers and column hiding.</p>
|
|
4
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>A working, styled grid requires three things:</p>
|
|
5
|
+
<ol>
|
|
6
|
+
<li>Register the element: <code>import 'apex-grid/define'</code> (or <code>ApexGrid.register()</code>).</li>
|
|
7
|
+
<li>Give the host element a bounded height, e.g. <code>apex-grid { height: 480px }</code> —
|
|
8
|
+
the virtualizer collapses without one.</li>
|
|
9
|
+
<li>Do NOT set <code>display</code> on the host — the component declares <code>:host { display: grid }</code>
|
|
10
|
+
internally and any override breaks the track layout.</li>
|
|
11
|
+
</ol>
|
|
12
|
+
<p>The grid is styled out of the box through <code>--ag-*</code> CSS custom properties —
|
|
13
|
+
there is no theme to import and no <code>configureTheme()</code> call. Override <code>--ag-*</code>
|
|
14
|
+
tokens on the host (or any ancestor) to rebrand; where an Ignite UI palette is
|
|
15
|
+
present, the brand tokens auto-tint from it. For dark mode, set
|
|
16
|
+
the <code>theme="dark"</code> attribute on the host for the built-in slate dark palette
|
|
17
|
+
(further <code>--ag-*</code> overrides still compose on top). Add <code>tinted</code> (e.g.
|
|
18
|
+
<code>theme="tinted"</code> or <code>theme="dark tinted"</code>) to mix the brand into the chrome
|
|
19
|
+
so the grid wears its brand even at rest. See the README "Getting Started"
|
|
20
|
+
and "Theming" sections for the full example and token list.</p>
|
|
21
|
+
</div><div class="tsd-tag-element"><h4 class="tsd-anchor-link" id="element">Element<a href="#element" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>apex-grid</p>
|
|
22
|
+
</div><div class="tsd-tag-attr"><h4 class="tsd-anchor-link" id="attr">Attr<a href="#attr" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>theme - Space-separated theme flags. <code>dark</code> opts into the built-in dark palette; <code>tinted</code> mixes <code>--ag-brand</code> into the chrome surfaces. Combine as <code>theme="dark tinted"</code>.</p>
|
|
23
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires">Fires<a href="#fires" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>sorting - Emitted when sorting is initiated through the UI.</p>
|
|
24
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-1">Fires<a href="#fires-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>sorted - Emitted when a sort operation initiated through the UI has completed.</p>
|
|
25
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-2">Fires<a href="#fires-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>filtering - Emitted when filtering is initiated through the UI.</p>
|
|
26
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-3">Fires<a href="#fires-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>filtered - Emitted when a filter operation initiated through the UI has completed.</p>
|
|
27
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-4">Fires<a href="#fires-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>pageChanging - Cancellable. Emitted before page/page-size changes are applied.</p>
|
|
28
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-5">Fires<a href="#fires-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>pageChanged - Emitted after a page/page-size change has been applied.</p>
|
|
29
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-6">Fires<a href="#fires-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>quickFilterChanging - Cancellable. Emitted before a quick-filter value is applied.</p>
|
|
30
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-7">Fires<a href="#fires-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>quickFilterChanged - Emitted after a quick-filter change has been applied.</p>
|
|
31
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-8">Fires<a href="#fires-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>columnPinning - Cancellable. Emitted before a column's pin position changes.</p>
|
|
32
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-9">Fires<a href="#fires-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>columnPinned - Emitted after a column's pin position has changed.</p>
|
|
33
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-10">Fires<a href="#fires-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>columnMoving - Cancellable. Emitted before a column is moved.</p>
|
|
34
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-11">Fires<a href="#fires-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>columnMoved - Emitted after a column has been moved.</p>
|
|
35
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-12">Fires<a href="#fires-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>cellValueChanging - Cancellable. Emitted before a cell value is committed.</p>
|
|
36
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-13">Fires<a href="#fires-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>cellValueChanged - Emitted after a cell value has been committed.</p>
|
|
37
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-14">Fires<a href="#fires-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowEditStarted - Emitted when a row enters edit mode (row mode only).</p>
|
|
38
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-15">Fires<a href="#fires-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowEditEnded - Emitted when a row leaves edit mode (row mode only).</p>
|
|
39
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-16">Fires<a href="#fires-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowSelecting - Cancellable. Emitted before a selection-set change is applied.</p>
|
|
40
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-17">Fires<a href="#fires-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowSelected - Emitted after a selection-set change has been applied.</p>
|
|
41
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-18">Fires<a href="#fires-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowExpanding - Cancellable. Emitted before the row-expansion set changes (master-detail).</p>
|
|
42
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-19">Fires<a href="#fires-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowExpanded - Emitted after a row-expansion change has been applied.</p>
|
|
43
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-20">Fires<a href="#fires-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>treeRowExpanding - Cancellable. Emitted before a tree-row expansion change (tree mode).</p>
|
|
44
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-21">Fires<a href="#fires-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>treeRowExpanded - Emitted after a tree-row expansion change has been applied.</p>
|
|
45
|
+
</div><div class="tsd-tag-csspart"><h4 class="tsd-anchor-link" id="csspart">Csspart<a href="#csspart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>live-region - Visually-hidden ARIA live region used for screen-reader announcements.</p>
|
|
46
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop">Cssprop<a href="#cssprop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-brand] - Brand color for selection, focus rings, and accents. Auto-tints from <code>--ig-primary-500</code> where an Ignite UI palette is present.</p>
|
|
47
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-1">Cssprop<a href="#cssprop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-brand-strong] - Brand color for hover / pressed states.</p>
|
|
48
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-2">Cssprop<a href="#cssprop-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-grid-shadow] - Grid edge/shadow override. Default is a flat 1px hairline edge; set to <code>var(--ag-shadow-card)</code> (<code>var(--ag-dark-shadow-card)</code> on a dark grid) for the elevated card look, or <code>none</code> to remove it.</p>
|
|
49
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-3">Cssprop<a href="#cssprop-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-grid-bg] - Host card background. Defaults to a subtle light gradient; override with a flat color (or use <code>theme="dark"</code>) for dark themes.</p>
|
|
50
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-4">Cssprop<a href="#cssprop-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-surface] - Grid card background (must be opaque).</p>
|
|
51
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-5">Cssprop<a href="#cssprop-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-surface-alt] - Alternating row tint.</p>
|
|
52
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-6">Cssprop<a href="#cssprop-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-surface-elevated] - Header background.</p>
|
|
53
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-7">Cssprop<a href="#cssprop-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-hairline] - Header / structural gridline color.</p>
|
|
54
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-8">Cssprop<a href="#cssprop-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-border] - Row separator color.</p>
|
|
55
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-9">Cssprop<a href="#cssprop-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-text] - Primary text color.</p>
|
|
56
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-10">Cssprop<a href="#cssprop-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-text-body] - Row text color.</p>
|
|
57
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-11">Cssprop<a href="#cssprop-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-text-muted] - Muted text (roles, labels).</p>
|
|
58
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-12">Cssprop<a href="#cssprop-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-row-hover] - Row hover wash.</p>
|
|
59
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-13">Cssprop<a href="#cssprop-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-grid-bg] - Host card background on <code>theme="dark"</code> grids. Dark grids read the <code>--ag-dark-*</code> colours instead of the light ones.</p>
|
|
60
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-14">Cssprop<a href="#cssprop-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-surface] - Grid card background on dark grids (must be opaque).</p>
|
|
61
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-15">Cssprop<a href="#cssprop-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-surface-alt] - Alternating row tint on dark grids.</p>
|
|
62
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-16">Cssprop<a href="#cssprop-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-surface-elevated] - Header background on dark grids.</p>
|
|
63
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-17">Cssprop<a href="#cssprop-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-hairline] - Header / structural gridline color on dark grids.</p>
|
|
64
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-18">Cssprop<a href="#cssprop-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-border] - Row separator color on dark grids.</p>
|
|
65
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-19">Cssprop<a href="#cssprop-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-text] - Primary text color on dark grids.</p>
|
|
66
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-20">Cssprop<a href="#cssprop-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-text-body] - Row text color on dark grids.</p>
|
|
67
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-21">Cssprop<a href="#cssprop-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-text-muted] - Muted text (roles, labels) on dark grids.</p>
|
|
68
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-22">Cssprop<a href="#cssprop-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-row-hover] - Row hover wash on dark grids.</p>
|
|
69
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-23">Cssprop<a href="#cssprop-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-dark-shadow-card] - Elevated card shadow for dark grids (see <code>--ag-grid-shadow</code>).</p>
|
|
70
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-24">Cssprop<a href="#cssprop-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-row-h] - Row height.</p>
|
|
71
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-25">Cssprop<a href="#cssprop-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-header-h] - Header height.</p>
|
|
72
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-26">Cssprop<a href="#cssprop-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-radius] - Outer card corner radius.</p>
|
|
73
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-27">Cssprop<a href="#cssprop-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-font] - Grid font family.</p>
|
|
74
|
+
</div><div class="tsd-tag-cssprop"><h4 class="tsd-anchor-link" id="cssprop-28">Cssprop<a href="#cssprop-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>[--ag-fs-cell] - Cell font size.</p>
|
|
75
|
+
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://github.com/apexcharts/apex-grid/blob/main/packages/core/src/styles/_tokens.scss">_tokens.scss</a> for the complete <code>--ag-*</code> token list.</p>
|
|
76
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-22">Fires<a href="#fires-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>cellValidationFailed - Emitted when a candidate cell value is rejected by a column validator; the value is not written.</p>
|
|
77
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-23">Fires<a href="#fires-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>historyChanged - Emitted after the undo / redo stacks change; carries the current <code>canUndo</code> / <code>canRedo</code>.</p>
|
|
78
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-24">Fires<a href="#fires-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>stateChanged - Emitted (debounced) whenever the grid's restorable state changes; carries the new <code>getState</code> snapshot.</p>
|
|
79
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-25">Fires<a href="#fires-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowPinning - Cancellable. Emitted before a row is pinned, moved between bands, or unpinned.</p>
|
|
80
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-26">Fires<a href="#fires-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowPinned - Emitted after a row's pin state has changed.</p>
|
|
81
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-27">Fires<a href="#fires-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowMoving - Cancellable. Emitted before a row is moved via drag, keyboard, or <code>moveRow</code>.</p>
|
|
82
|
+
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link" id="fires-28">Fires<a href="#fires-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rowMoved - Emitted after a row has been moved.</p>
|
|
83
|
+
</div></div></section><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="t"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">object</span></span></li></ul></section><section class="tsd-panel tsd-hierarchy" data-refl="151"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">EventEmitterBase</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApexGridEventMap.html" class="tsd-signature-type tsd-kind-interface">ApexGridEventMap</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ApexGrid</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Other</h3><div class="tsd-index-list"><a href="#autogenerate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Generate</span></a>
|
|
84
|
+
<a href="#columngroups" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>column<wbr/>Groups?</span></a>
|
|
85
|
+
<a href="#columnmenu" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>column<wbr/>Menu</span></a>
|
|
86
|
+
<a href="#columnreordering" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>column<wbr/>Reordering</span></a>
|
|
87
|
+
<a href="#columns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>columns</span></a>
|
|
88
|
+
<a href="#columnseparator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>column<wbr/>Separator</span></a>
|
|
89
|
+
<a href="#coordinatehints" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coordinate<wbr/>Hints</span></a>
|
|
90
|
+
<a href="#datapipelineconfiguration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Pipeline<wbr/>Configuration</span></a>
|
|
91
|
+
<a href="#editing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>editing?</span></a>
|
|
92
|
+
<a href="#expansion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>expansion?</span></a>
|
|
93
|
+
<a href="#localetext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>locale<wbr/>Text?</span></a>
|
|
94
|
+
<a href="#pagination" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pagination?</span></a>
|
|
95
|
+
<a href="#rowid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>row<wbr/>Id?</span></a>
|
|
96
|
+
<a href="#rowpinning" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>row<wbr/>Pinning?</span></a>
|
|
97
|
+
<a href="#rowreordering" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>row<wbr/>Reordering?</span></a>
|
|
98
|
+
<a href="#selection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selection?</span></a>
|
|
99
|
+
<a href="#showexport" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>show<wbr/>Export</span></a>
|
|
100
|
+
<a href="#showquickfilter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>show<wbr/>Quick<wbr/>Filter</span></a>
|
|
101
|
+
<a href="#sortconfiguration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort<wbr/>Configuration</span></a>
|
|
102
|
+
<a href="#tree" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tree?</span></a>
|
|
103
|
+
<a href="#canredo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>can<wbr/>Redo</span></a>
|
|
104
|
+
<a href="#canundo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>can<wbr/>Undo</span></a>
|
|
105
|
+
<a href="#columngroupdepth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>column<wbr/>Group<wbr/>Depth</span></a>
|
|
106
|
+
<a href="#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a>
|
|
107
|
+
<a href="#dataview" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data<wbr/>View</span></a>
|
|
108
|
+
<a href="#displaycolumns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>display<wbr/>Columns</span></a>
|
|
109
|
+
<a href="#editingcell" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>editing<wbr/>Cell</span></a>
|
|
110
|
+
<a href="#editingrow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>editing<wbr/>Row</span></a>
|
|
111
|
+
<a href="#expandedrows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>expanded<wbr/>Rows</span></a>
|
|
112
|
+
<a href="#exportformats" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>export<wbr/>Formats</span></a>
|
|
113
|
+
<a href="#filterexpressions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>filter<wbr/>Expressions</span></a>
|
|
114
|
+
<a href="#hascolumngroups" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Column<wbr/>Groups</span></a>
|
|
115
|
+
<a href="#page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>page</span></a>
|
|
116
|
+
<a href="#pagecount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>page<wbr/>Count</span></a>
|
|
117
|
+
<a href="#pageitems" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>page<wbr/>Items</span></a>
|
|
118
|
+
<a href="#pagesize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>page<wbr/>Size</span></a>
|
|
119
|
+
<a href="#pinnedrows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pinned<wbr/>Rows</span></a>
|
|
120
|
+
<a href="#quickfilter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>quick<wbr/>Filter</span></a>
|
|
121
|
+
<a href="#rows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>rows</span></a>
|
|
122
|
+
<a href="#selectedrows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>selected<wbr/>Rows</span></a>
|
|
123
|
+
<a href="#sortexpressions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sort<wbr/>Expressions</span></a>
|
|
124
|
+
<a href="#toolbaractions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>toolbar<wbr/>Actions</span></a>
|
|
125
|
+
<a href="#totalitems" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>total<wbr/>Items</span></a>
|
|
126
|
+
<a href="#announce" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>announce</span></a>
|
|
127
|
+
<a href="#applyedits" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Edits</span></a>
|
|
128
|
+
<a href="#canceledit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Edit</span></a>
|
|
129
|
+
<a href="#clearfilter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Filter</span></a>
|
|
130
|
+
<a href="#clearhistory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>History</span></a>
|
|
131
|
+
<a href="#clearselection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Selection</span></a>
|
|
132
|
+
<a href="#clearsort" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Sort</span></a>
|
|
133
|
+
<a href="#collapseallrows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collapse<wbr/>All<wbr/>Rows</span></a>
|
|
134
|
+
<a href="#collapsealltreerows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collapse<wbr/>All<wbr/>Tree<wbr/>Rows</span></a>
|
|
135
|
+
<a href="#collapserow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collapse<wbr/>Row</span></a>
|
|
136
|
+
<a href="#collapsetreerow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collapse<wbr/>Tree<wbr/>Row</span></a>
|
|
137
|
+
<a href="#commitedit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>commit<wbr/>Edit</span></a>
|
|
138
|
+
<a href="#deselectrow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deselect<wbr/>Row</span></a>
|
|
139
|
+
<a href="#editcell" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Cell</span></a>
|
|
140
|
+
<a href="#editrow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Row</span></a>
|
|
141
|
+
<a href="#expandallrows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>expand<wbr/>All<wbr/>Rows</span></a>
|
|
142
|
+
<a href="#expandalltreerows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>expand<wbr/>All<wbr/>Tree<wbr/>Rows</span></a>
|
|
143
|
+
<a href="#expandrow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>expand<wbr/>Row</span></a>
|
|
144
|
+
<a href="#expandtreerow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>expand<wbr/>Tree<wbr/>Row</span></a>
|
|
145
|
+
<a href="#exportas" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>As</span></a>
|
|
146
|
+
<a href="#exporttocsv" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>To<wbr/>CSV</span></a>
|
|
147
|
+
<a href="#filter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>filter</span></a>
|
|
148
|
+
<a href="#firstpage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>first<wbr/>Page</span></a>
|
|
149
|
+
<a href="#getcolumn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Column</span></a>
|
|
150
|
+
<a href="#getschema" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Schema</span></a>
|
|
151
|
+
<a href="#getstate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>State</span></a>
|
|
152
|
+
<a href="#gotopage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>goto<wbr/>Page</span></a>
|
|
153
|
+
<a href="#isrowexpanded" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Row<wbr/>Expanded</span></a>
|
|
154
|
+
<a href="#isrowselected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Row<wbr/>Selected</span></a>
|
|
155
|
+
<a href="#istreerowexpanded" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Tree<wbr/>Row<wbr/>Expanded</span></a>
|
|
156
|
+
<a href="#lastpage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>last<wbr/>Page</span></a>
|
|
157
|
+
<a href="#localize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>localize</span></a>
|
|
158
|
+
<a href="#movecolumn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Column</span></a>
|
|
159
|
+
<a href="#moverow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Row</span></a>
|
|
160
|
+
<a href="#nextpage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>next<wbr/>Page</span></a>
|
|
161
|
+
<a href="#ownsevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>owns<wbr/>Event</span></a>
|
|
162
|
+
<a href="#pincolumn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pin<wbr/>Column</span></a>
|
|
163
|
+
<a href="#pinrow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pin<wbr/>Row</span></a>
|
|
164
|
+
<a href="#previouspage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>previous<wbr/>Page</span></a>
|
|
165
|
+
<a href="#redo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>redo</span></a>
|
|
166
|
+
<a href="#selectallrows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>All<wbr/>Rows</span></a>
|
|
167
|
+
<a href="#selectrow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Row</span></a>
|
|
168
|
+
<a href="#setpagesize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Page<wbr/>Size</span></a>
|
|
169
|
+
<a href="#setquickfilter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Quick<wbr/>Filter</span></a>
|
|
170
|
+
<a href="#setstate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>State</span></a>
|
|
171
|
+
<a href="#sort" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sort</span></a>
|
|
172
|
+
<a href="#togglerowexpansion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Row<wbr/>Expansion</span></a>
|
|
173
|
+
<a href="#togglerowselection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Row<wbr/>Selection</span></a>
|
|
174
|
+
<a href="#toggletreerow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Tree<wbr/>Row</span></a>
|
|
175
|
+
<a href="#undo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>undo</span></a>
|
|
176
|
+
<a href="#unpincolumn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unpin<wbr/>Column</span></a>
|
|
177
|
+
<a href="#unpinrow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unpin<wbr/>Row</span></a>
|
|
178
|
+
<a href="#updatecolumns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Columns</span></a>
|
|
179
|
+
<a href="#register" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register</span></a>
|
|
180
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">lifecycle</h3><div class="tsd-index-list"><a href="#connectedcallback" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connected<wbr/>Callback</span></a>
|
|
181
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">styles</h3><div class="tsd-index-list"><a href="#styles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>styles</span></a>
|
|
182
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">updates</h3><div class="tsd-index-list"><a href="#requestupdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Update</span></a>
|
|
183
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Other"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Other</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="autogenerate"><span>auto<wbr/>Generate</span><a href="#autogenerate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">autoGenerate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Whether the grid will try to "resolve" its column configuration based on the passed
|
|
184
|
+
data source.</p>
|
|
185
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-1">Remarks<a href="#remarks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This is usually executed on initial rendering in the DOM. It depends on having an existing data source
|
|
186
|
+
to infer the column configuration for the grid.
|
|
187
|
+
Passing an empty data source or having a late bound data source (such as a HTTP request) will usually
|
|
188
|
+
result in empty column configuration for the grid.</p>
|
|
189
|
+
<p>This property is ignored if any existing column configuration already exists in the grid.</p>
|
|
190
|
+
<p>In a scenario where you want to bind a new data source and still keep the auto-generation behavior,
|
|
191
|
+
make sure to reset the column collection of the grid before passing in the new data source.</p>
|
|
192
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-15">// assuming autoGenerate is set to true</span><br/><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">columns</span><span class="hl-1"> = [];</span><br/><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">data</span><span class="hl-1"> = [...];</span>
|
|
193
|
+
</code><button type="button">Copy</button></pre>
|
|
194
|
+
|
|
195
|
+
</div><div class="tsd-tag-attr"><h4 class="tsd-anchor-link" id="attr-1">Attr<a href="#attr-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>auto-generate</p>
|
|
196
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="columngroups"><code class="tsd-tag">Optional</code><span>column<wbr/>Groups</span><a href="#columngroups" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">columnGroups</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/ColumnGroupConfiguration.html" class="tsd-signature-type tsd-kind-interface">ColumnGroupConfiguration</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Column groups rendered as spanning headers above the column header row.</p>
|
|
197
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-2">Remarks<a href="#remarks-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>A column joins a group via its <a href="../interfaces/BaseColumnConfiguration.html#group" class="tsd-kind-property">BaseColumnConfiguration.group</a> id.
|
|
198
|
+
Members must be contiguous within one pin region. <code>columns</code> stays flat — all
|
|
199
|
+
width / pin / resize / reorder machinery is unchanged; grouping is a
|
|
200
|
+
presentational header layer. v1 ships static spanning headers (no collapse).</p>
|
|
201
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">columnGroups</span><span class="hl-1"> = [{ </span><span class="hl-2">id:</span><span class="hl-1"> </span><span class="hl-3">'name'</span><span class="hl-1">, </span><span class="hl-2">headerText:</span><span class="hl-1"> </span><span class="hl-3">'Name'</span><span class="hl-1"> }];</span><br/><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">columns</span><span class="hl-1"> = [{ </span><span class="hl-2">key:</span><span class="hl-1"> </span><span class="hl-3">'first'</span><span class="hl-1">, </span><span class="hl-2">group:</span><span class="hl-1"> </span><span class="hl-3">'name'</span><span class="hl-1"> }, { </span><span class="hl-2">key:</span><span class="hl-1"> </span><span class="hl-3">'last'</span><span class="hl-1">, </span><span class="hl-2">group:</span><span class="hl-1"> </span><span class="hl-3">'name'</span><span class="hl-1"> }];</span>
|
|
202
|
+
</code><button type="button">Copy</button></pre>
|
|
203
|
+
|
|
204
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="columnmenu"><span>column<wbr/>Menu</span><a href="#columnmenu" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">columnMenu</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><div class="tsd-comment tsd-typography"><p>Whether column headers show the column-menu (kebab) button. On by default,
|
|
205
|
+
and the button is always visible (not hover-only). Set to <code>false</code> to hide it
|
|
206
|
+
entirely; a feature module's menu (e.g. the enterprise context menu) stays
|
|
207
|
+
reachable by right-click. This is a JS property (no attribute) so it can
|
|
208
|
+
stay <code>true</code> by default.</p>
|
|
209
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="columnreordering"><span>column<wbr/>Reordering</span><a href="#columnreordering" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">columnReordering</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Enables drag-and-drop column reordering on the column headers.</p>
|
|
210
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-3">Remarks<a href="#remarks-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Per-column opt-out is available through <a href="../interfaces/BaseColumnConfiguration.html#reorderable" class="tsd-kind-property">BaseColumnConfiguration.reorderable</a>.
|
|
211
|
+
Reordering is constrained to a column's own pinning group — start-pinned
|
|
212
|
+
columns can only swap with start-pinned, unpinned with unpinned, and
|
|
213
|
+
end-pinned with end-pinned.</p>
|
|
214
|
+
</div><div class="tsd-tag-attr"><h4 class="tsd-anchor-link" id="attr-2">Attr<a href="#attr-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>column-reordering</p>
|
|
215
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="columns"><span>columns</span><a href="#columns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">columns</span><span class="tsd-signature-symbol">:</span> <a href="../types/ColumnConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Column configuration for the grid.</p>
|
|
216
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="columnseparator"><span>column<wbr/>Separator</span><a href="#columnseparator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">columnSeparator</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><div class="tsd-comment tsd-typography"><p>Shows a persistent vertical divider on the trailing edge of every column
|
|
217
|
+
header, rather than only the frozen-column pin edges.</p>
|
|
218
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-4">Remarks<a href="#remarks-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>On by default. On columns that opt into resizing (via
|
|
219
|
+
<a href="../interfaces/BaseColumnConfiguration.html#resizable" class="tsd-kind-property">BaseColumnConfiguration.resizable</a>) the divider doubles as the
|
|
220
|
+
resize handle: it takes the <code>col-resize</code> cursor and can be dragged to
|
|
221
|
+
resize, so the always-visible line is also the grab target. On
|
|
222
|
+
non-resizable columns it is purely decorative.</p>
|
|
223
|
+
<p>Because the default is <code>true</code>, hide the dividers by setting the property to
|
|
224
|
+
<code>false</code> (<code>grid.columnSeparator = false</code>); the reflected <code>column-separator</code>
|
|
225
|
+
attribute is then removed. The line's color and vertical inset are themeable
|
|
226
|
+
through the <code>--ag-header-separator</code> / <code>--header-separator-color</code> custom
|
|
227
|
+
properties and <code>--apex-header-separator-inset</code>.</p>
|
|
228
|
+
</div><div class="tsd-tag-attr"><h4 class="tsd-anchor-link" id="attr-3">Attr<a href="#attr-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>column-separator</p>
|
|
229
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="coordinatehints"><span>coordinate<wbr/>Hints</span><a href="#coordinatehints" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">coordinateHints</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Transient spreadsheet coordinate hints: when <code>true</code>, a leading row-number
|
|
230
|
+
gutter (1, 2, 3, ...) and A / B / C column letters are revealed so cell
|
|
231
|
+
references are discoverable. Enterprise toggles this while a formula cell is
|
|
232
|
+
being edited; it can also be set directly for a persistent spreadsheet look.
|
|
233
|
+
Reflected so styling / tests can observe it on the host.</p>
|
|
234
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datapipelineconfiguration"><span>data<wbr/>Pipeline<wbr/>Configuration</span><a href="#datapipelineconfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dataPipelineConfiguration</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/DataPipelineConfiguration.html" class="tsd-signature-type tsd-kind-interface">DataPipelineConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Configuration object which controls remote data operations for the grid.</p>
|
|
235
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="editing"><code class="tsd-tag">Optional</code><span>editing</span><a href="#editing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">editing</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GridEditingConfiguration.html" class="tsd-signature-type tsd-kind-interface">GridEditingConfiguration</a></div><div class="tsd-comment tsd-typography"><p>Inline editing configuration for the grid.</p>
|
|
236
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-5">Remarks<a href="#remarks-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Editing is disabled by default. Set <code>enabled: true</code> and (optionally) <code>mode</code>
|
|
237
|
+
(<code>'cell' | 'row'</code>) and <code>trigger</code> (<code>'click' | 'doubleClick'</code>) to opt in.
|
|
238
|
+
Per-column opt-in is required via <a href="../interfaces/BaseColumnConfiguration.html#editable" class="tsd-kind-property">BaseColumnConfiguration.editable</a>.</p>
|
|
239
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">editing</span><span class="hl-1"> = { </span><span class="hl-2">enabled:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">, </span><span class="hl-2">mode:</span><span class="hl-1"> </span><span class="hl-3">'cell'</span><span class="hl-1">, </span><span class="hl-2">trigger:</span><span class="hl-1"> </span><span class="hl-3">'doubleClick'</span><span class="hl-1"> };</span>
|
|
240
|
+
</code><button type="button">Copy</button></pre>
|
|
241
|
+
|
|
242
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="expansion"><code class="tsd-tag">Optional</code><span>expansion</span><a href="#expansion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">expansion</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GridExpansionConfiguration.html" class="tsd-signature-type tsd-kind-interface">GridExpansionConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Row-expansion (master-detail) configuration for the grid.</p>
|
|
243
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-6">Remarks<a href="#remarks-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Expansion is disabled by default. Set <code>enabled: true</code> and supply a
|
|
244
|
+
<code>detailTemplate</code> to opt in. The default UX renders a chevron toggle in a
|
|
245
|
+
dedicated leading column; set <code>showToggleColumn: false</code> to drive
|
|
246
|
+
expansion entirely through the public API or a custom cell template.</p>
|
|
247
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">expansion</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-2">enabled:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">detailTemplate</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">data</span><span class="hl-1"> }) </span><span class="hl-5">=></span><span class="hl-1"> </span><span class="hl-4">html</span><span class="hl-3">`<order-summary .order=</span><span class="hl-5">${</span><span class="hl-2">data</span><span class="hl-5">}</span><span class="hl-3">></order-summary>`</span><span class="hl-1">,</span><br/><span class="hl-1">};</span>
|
|
248
|
+
</code><button type="button">Copy</button></pre>
|
|
249
|
+
|
|
250
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="localetext"><code class="tsd-tag">Optional</code><span>locale<wbr/>Text</span><a href="#localetext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">localeText</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.label"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.controls"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.rowsPerPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.firstPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.previousPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.nextPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.lastPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.summary"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.summaryEmpty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.contains"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.doesNotContain"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.startsWith"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.endsWith"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.equals"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.doesNotEqual"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.greaterThan"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.lessThan"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.greaterThanOrEqual"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.lessThanOrEqual"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.empty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.notEmpty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.all"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.true"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.false"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.filter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.reset"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.close"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.removeFilter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.conditionList"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.changeCondition"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.inputPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.select"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.expand"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.collapse"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.detail"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.selectAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.expandAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.collapseAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.label"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.searchPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.export"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.exportOptions"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.createChart"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.exportXlsx"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.askAI"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grid.label"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.sortedAscending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.sortedDescending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.notSorted"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.filterColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.columnMenu"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.autosizeColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"editor.rating"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.sortedAscending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.sortedDescending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.sortCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.filtered"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.filterCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.selectionCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowSelected"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowsSelected"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.page"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.undoOne"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.undoMany"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.redoOne"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.redoMany"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowExpanded"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowCollapsed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowsExpanded"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.allRowsCollapsed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowPinnedTop"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowPinnedBottom"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowUnpinned"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowGrabbed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowMovedTo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowDropped"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.reorderCancelled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowMoved"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.manualOrderCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.searchPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.noValues"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.selectAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.clearFilter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.blanks"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.more"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.and"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.or"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.column"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.operator"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.value"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.addCondition"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.addGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.remove"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.removeGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.apply"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.clear"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.selectRange"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.count"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.sum"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.average"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.min"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.max"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.noGrid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.columns"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.searchPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.pinColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.moveUp"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.moveDown"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.groupByColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.valueColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.columnLabelColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.pivotMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.rowGroups"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.rowGroupsPivot"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.values"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.columnLabels"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.dragColumns"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.removeChip"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.sortAsc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.sortDesc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.clearSort"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.pinStart"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.pinEnd"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.unpin"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.hideColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.copy"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.close"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.placeholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.chartRange"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.chartView"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.selectionHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.rangeHandle"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.countSeries"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.export"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.exportPng"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.exportSvg"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.copyImage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.imageCopied"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.suggested"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.suggestedHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.by"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.renameHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.emptyTitle"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.emptyRange"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.emptyView"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.swapAxes"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.swapAxesHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.data"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapCategory"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapCategoryNone"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapSeries"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapAggregation"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.secondaryAxis"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.secondaryAxisShort"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcFields"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcName"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcFormula"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcAdd"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcRemove"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.sum"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.avg"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.count"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.min"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.max"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.median"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.legend"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.dataLabels"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.gridlines"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.numberFormat"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.seriesColors"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.none"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.currency"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.percent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.thousands"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.trendline"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.referenceLine"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.referenceBand"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.bandFrom"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.bandTo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.forecast"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.forecastBand"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.axisTitleX"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.axisTitleY"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.column"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.bar"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.line"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.area"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.pie"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.donut"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.scatter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.radar"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.combo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.auto"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.blank"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.expandGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.collapseGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.announceExpanded"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.announceCollapsed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.blank"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.total"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.grandTotal"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.columnsTruncated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"rangeSelection.copied"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"rangeSelection.pasted"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.title"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.placeholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.modeControl"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.modeAsk"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.send"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.cancel"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.thinking"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.undo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.applied"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.noChanges"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.warnings"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.answer"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.error"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.close"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.preview"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.previewHeading"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.previewEmpty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.viaRule"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.viaAI"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.history"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.clearHistory"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.abstained"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.abstainedHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.editorLabel"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.invalid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.ref"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.div0"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.value"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.cycle"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Localization overrides for the grid's built-in UI text (pagination, filter
|
|
251
|
+
operators and controls, row/selection labels, the toolbar, and so on).</p>
|
|
252
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-7">Remarks<a href="#remarks-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>A (possibly partial) map of locale keys to translated strings. Any key you
|
|
253
|
+
omit falls back to the built-in English default, so partial maps are valid.
|
|
254
|
+
A ready-made Spanish dictionary ships as <code>esLocale</code>; community translations
|
|
255
|
+
are just plain objects of the same shape.</p>
|
|
256
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">esLocale</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'@apexcharts/grid'</span><span class="hl-1">;</span><br/><br/><span class="hl-15">// Whole-UI translation:</span><br/><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">localeText</span><span class="hl-1"> = </span><span class="hl-2">esLocale</span><span class="hl-1">;</span><br/><br/><span class="hl-15">// Or override a handful of strings:</span><br/><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">localeText</span><span class="hl-1"> = { </span><span class="hl-3">'toolbar.searchPlaceholder'</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-3">'Buscar productos…'</span><span class="hl-1"> };</span>
|
|
257
|
+
</code><button type="button">Copy</button></pre>
|
|
258
|
+
|
|
259
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pagination"><code class="tsd-tag">Optional</code><span>pagination</span><a href="#pagination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pagination</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/PaginationConfiguration.html" class="tsd-signature-type tsd-kind-interface">PaginationConfiguration</a></div><div class="tsd-comment tsd-typography"><p>Pagination configuration for the grid.</p>
|
|
260
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-8">Remarks<a href="#remarks-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Pagination is disabled by default. Set <code>enabled: true</code> and (optionally) <code>pageSize</code>
|
|
261
|
+
to render the built-in <code><apex-grid-paginator></code> and slice the dataView. For
|
|
262
|
+
server-side pagination set <code>mode: 'remote'</code> and supply <code>totalItems</code>. The grid
|
|
263
|
+
emits the cancellable <code>pageChanging</code> event before applying a change and the
|
|
264
|
+
<code>pageChanged</code> event after the pipeline has run.</p>
|
|
265
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">pagination</span><span class="hl-1"> = { </span><span class="hl-2">enabled:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">, </span><span class="hl-2">pageSize:</span><span class="hl-1"> </span><span class="hl-8">25</span><span class="hl-1"> };</span><br/><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">addEventListener</span><span class="hl-1">(</span><span class="hl-3">'pageChanged'</span><span class="hl-1">, (</span><span class="hl-2">event</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-3">'Now on page'</span><span class="hl-1">, </span><span class="hl-2">event</span><span class="hl-1">.</span><span class="hl-2">detail</span><span class="hl-1">.</span><span class="hl-2">page</span><span class="hl-1">, </span><span class="hl-3">'of'</span><span class="hl-1">, </span><span class="hl-2">event</span><span class="hl-1">.</span><span class="hl-2">detail</span><span class="hl-1">.</span><span class="hl-2">pageCount</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
266
|
+
</code><button type="button">Copy</button></pre>
|
|
267
|
+
|
|
268
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rowid"><code class="tsd-tag">Optional</code><span>row<wbr/>Id</span><a href="#rowid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rowId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Optional stable row-identity resolver.</p>
|
|
269
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-9">Remarks<a href="#remarks-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When provided, <a href="#getstate" class="tsd-kind-method">ApexGrid.getState</a> captures selection / expansion /
|
|
270
|
+
tree rows by the returned id, so they survive a wholesale <a href="#data" class="tsd-kind-accessor">ApexGrid.data</a>
|
|
271
|
+
reload. Without it those rows are captured by positional index into
|
|
272
|
+
<a href="#data" class="tsd-kind-accessor">ApexGrid.data</a>, which round-trips within a session but not across a
|
|
273
|
+
data swap. The id must be unique per row and stable across reloads.</p>
|
|
274
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rowpinning"><code class="tsd-tag">Optional</code><span>row<wbr/>Pinning</span><a href="#rowpinning" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rowPinning</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GridRowPinningConfiguration.html" class="tsd-signature-type tsd-kind-interface">GridRowPinningConfiguration</a></div><div class="tsd-comment tsd-typography"><p>Row-pinning configuration.</p>
|
|
275
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-10">Remarks<a href="#remarks-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Disabled by default. Set <code>enabled: true</code> to allow pinning rows to a sticky
|
|
276
|
+
top / bottom band via <a href="#pinrow" class="tsd-kind-method">ApexGrid.pinRow</a>.</p>
|
|
277
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">rowPinning</span><span class="hl-1"> = { </span><span class="hl-2">enabled:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1"> };</span><br/><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">pinRow</span><span class="hl-1">(</span><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">data</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">], </span><span class="hl-3">'top'</span><span class="hl-1">);</span>
|
|
278
|
+
</code><button type="button">Copy</button></pre>
|
|
279
|
+
|
|
280
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rowreordering"><code class="tsd-tag">Optional</code><span>row<wbr/>Reordering</span><a href="#rowreordering" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rowReordering</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GridRowReorderingConfiguration.html" class="tsd-signature-type tsd-kind-interface">GridRowReorderingConfiguration</a></div><div class="tsd-comment tsd-typography"><p>Row-reordering configuration.</p>
|
|
281
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-11">Remarks<a href="#remarks-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Disabled by default. Set <code>enabled: true</code> to allow drag / keyboard reorder
|
|
282
|
+
and <a href="#moverow" class="tsd-kind-method">ApexGrid.moveRow</a>. A manual order is mutually exclusive with
|
|
283
|
+
column sorting (applying a sort clears it). Set <code>applyToData: true</code> to also
|
|
284
|
+
splice <a href="#data" class="tsd-kind-accessor">ApexGrid.data</a> in place.</p>
|
|
285
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-7">Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">rowReordering</span><span class="hl-1"> = { </span><span class="hl-2">enabled:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1"> };</span>
|
|
286
|
+
</code><button type="button">Copy</button></pre>
|
|
287
|
+
|
|
288
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="selection"><code class="tsd-tag">Optional</code><span>selection</span><a href="#selection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">selection</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GridSelectionConfiguration.html" class="tsd-signature-type tsd-kind-interface">GridSelectionConfiguration</a></div><div class="tsd-comment tsd-typography"><p>Row selection configuration for the grid.</p>
|
|
289
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-12">Remarks<a href="#remarks-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Selection is disabled by default. Set <code>enabled: true</code> and (optionally)
|
|
290
|
+
<code>mode</code> (<code>'single' | 'multiple'</code>) and <code>showCheckboxColumn</code> to opt in.</p>
|
|
291
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-8">Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">selection</span><span class="hl-1"> = { </span><span class="hl-2">enabled:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">, </span><span class="hl-2">mode:</span><span class="hl-1"> </span><span class="hl-3">'multiple'</span><span class="hl-1">, </span><span class="hl-2">showCheckboxColumn:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1"> };</span>
|
|
292
|
+
</code><button type="button">Copy</button></pre>
|
|
293
|
+
|
|
294
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="showexport"><span>show<wbr/>Export</span><a href="#showexport" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">showExport</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Whether the built-in export menu is rendered in the toolbar.</p>
|
|
295
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-13">Remarks<a href="#remarks-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When <code>true</code>, the toolbar shows a download button on the trailing side;
|
|
296
|
+
clicking it opens a menu with one entry per <a href="#exportformats" class="tsd-kind-accessor">ApexGrid.exportFormats</a>
|
|
297
|
+
(CSV in the community grid) that calls <a href="#exportas" class="tsd-kind-method">ApexGrid.exportAs</a>.
|
|
298
|
+
<a href="#exporttocsv" class="tsd-kind-method">ApexGrid.exportToCSV</a> remains callable programmatically regardless
|
|
299
|
+
of this flag.</p>
|
|
300
|
+
</div><div class="tsd-tag-attr"><h4 class="tsd-anchor-link" id="attr-4">Attr<a href="#attr-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>show-export</p>
|
|
301
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="showquickfilter"><span>show<wbr/>Quick<wbr/>Filter</span><a href="#showquickfilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">showQuickFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>Whether the built-in quick-filter input is rendered in the toolbar.</p>
|
|
302
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-14">Remarks<a href="#remarks-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The <a href="#quickfilter" class="tsd-kind-accessor">ApexGrid.quickFilter</a> value can be controlled programmatically
|
|
303
|
+
regardless of this flag; this only controls the toolbar input UI.</p>
|
|
304
|
+
</div><div class="tsd-tag-attr"><h4 class="tsd-anchor-link" id="attr-5">Attr<a href="#attr-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>show-quick-filter</p>
|
|
305
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sortconfiguration"><span>sort<wbr/>Configuration</span><a href="#sortconfiguration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sortConfiguration</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GridSortConfiguration.html" class="tsd-signature-type tsd-kind-interface">GridSortConfiguration</a><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Sort configuration property for the grid.</p>
|
|
306
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tree"><code class="tsd-tag">Optional</code><span>tree</span><a href="#tree" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tree</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GridTreeConfiguration.html" class="tsd-signature-type tsd-kind-interface">GridTreeConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Tree-data (nested rows) configuration for the grid.</p>
|
|
307
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-15">Remarks<a href="#remarks-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Tree mode keeps <a href="#data" class="tsd-kind-accessor">ApexGrid.data</a> flat; the grid derives the
|
|
308
|
+
hierarchy from a user-supplied <code>getDataPath(row)</code> callback (the
|
|
309
|
+
flat-array "tree data" pattern). When enabled, the first visible data column (or
|
|
310
|
+
the column referenced by <code>groupColumnKey</code>) renders a chevron toggle
|
|
311
|
+
and depth-based indentation.</p>
|
|
312
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-9">Example<a href="#example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">tree</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-2">enabled:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">getDataPath</span><span class="hl-2">:</span><span class="hl-1"> (</span><span class="hl-2">row</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> </span><span class="hl-2">row</span><span class="hl-1">.</span><span class="hl-2">path</span><span class="hl-1">, </span><span class="hl-15">// e.g., ['Adrian'], ['Adrian', 'Bryan']</span><br/><span class="hl-1"> </span><span class="hl-2">defaultExpanded:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1">};</span>
|
|
313
|
+
</code><button type="button">Copy</button></pre>
|
|
314
|
+
|
|
315
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="canredo"><span>can<wbr/>Redo</span><a href="#canredo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="canredocanredo"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">canRedo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether there is a previously-undone edit to redo.</p>
|
|
316
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="canundo"><span>can<wbr/>Undo</span><a href="#canundo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="canundocanundo"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">canUndo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether there is a recorded edit to undo.</p>
|
|
317
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-16">Remarks<a href="#remarks-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Always <code>false</code> unless <code>editing.history.enabled</code> is set.</p>
|
|
318
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="columngroupdepth"><span>column<wbr/>Group<wbr/>Depth</span><a href="#columngroupdepth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="columngroupdepthcolumngroupdepth"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">columnGroupDepth</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Number of group header rows above the column header (0 or 1 in v1).</p>
|
|
319
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="data"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datadata"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">data</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The data source for the grid. <code>null</code> or <code>undefined</code> (a framework prop that
|
|
320
|
+
is still loading) is stored as an empty array.</p>
|
|
321
|
+
</div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">[]</span>
|
|
322
|
+
</code><button type="button">Copy</button></pre>
|
|
323
|
+
|
|
324
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dataview"><span>data<wbr/>View</span><a href="#dataview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="dataviewdataview"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">dataView</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the state of the data source after sort/filter operations
|
|
325
|
+
have been applied.</p>
|
|
326
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="displaycolumns"><span>display<wbr/>Columns</span><a href="#displaycolumns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="displaycolumnsdisplaycolumns"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">displayColumns</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <a href="../types/ColumnConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The columns in visual render order: <code>'start'</code>-pinned columns first, then
|
|
327
|
+
unpinned columns, then <code>'end'</code>-pinned columns.</p>
|
|
328
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-keyword">readonly</span> <a href="../types/ColumnConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-17">Remarks<a href="#remarks-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use this when you need to iterate the columns in the same order the grid
|
|
329
|
+
actually displays them (for example to build a column chooser). Public APIs
|
|
330
|
+
like <a href="#getcolumn" class="tsd-kind-method">ApexGrid.getColumn</a> continue to operate on the user-supplied
|
|
331
|
+
<a href="#columns" class="tsd-kind-property">ApexGrid.columns</a> array.</p>
|
|
332
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="editingcell"><span>editing<wbr/>Cell</span><a href="#editingcell" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="editingcelleditingcell"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">editingCell</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">columnKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rowIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The cell currently in edit mode, or <code>null</code>. <code>rowIndex</code> is view-relative
|
|
333
|
+
(matches <a href="#pageitems" class="tsd-kind-accessor">ApexGrid.pageItems</a>), or -1 when the edited record is
|
|
334
|
+
pinned or on another page.</p>
|
|
335
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">columnKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rowIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="editingrow"><span>editing<wbr/>Row</span><a href="#editingrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="editingroweditingrow"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">editingRow</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The view-relative index of the row currently in edit mode (row edit mode
|
|
336
|
+
only), or <code>null</code>. It is -1 when the edited record is pinned or on another
|
|
337
|
+
page.</p>
|
|
338
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="expandedrows"><span>expanded<wbr/>Rows</span><a href="#expandedrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="expandedrowsexpandedrows"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">expandedRows</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The currently expanded rows, in insertion order.</p>
|
|
339
|
+
</div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-18">Remarks<a href="#remarks-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Returned as a plain array snapshot — mutating the returned array does
|
|
340
|
+
not change the grid's expansion state. Set this property to replace the
|
|
341
|
+
expansion set programmatically (goes through the cancellable
|
|
342
|
+
<code>rowExpanding</code> event).</p>
|
|
343
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exportformats"><span>export<wbr/>Formats</span><a href="#exportformats" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="exportformatsexportformats"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">exportFormats</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <a href="../interfaces/ExportFormat.html" class="tsd-signature-type tsd-kind-interface">ExportFormat</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The export formats offered in the toolbar's export menu, in order.</p>
|
|
344
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-keyword">readonly</span> <a href="../interfaces/ExportFormat.html" class="tsd-signature-type tsd-kind-interface">ExportFormat</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-19">Remarks<a href="#remarks-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The community grid offers CSV only. This is the seam derived grids use to
|
|
345
|
+
contribute more formats: <code>@apexcharts/grid-enterprise</code> overrides it to add
|
|
346
|
+
<code>'xlsx'</code>. The toolbar renders one menu item per entry and dispatches the
|
|
347
|
+
chosen id to <a href="#exportas" class="tsd-kind-method">ApexGrid.exportAs</a>.</p>
|
|
348
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filterexpressions"><span>filter<wbr/>Expressions</span><a href="#filterexpressions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="filterexpressionsfilterexpressions"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">filterExpressions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/FilterExpression.html" class="tsd-signature-type tsd-kind-type-alias">FilterExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the filter state for the grid.</p>
|
|
349
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../types/FilterExpression.html" class="tsd-signature-type tsd-kind-type-alias">FilterExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4></div></li><li><div class="tsd-signature" id="filterexpressionsfilterexpressions-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">filterExpressions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">expressions</span><span class="tsd-signature-symbol">:</span> <a href="../types/FilterExpression.html" class="tsd-signature-type tsd-kind-type-alias">FilterExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the filter state for the grid.</p>
|
|
350
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">expressions</span>: <a href="../types/FilterExpression.html" class="tsd-signature-type tsd-kind-type-alias">FilterExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-20">Remarks<a href="#remarks-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Replaces the current filter; <code>[]</code>, <code>null</code> or <code>undefined</code> clears it. Applied
|
|
351
|
+
at the next update, against the columns as they are then.</p>
|
|
352
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hascolumngroups"><span>has<wbr/>Column<wbr/>Groups</span><a href="#hascolumngroups" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="hascolumngroupshascolumngroups"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">hasColumnGroups</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether a group header row should render: at least one configured group has
|
|
353
|
+
a visible member column.</p>
|
|
354
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="page"><span>page</span><a href="#page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="pagepage"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">page</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The current zero-based page index.</p>
|
|
355
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-21">Remarks<a href="#remarks-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Navigates like <a href="#gotopage" class="tsd-kind-method">ApexGrid.gotoPage</a>, with the cancellable
|
|
356
|
+
<code>pageChanging</code> and the <code>pageChanged</code> events. Assigned before the first
|
|
357
|
+
render, or while a data, filter or quick filter change has yet to render,
|
|
358
|
+
the page is kept as given and clamped once the view settles, without those
|
|
359
|
+
events.</p>
|
|
360
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pagecount"><span>page<wbr/>Count</span><a href="#pagecount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="pagecountpagecount"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">pageCount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The total number of pages computed from <a href="#totalitems" class="tsd-kind-accessor">ApexGrid.totalItems</a> and <a href="#pagesize" class="tsd-kind-accessor">ApexGrid.pageSize</a>.</p>
|
|
361
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pageitems"><span>page<wbr/>Items</span><a href="#pageitems" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="pageitemspageitems"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">pageItems</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The records currently rendered into the virtualized body.</p>
|
|
362
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-22">Remarks<a href="#remarks-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Equal to <a href="#dataview" class="tsd-kind-accessor">ApexGrid.dataView</a> when pagination is disabled. With pagination
|
|
363
|
+
enabled (<code>'local'</code> mode) this is the active page slice.</p>
|
|
364
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pagesize"><span>page<wbr/>Size</span><a href="#pagesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="pagesizepagesize"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">pageSize</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The current page size.</p>
|
|
365
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pinnedrows"><span>pinned<wbr/>Rows</span><a href="#pinnedrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="pinnedrowspinnedrows"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">pinnedRows</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">bottom</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">top</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The currently pinned rows per band, in the order they were pinned.</p>
|
|
366
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">bottom</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">top</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="quickfilter"><span>quick<wbr/>Filter</span><a href="#quickfilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="quickfilterquickfilter"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">quickFilter</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The quick-filter (global search) value applied to the dataView.</p>
|
|
367
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-23">Remarks<a href="#remarks-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When non-empty, the grid filters records whose visible-column values contain
|
|
368
|
+
the term (case-insensitive substring match). Customise by providing
|
|
369
|
+
<a href="../interfaces/DataPipelineConfiguration.html#quickfilter" class="tsd-kind-property">DataPipelineConfiguration.quickFilter</a>.</p>
|
|
370
|
+
</div><div class="tsd-tag-attr"><h4 class="tsd-anchor-link" id="attr-6">Attr<a href="#attr-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>quick-filter</p>
|
|
371
|
+
</div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">''</span>
|
|
372
|
+
</code><button type="button">Copy</button></pre>
|
|
373
|
+
|
|
374
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rows"><span>rows</span><a href="#rows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="rowsrows"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">rows</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ApexGridRow</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the collection of rendered row elements in the grid.</p>
|
|
375
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ApexGridRow</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-24">Remarks<a href="#remarks-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Since the grid has virtualization, this property returns only the currently rendered
|
|
376
|
+
chunk of elements in the DOM.</p>
|
|
377
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="selectedrows"><span>selected<wbr/>Rows</span><a href="#selectedrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="selectedrowsselectedrows"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">selectedRows</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The currently selected rows, in insertion order.</p>
|
|
378
|
+
</div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-25">Remarks<a href="#remarks-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Returned as a plain array snapshot — mutating the returned array does
|
|
379
|
+
not change the grid's selection. Set this property to replace the
|
|
380
|
+
selection programmatically (goes through the cancellable
|
|
381
|
+
<code>rowSelecting</code> event).</p>
|
|
382
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sortexpressions"><span>sort<wbr/>Expressions</span><a href="#sortexpressions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="sortexpressionssortexpressions"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">sortExpressions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/SortExpression.html" class="tsd-signature-type tsd-kind-type-alias">SortExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the sort state for the grid.</p>
|
|
383
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../types/SortExpression.html" class="tsd-signature-type tsd-kind-type-alias">SortExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4></div></li><li><div class="tsd-signature" id="sortexpressionssortexpressions-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">sortExpressions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">expressions</span><span class="tsd-signature-symbol">:</span> <a href="../types/SortExpression.html" class="tsd-signature-type tsd-kind-type-alias">SortExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the sort state for the grid.</p>
|
|
384
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">expressions</span>: <a href="../types/SortExpression.html" class="tsd-signature-type tsd-kind-type-alias">SortExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-26">Remarks<a href="#remarks-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Replaces the current sort; <code>[]</code>, <code>null</code> or <code>undefined</code> clears it. Applied
|
|
385
|
+
at the next update, against the columns as they are then.</p>
|
|
386
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toolbaractions"><span>toolbar<wbr/>Actions</span><a href="#toolbaractions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="toolbaractionstoolbaractions"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">toolbarActions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">ToolbarAction</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Custom action buttons rendered in the toolbar's trailing actions area, in
|
|
387
|
+
order.</p>
|
|
388
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">ToolbarAction</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-27">Remarks<a href="#remarks-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The community grid contributes none. This is the seam derived grids use to
|
|
389
|
+
add toolbar buttons (mirroring <a href="#exportformats" class="tsd-kind-accessor">ApexGrid.exportFormats</a>):
|
|
390
|
+
<code>@apexcharts/grid-enterprise</code> overrides it to add a "Create chart" action.
|
|
391
|
+
The toolbar renders one button per entry and calls its <code>run()</code> on click.</p>
|
|
392
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="totalitems"><span>total<wbr/>Items</span><a href="#totalitems" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="totalitemstotalitems"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">totalItems</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The total number of items in the <a href="#dataview" class="tsd-kind-accessor">ApexGrid.dataView</a> collection.</p>
|
|
393
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-28">Remarks<a href="#remarks-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This is always the post-filter, post-sort row count — pagination does not change it.
|
|
394
|
+
Use <a href="#pageitems" class="tsd-kind-accessor">ApexGrid.pageItems</a> to read the rows currently rendered into the body.</p>
|
|
395
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="announce"><span>announce</span><a href="#announce" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="announce-1"><span class="tsd-kind-call-signature">announce</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#announce-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the live region's announcement text. Screen readers configured to
|
|
396
|
+
read polite live updates will read the new value aloud.</p>
|
|
397
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-29">Remarks<a href="#remarks-29" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use this from custom UI affordances (e.g. an "Apply filter" button) so
|
|
398
|
+
the change is announced. Built-in operations (sort / filter / page /
|
|
399
|
+
select / expand) call this internally already.</p>
|
|
400
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="applyedits"><span>apply<wbr/>Edits</span><a href="#applyedits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="applyedits-1"><span class="tsd-kind-call-signature">applyEdits</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">edits</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> (<br/> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">column</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">row</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rowIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rowIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">}</span><br/> )<br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">applied</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">cancelled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">invalid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">skipped</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">unchanged</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><a href="#applyedits-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies many cell edits as a <strong>single</strong> operation.</p>
|
|
401
|
+
<p>Every write goes through the same choke point interactive editing uses, so
|
|
402
|
+
each one emits the cancellable <code>cellValueChanging</code> and then
|
|
403
|
+
<code>cellValueChanged</code>, and runs the column's validators. What differs from
|
|
404
|
+
calling <a href="#editcell" class="tsd-kind-method">editCell</a> + <a href="#commitedit" class="tsd-kind-method">commitEdit</a> in a loop is that the whole
|
|
405
|
+
set lands as one undo step and triggers one pipeline run, which is the
|
|
406
|
+
point: a thousand <code>editCell</code> round-trips would be a thousand entries in the
|
|
407
|
+
undo stack and a thousand re-renders.</p>
|
|
408
|
+
<p>Name each target cell's row in one of two ways. <code>rowIndex</code> is
|
|
409
|
+
view-relative and matches <a href="#pageitems" class="tsd-kind-accessor">ApexGrid.pageItems</a>, the same as
|
|
410
|
+
<a href="#editcell" class="tsd-kind-method">editCell</a>, so it reaches the current page only. <code>row</code> is the record
|
|
411
|
+
itself (a live reference into <a href="#data" class="tsd-kind-accessor">ApexGrid.data</a>), which also reaches
|
|
412
|
+
rows on other pages, pinned rows and rows under a collapsed tree parent;
|
|
413
|
+
their events and validators see <code>rowIndex</code> -1. A <code>rowIndex</code> must be a
|
|
414
|
+
whole number from 0 to <code>pageItems.length - 1</code>. Edits naming an unknown
|
|
415
|
+
column, any other row index (negative, fractional or past the end of the
|
|
416
|
+
page), a row a feature synthesized (a group header, a total, a row a
|
|
417
|
+
server has not sent yet), or a column the user could not edit
|
|
418
|
+
either (editing off, not <code>editable</code>, or hidden: the same gate interactive
|
|
419
|
+
editing uses) are skipped rather than throwing, so a partially-stale batch
|
|
420
|
+
still applies what it can.</p>
|
|
421
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">edits</span>: <span class="tsd-signature-keyword">readonly</span> (<br/> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">column</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">row</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rowIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">rowIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">}</span><br/> )<br/>)<span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Cells to write. Order is preserved, so later edits to the same
|
|
422
|
+
cell win.</p>
|
|
423
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">applied</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">cancelled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">invalid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">skipped</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">unchanged</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></h4><p>A per-outcome tally. <code>applied</code> counts cells whose value actually
|
|
424
|
+
changed; <code>unchanged</code>, <code>invalid</code> and <code>cancelled</code> explain the rest, so a caller
|
|
425
|
+
can tell a rejected batch from a no-op one.</p>
|
|
426
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-bulk-clear-a-column-for-the-rows-the-user-selected-on-any-page">Example: Bulk-clear a column for the rows the user selected, on any page<a href="#example-bulk-clear-a-column-for-the-rows-the-user-selected-on-any-page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">applyEdits</span><span class="hl-1">(</span><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-2">selectedRows</span><span class="hl-1">.</span><span class="hl-4">map</span><span class="hl-1">((</span><span class="hl-2">row</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> ({ </span><span class="hl-2">row</span><span class="hl-1">, </span><span class="hl-2">column:</span><span class="hl-1"> </span><span class="hl-3">'discount'</span><span class="hl-1">, </span><span class="hl-2">value:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1"> })));</span>
|
|
427
|
+
</code><button type="button">Copy</button></pre>
|
|
428
|
+
|
|
429
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="canceledit"><span>cancel<wbr/>Edit</span><a href="#canceledit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="canceledit-1"><span class="tsd-kind-call-signature">cancelEdit</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#canceledit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Discards the current edit without writing back to <a href="#data" class="tsd-kind-accessor">ApexGrid.data</a>.</p>
|
|
430
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearfilter"><span>clear<wbr/>Filter</span><a href="#clearfilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="clearfilter-1"><span class="tsd-kind-call-signature">clearFilter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#clearfilter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Resets the current filter state of the control.</p>
|
|
431
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearhistory"><span>clear<wbr/>History</span><a href="#clearhistory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="clearhistory-1"><span class="tsd-kind-call-signature">clearHistory</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#clearhistory-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the undo / redo stacks.</p>
|
|
432
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearselection"><span>clear<wbr/>Selection</span><a href="#clearselection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="clearselection-1"><span class="tsd-kind-call-signature">clearSelection</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#clearselection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the row selection.</p>
|
|
433
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearsort"><span>clear<wbr/>Sort</span><a href="#clearsort" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="clearsort-1"><span class="tsd-kind-call-signature">clearSort</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#clearsort-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Resets the current sort state of the control.</p>
|
|
434
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="collapseallrows"><span>collapse<wbr/>All<wbr/>Rows</span><a href="#collapseallrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="collapseallrows-1"><span class="tsd-kind-call-signature">collapseAllRows</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#collapseallrows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Collapses every currently expanded row.</p>
|
|
435
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="collapsealltreerows"><span>collapse<wbr/>All<wbr/>Tree<wbr/>Rows</span><a href="#collapsealltreerows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="collapsealltreerows-1"><span class="tsd-kind-call-signature">collapseAllTreeRows</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#collapsealltreerows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Collapses every currently-expanded tree row.</p>
|
|
436
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="collapserow"><span>collapse<wbr/>Row</span><a href="#collapserow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="collapserow-1"><span class="tsd-kind-call-signature">collapseRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#collapserow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Collapses <code>row</code>. No-op when the row is not currently expanded.</p>
|
|
437
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="collapsetreerow"><span>collapse<wbr/>Tree<wbr/>Row</span><a href="#collapsetreerow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="collapsetreerow-1"><span class="tsd-kind-call-signature">collapseTreeRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#collapsetreerow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Collapses a tree row. No-op when the row is not currently expanded.</p>
|
|
438
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="commitedit"><span>commit<wbr/>Edit</span><a href="#commitedit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="commitedit-1"><span class="tsd-kind-call-signature">commitEdit</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#commitedit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Commits the current edit.</p>
|
|
439
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-30">Remarks<a href="#remarks-30" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>In cell mode this writes the active cell's pending value. In row mode it
|
|
440
|
+
flushes all pending values for the active row. Emits <code>cellValueChanging</code>
|
|
441
|
+
per changed cell (cancellable) and <code>cellValueChanged</code> after, followed by
|
|
442
|
+
<code>rowEditEnded</code> in row mode.</p>
|
|
443
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deselectrow"><span>deselect<wbr/>Row</span><a href="#deselectrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deselectrow-1"><span class="tsd-kind-call-signature">deselectRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#deselectrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deselects <code>row</code>. No-op if <code>row</code> is not currently selected.</p>
|
|
444
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="editcell"><span>edit<wbr/>Cell</span><a href="#editcell" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="editcell-1"><span class="tsd-kind-call-signature">editCell</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">rowIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">columnKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#editcell-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Begins editing the cell at <code>(rowIndex, columnKey)</code>.</p>
|
|
445
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">rowIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">columnKey</span>: <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-31">Remarks<a href="#remarks-31" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>rowIndex</code> is the view-relative index (matches <a href="#pageitems" class="tsd-kind-accessor">ApexGrid.pageItems</a>).
|
|
446
|
+
Returns <code>false</code> when the column isn't editable, the row index is out of
|
|
447
|
+
range, or the request was rejected (for example in row mode with pending
|
|
448
|
+
changes that couldn't be committed).</p>
|
|
449
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="editrow"><span>edit<wbr/>Row</span><a href="#editrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="editrow-1"><span class="tsd-kind-call-signature">editRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">rowIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#editrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Begins editing the entire row at <code>rowIndex</code> (row edit mode only).</p>
|
|
450
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">rowIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p><code>false</code> when editing is disabled, the grid is in cell mode, or
|
|
451
|
+
the row index is out of range.</p>
|
|
452
|
+
</div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="expandallrows"><span>expand<wbr/>All<wbr/>Rows</span><a href="#expandallrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="expandallrows-1"><span class="tsd-kind-call-signature">expandAllRows</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#expandallrows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Expands every row in <a href="#dataview" class="tsd-kind-accessor">ApexGrid.dataView</a> that passes the optional
|
|
453
|
+
<code>isExpandable</code> predicate.</p>
|
|
454
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="expandalltreerows"><span>expand<wbr/>All<wbr/>Tree<wbr/>Rows</span><a href="#expandalltreerows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="expandalltreerows-1"><span class="tsd-kind-call-signature">expandAllTreeRows</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#expandalltreerows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Expands every parent row in the current tree.</p>
|
|
455
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="expandrow"><span>expand<wbr/>Row</span><a href="#expandrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="expandrow-1"><span class="tsd-kind-call-signature">expandRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#expandrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Expands <code>row</code>. No-op when the row is already expanded, expansion is
|
|
456
|
+
disabled, or the optional <code>isExpandable</code> predicate rejects it.</p>
|
|
457
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="expandtreerow"><span>expand<wbr/>Tree<wbr/>Row</span><a href="#expandtreerow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="expandtreerow-1"><span class="tsd-kind-call-signature">expandTreeRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#expandtreerow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Expands a tree row. No-op when the row is already expanded, has no
|
|
458
|
+
children, or tree mode is disabled.</p>
|
|
459
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exportas"><span>export<wbr/>As</span><a href="#exportas" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="exportas-1"><span class="tsd-kind-call-signature">exportAs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formatId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/ExportOptions.html" class="tsd-signature-type tsd-kind-interface">ExportOptions</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#exportas-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Exports the grid in the given format (one of <a href="#exportformats" class="tsd-kind-accessor">ApexGrid.exportFormats</a>).
|
|
460
|
+
Called by the toolbar's export menu. The community grid handles <code>'csv'</code>;
|
|
461
|
+
derived grids override to handle additional formats, delegating to <code>super</code>
|
|
462
|
+
for the ones they don't add.</p>
|
|
463
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">formatId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/ExportOptions.html" class="tsd-signature-type tsd-kind-interface">ExportOptions</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exporttocsv"><span>export<wbr/>To<wbr/>CSV</span><a href="#exporttocsv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="exporttocsv-1"><span class="tsd-kind-call-signature">exportToCSV</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/CSVExportOptions.html" class="tsd-signature-type tsd-kind-interface">CSVExportOptions</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#exporttocsv-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Exports the current grid contents as a CSV string and (in a browser
|
|
464
|
+
context) triggers a download.</p>
|
|
465
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/CSVExportOptions.html" class="tsd-signature-type tsd-kind-interface">CSVExportOptions</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-32">Remarks<a href="#remarks-32" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>By default the export uses the post-filter/post-sort <code>dataView</code>, includes
|
|
466
|
+
every visible column with <code>exportable !== false</code>, and prepends a UTF-8 BOM
|
|
467
|
+
so Excel opens the file with the right encoding. Pass <code>source: 'page'</code> to
|
|
468
|
+
export only the current page, <code>source: 'selected'</code> to export the current
|
|
469
|
+
row selection, or <code>source: 'all'</code> to export the raw <code>data</code> array. The
|
|
470
|
+
returned string is the same content written to the file — useful for
|
|
471
|
+
tests or routing the bytes elsewhere.</p>
|
|
472
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-10">Example<a href="#example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">exportToCSV</span><span class="hl-1">(); </span><span class="hl-15">// download data.csv</span><br/><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">exportToCSV</span><span class="hl-1">({ </span><span class="hl-2">filename:</span><span class="hl-1"> </span><span class="hl-3">'users'</span><span class="hl-1">, </span><span class="hl-2">source:</span><span class="hl-1"> </span><span class="hl-3">'selected'</span><span class="hl-1"> });</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">text</span><span class="hl-1"> = </span><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">exportToCSV</span><span class="hl-1">({ </span><span class="hl-2">filename:</span><span class="hl-1"> </span><span class="hl-3">''</span><span class="hl-1"> }); </span><span class="hl-15">// string only, no download</span>
|
|
473
|
+
</code><button type="button">Copy</button></pre>
|
|
474
|
+
|
|
475
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filter"><span>filter</span><a href="#filter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="filter-1"><span class="tsd-kind-call-signature">filter</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <a href="../types/FilterExpression.html" class="tsd-signature-type tsd-kind-type-alias">FilterExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <a href="../types/FilterExpression.html" class="tsd-signature-type tsd-kind-type-alias">FilterExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#filter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Performs a filter operation in the grid based on the passed expression(s).</p>
|
|
476
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <a href="../types/FilterExpression.html" class="tsd-signature-type tsd-kind-type-alias">FilterExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <a href="../types/FilterExpression.html" class="tsd-signature-type tsd-kind-type-alias">FilterExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="firstpage"><span>first<wbr/>Page</span><a href="#firstpage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="firstpage-1"><span class="tsd-kind-call-signature">firstPage</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#firstpage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Navigates to the first page.</p>
|
|
477
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getcolumn"><span>get<wbr/>Column</span><a href="#getcolumn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getcolumn-1"><span class="tsd-kind-call-signature">getColumn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/ColumnConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#getcolumn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a <a href="../types/ColumnConfiguration.html" class="tsd-kind-type-alias">ColumnConfiguration</a> for a given column.</p>
|
|
478
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/ColumnConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getschema"><span>get<wbr/>Schema</span><a href="#getschema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getschema-1"><span class="tsd-kind-call-signature">getSchema</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GridSchema.html" class="tsd-signature-type tsd-kind-interface">GridSchema</a><a href="#getschema-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A machine-readable description of the grid: its columns and data types, the
|
|
479
|
+
operations available per column (sort directions, filter operands), the
|
|
480
|
+
grid-level capabilities, and the current <a href="#getstate" class="tsd-kind-method">ApexGrid.getState</a> snapshot.</p>
|
|
481
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/GridSchema.html" class="tsd-signature-type tsd-kind-interface">GridSchema</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-33">Remarks<a href="#remarks-33" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This is the contract an AI layer hands to an LLM (to constrain its output)
|
|
482
|
+
and validates a returned patch against before <a href="#setstate" class="tsd-kind-method">ApexGrid.setState</a>, but
|
|
483
|
+
it is AI-agnostic: it equally drives a view-editor UI or documentation. It is
|
|
484
|
+
a descriptor, not a JSON-Schema document. The enterprise grid extends it with
|
|
485
|
+
grouping / pivot / aggregation availability.</p>
|
|
486
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getstate"><span>get<wbr/>State</span><a href="#getstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getstate-1"><span class="tsd-kind-call-signature">getState</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GetStateOptions.html" class="tsd-signature-type tsd-kind-interface">GetStateOptions</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GridState.html" class="tsd-signature-type tsd-kind-interface">GridState</a><a href="#getstate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a serializable, JSON-safe snapshot of the grid's restorable state:
|
|
487
|
+
column layout, sort, filter, quick-filter, pagination, selection, expansion,
|
|
488
|
+
tree expansion, and any feature-module state. Functions and templates are
|
|
489
|
+
omitted (see <a href="../interfaces/GridState.html" class="tsd-kind-interface">GridState</a>).</p>
|
|
490
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/GetStateOptions.html" class="tsd-signature-type tsd-kind-interface">GetStateOptions</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/GridState.html" class="tsd-signature-type tsd-kind-interface">GridState</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-34">Remarks<a href="#remarks-34" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Pair with <a href="#setstate" class="tsd-kind-method">ApexGrid.setState</a> to persist/restore views, drive an AI
|
|
491
|
+
assistant, or implement save/restore. Set <a href="#rowid" class="tsd-kind-property">ApexGrid.rowId</a> for
|
|
492
|
+
selection/expansion to survive a wholesale data reload.</p>
|
|
493
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-11">Example<a href="#example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">snapshot</span><span class="hl-1"> = </span><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">getState</span><span class="hl-1">();</span><br/><span class="hl-2">localStorage</span><span class="hl-1">.</span><span class="hl-4">setItem</span><span class="hl-1">(</span><span class="hl-3">'grid'</span><span class="hl-1">, </span><span class="hl-7">JSON</span><span class="hl-1">.</span><span class="hl-4">stringify</span><span class="hl-1">(</span><span class="hl-2">snapshot</span><span class="hl-1">));</span><br/><span class="hl-15">// later …</span><br/><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">setState</span><span class="hl-1">(</span><span class="hl-7">JSON</span><span class="hl-1">.</span><span class="hl-4">parse</span><span class="hl-1">(</span><span class="hl-2">localStorage</span><span class="hl-1">.</span><span class="hl-4">getItem</span><span class="hl-1">(</span><span class="hl-3">'grid'</span><span class="hl-1">)!));</span>
|
|
494
|
+
</code><button type="button">Copy</button></pre>
|
|
495
|
+
|
|
496
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gotopage"><span>goto<wbr/>Page</span><a href="#gotopage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gotopage-1"><span class="tsd-kind-call-signature">gotoPage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#gotopage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Navigates the grid to the given zero-based <code>page</code> index.</p>
|
|
497
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">page</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The target zero-based page index.</p>
|
|
498
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p><code>true</code> if the change was applied, <code>false</code> if cancelled or a no-op.</p>
|
|
499
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-35">Remarks<a href="#remarks-35" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Emits the cancellable <code>pageChanging</code> event before applying the change and the
|
|
500
|
+
<code>pageChanged</code> event after. Out-of-range values are clamped into <code>[0, pageCount - 1]</code>.</p>
|
|
501
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-12">Example<a href="#example-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">gotoPage</span><span class="hl-1">(</span><span class="hl-8">2</span><span class="hl-1">);</span>
|
|
502
|
+
</code><button type="button">Copy</button></pre>
|
|
503
|
+
|
|
504
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isrowexpanded"><span>is<wbr/>Row<wbr/>Expanded</span><a href="#isrowexpanded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="isrowexpanded-1"><span class="tsd-kind-call-signature">isRowExpanded</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isrowexpanded-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether <code>row</code> is currently expanded.</p>
|
|
505
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isrowselected"><span>is<wbr/>Row<wbr/>Selected</span><a href="#isrowselected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="isrowselected-1"><span class="tsd-kind-call-signature">isRowSelected</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isrowselected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether <code>row</code> is currently selected.</p>
|
|
506
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="istreerowexpanded"><span>is<wbr/>Tree<wbr/>Row<wbr/>Expanded</span><a href="#istreerowexpanded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="istreerowexpanded-1"><span class="tsd-kind-call-signature">isTreeRowExpanded</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#istreerowexpanded-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether <code>row</code> is currently expanded in the tree.</p>
|
|
507
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="lastpage"><span>last<wbr/>Page</span><a href="#lastpage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="lastpage-1"><span class="tsd-kind-call-signature">lastPage</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#lastpage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Navigates to the last page.</p>
|
|
508
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="localize"><span>localize</span><a href="#localize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="localize-1"><span class="tsd-kind-call-signature">localize</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.label"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.controls"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.rowsPerPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.firstPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.previousPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.nextPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.lastPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.summary"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.summaryEmpty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.contains"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.doesNotContain"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.startsWith"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.endsWith"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.equals"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.doesNotEqual"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.greaterThan"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.lessThan"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.greaterThanOrEqual"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.lessThanOrEqual"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.empty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.notEmpty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.all"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.true"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.false"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.filter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.reset"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.close"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.removeFilter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.conditionList"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.changeCondition"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.inputPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.select"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.expand"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.collapse"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.detail"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.selectAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.expandAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.collapseAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.label"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.searchPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.export"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.exportOptions"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.createChart"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.exportXlsx"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.askAI"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grid.label"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.sortedAscending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.sortedDescending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.notSorted"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.filterColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.columnMenu"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.autosizeColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"editor.rating"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.sortedAscending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.sortedDescending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.sortCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.filtered"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.filterCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.selectionCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowSelected"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowsSelected"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.page"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.undoOne"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.undoMany"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.redoOne"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.redoMany"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowExpanded"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowCollapsed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowsExpanded"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.allRowsCollapsed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowPinnedTop"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowPinnedBottom"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowUnpinned"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowGrabbed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowMovedTo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowDropped"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.reorderCancelled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowMoved"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.manualOrderCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.searchPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.noValues"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.selectAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.clearFilter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.blanks"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.more"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.and"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.or"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.column"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.operator"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.value"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.addCondition"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.addGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.remove"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.removeGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.apply"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.clear"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.selectRange"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.count"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.sum"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.average"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.min"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.max"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.noGrid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.columns"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.searchPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.pinColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.moveUp"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.moveDown"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.groupByColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.valueColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.columnLabelColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.pivotMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.rowGroups"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.rowGroupsPivot"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.values"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.columnLabels"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.dragColumns"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.removeChip"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.sortAsc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.sortDesc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.clearSort"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.pinStart"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.pinEnd"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.unpin"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.hideColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.copy"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.close"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.placeholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.chartRange"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.chartView"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.selectionHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.rangeHandle"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.countSeries"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.export"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.exportPng"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.exportSvg"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.copyImage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.imageCopied"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.suggested"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.suggestedHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.by"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.renameHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.emptyTitle"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.emptyRange"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.emptyView"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.swapAxes"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.swapAxesHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.data"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapCategory"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapCategoryNone"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapSeries"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapAggregation"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.secondaryAxis"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.secondaryAxisShort"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcFields"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcName"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcFormula"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcAdd"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcRemove"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.sum"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.avg"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.count"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.min"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.max"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.median"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.legend"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.dataLabels"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.gridlines"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.numberFormat"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.seriesColors"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.none"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.currency"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.percent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.thousands"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.trendline"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.referenceLine"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.referenceBand"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.bandFrom"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.bandTo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.forecast"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.forecastBand"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.axisTitleX"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.axisTitleY"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.column"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.bar"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.line"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.area"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.pie"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.donut"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.scatter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.radar"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.combo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.auto"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.blank"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.expandGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.collapseGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.announceExpanded"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.announceCollapsed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.blank"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.total"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.grandTotal"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.columnsTruncated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"rangeSelection.copied"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"rangeSelection.pasted"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.title"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.placeholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.modeControl"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.modeAsk"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.send"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.cancel"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.thinking"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.undo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.applied"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.noChanges"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.warnings"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.answer"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.error"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.close"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.preview"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.previewHeading"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.previewEmpty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.viaRule"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.viaAI"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.history"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.clearHistory"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.abstained"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.abstainedHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.editorLabel"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.invalid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.ref"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.div0"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.value"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.cycle"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LocaleParams.html" class="tsd-signature-type tsd-kind-type-alias">LocaleParams</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#localize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Resolves a built-in locale key to its display string, applying any
|
|
509
|
+
<a href="#localetext" class="tsd-kind-property">ApexGrid.localeText</a> override over the English default and
|
|
510
|
+
interpolating <code>{placeholder}</code> tokens from <code>params</code>.</p>
|
|
511
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.label"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.controls"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.rowsPerPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.firstPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.previousPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.nextPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.lastPage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.summary"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pagination.summaryEmpty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.contains"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.doesNotContain"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.startsWith"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.endsWith"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.equals"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.doesNotEqual"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.greaterThan"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.lessThan"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.greaterThanOrEqual"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.lessThanOrEqual"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.empty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.notEmpty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.all"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.true"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.operator.false"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.filter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.reset"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.close"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.removeFilter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.conditionList"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.changeCondition"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filter.inputPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.select"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.expand"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.collapse"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row.detail"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.selectAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.expandAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.collapseAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.label"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.searchPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.export"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.exportOptions"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.createChart"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.exportXlsx"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolbar.askAI"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grid.label"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.sortedAscending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.sortedDescending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.notSorted"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.filterColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.columnMenu"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"header.autosizeColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"editor.rating"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.sortedAscending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.sortedDescending"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.sortCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.filtered"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.filterCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.selectionCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowSelected"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowsSelected"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.page"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.undoOne"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.undoMany"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.redoOne"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.redoMany"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowExpanded"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowCollapsed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowsExpanded"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.allRowsCollapsed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowPinnedTop"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowPinnedBottom"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowUnpinned"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowGrabbed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowMovedTo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowDropped"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.reorderCancelled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.rowMoved"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"announce.manualOrderCleared"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.searchPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.noValues"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.selectAll"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.clearFilter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.blanks"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"setFilter.more"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.and"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.or"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.column"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.operator"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.value"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.addCondition"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.addGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.remove"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.removeGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.apply"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"filterBuilder.clear"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.selectRange"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.count"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.sum"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.average"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.min"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"statusBar.max"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.noGrid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.columns"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.searchPlaceholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.pinColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.moveUp"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.moveDown"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.groupByColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.valueColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.columnLabelColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.pivotMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.rowGroups"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.rowGroupsPivot"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.values"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.columnLabels"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.dragColumns"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"toolPanel.removeChip"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.sortAsc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.sortDesc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.clearSort"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.pinStart"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.pinEnd"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.unpin"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.hideColumn"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contextMenu.copy"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.close"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.placeholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.chartRange"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.chartView"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.selectionHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.rangeHandle"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.countSeries"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.export"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.exportPng"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.exportSvg"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.copyImage"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.imageCopied"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.suggested"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.suggestedHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.by"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.renameHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.emptyTitle"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.emptyRange"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.emptyView"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.swapAxes"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.swapAxesHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.data"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapCategory"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapCategoryNone"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapSeries"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.mapAggregation"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.secondaryAxis"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.secondaryAxisShort"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcFields"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcName"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcFormula"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcAdd"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.calcRemove"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.sum"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.avg"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.count"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.min"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.max"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.agg.median"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.legend"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.dataLabels"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.gridlines"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.numberFormat"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.seriesColors"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.none"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.currency"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.percent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.format.thousands"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.trendline"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.referenceLine"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.referenceBand"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.bandFrom"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.bandTo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.forecast"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.forecastBand"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.axisTitleX"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.axisTitleY"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.column"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.bar"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.line"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.area"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.pie"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.donut"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.scatter"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.radar"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.combo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart.type.auto"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.blank"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.expandGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.collapseGroup"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.announceExpanded"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"grouping.announceCollapsed"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.blank"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.total"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.grandTotal"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pivot.columnsTruncated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"rangeSelection.copied"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"rangeSelection.pasted"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.title"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.placeholder"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.modeControl"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.modeAsk"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.send"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.cancel"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.thinking"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.undo"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.applied"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.noChanges"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.warnings"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.answer"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.error"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.close"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.preview"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.previewHeading"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.previewEmpty"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.viaRule"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.viaAI"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.history"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.clearHistory"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.abstained"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ai.abstainedHint"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.editorLabel"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.invalid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.ref"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.div0"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.value"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"formula.error.cycle"</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">params</span>: <a href="../types/LocaleParams.html" class="tsd-signature-type tsd-kind-type-alias">LocaleParams</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">fallback</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-36">Remarks<a href="#remarks-36" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Used internally by the grid's components. <code>fallback</code> is returned when the
|
|
512
|
+
key is not part of the built-in set (for example a custom filter operand's
|
|
513
|
+
own label).</p>
|
|
514
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="movecolumn"><span>move<wbr/>Column</span><a href="#movecolumn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="movecolumn-1"><span class="tsd-kind-call-signature">moveColumn</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">fromKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">toKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">position</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ColumnDropPosition.html" class="tsd-signature-type tsd-kind-type-alias">ColumnDropPosition</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#movecolumn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Moves a column relative to another column.</p>
|
|
515
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fromKey</span>: <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span><div class="tsd-comment tsd-typography"><p>The column to move.</p>
|
|
516
|
+
</div></li><li><span><span class="tsd-kind-parameter">toKey</span>: <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span><div class="tsd-comment tsd-typography"><p>The reference column.</p>
|
|
517
|
+
</div></li><li><span><span class="tsd-kind-parameter">position</span>: <a href="../types/ColumnDropPosition.html" class="tsd-signature-type tsd-kind-type-alias">ColumnDropPosition</a><span class="tsd-signature-symbol"> = 'before'</span></span><div class="tsd-comment tsd-typography"><p>Whether to place <code>fromKey</code> before or after <code>toKey</code>. Defaults to <code>'before'</code>.</p>
|
|
518
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p><code>true</code> if the move was applied, <code>false</code> if cancelled or a no-op.</p>
|
|
519
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-37">Remarks<a href="#remarks-37" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Emits the cancellable <code>columnMoving</code> event first and <code>columnMoved</code> after.
|
|
520
|
+
Reordering only succeeds when the source and target columns share the same
|
|
521
|
+
pinning group (start / unpinned / end) — cross-group moves return <code>false</code>.
|
|
522
|
+
Use <a href="#pincolumn" class="tsd-kind-method">ApexGrid.pinColumn</a> to change a column's pinning group first.</p>
|
|
523
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-13">Example<a href="#example-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">moveColumn</span><span class="hl-1">(</span><span class="hl-3">'email'</span><span class="hl-1">, </span><span class="hl-3">'name'</span><span class="hl-1">, </span><span class="hl-3">'after'</span><span class="hl-1">);</span>
|
|
524
|
+
</code><button type="button">Copy</button></pre>
|
|
525
|
+
|
|
526
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="moverow"><span>move<wbr/>Row</span><a href="#moverow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="moverow-1"><span class="tsd-kind-call-signature">moveRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">to</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">position</span><span class="tsd-signature-symbol">?:</span> <a href="../types/RowDropPosition.html" class="tsd-signature-type tsd-kind-type-alias">RowDropPosition</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#moverow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Moves the row at view index <code>from</code> to land <code>position</code> (<code>'before'</code> /
|
|
527
|
+
<code>'after'</code>) the row at view index <code>to</code>. Indices are into
|
|
528
|
+
<a href="#pageitems" class="tsd-kind-accessor">ApexGrid.pageItems</a>.</p>
|
|
529
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">from</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">to</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">position</span>: <a href="../types/RowDropPosition.html" class="tsd-signature-type tsd-kind-type-alias">RowDropPosition</a><span class="tsd-signature-symbol"> = 'before'</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> when applied, <code>false</code> when disabled, out of range, a no-op
|
|
530
|
+
(the row would land where it already is), or cancelled.</p>
|
|
531
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-38">Remarks<a href="#remarks-38" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Requires <code>rowReordering.enabled</code>. Establishes a manual order and clears
|
|
532
|
+
any column sort (the two are mutually exclusive), goes through the
|
|
533
|
+
cancellable <code>rowMoving</code> event, emits <code>rowMoved</code>, and animates the affected
|
|
534
|
+
rows. Rows hidden by a filter keep their place in the order.</p>
|
|
535
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="nextpage"><span>next<wbr/>Page</span><a href="#nextpage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="nextpage-1"><span class="tsd-kind-call-signature">nextPage</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#nextpage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Navigates to the next page. No-op if already on the last page.</p>
|
|
536
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="ownsevent"><span>owns<wbr/>Event</span><a href="#ownsevent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="ownsevent-1"><span class="tsd-kind-call-signature">ownsEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ownsevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether <code>event</code> belongs to this grid, rather than to a grid nested inside
|
|
537
|
+
it (the grid in a master-detail panel renders inside one of this grid's
|
|
538
|
+
rows, so its events cross this grid's body on their way out). The first
|
|
539
|
+
grid, or grid body, on the composed path from the event origin outward is
|
|
540
|
+
the one that owns it.</p>
|
|
541
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">Event</span></span><div class="tsd-comment tsd-typography"><p>an event that reached this grid.</p>
|
|
542
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pincolumn"><span>pin<wbr/>Column</span><a href="#pincolumn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="pincolumn-1"><span class="tsd-kind-call-signature">pinColumn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">position</span><span class="tsd-signature-symbol">:</span> <a href="../types/PinPosition.html" class="tsd-signature-type tsd-kind-type-alias">PinPosition</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#pincolumn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Pins a column to one of the grid's edges, or unpins it when <code>position</code> is <code>null</code>.</p>
|
|
543
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span><div class="tsd-comment tsd-typography"><p>The target column key.</p>
|
|
544
|
+
</div></li><li><span><span class="tsd-kind-parameter">position</span>: <a href="../types/PinPosition.html" class="tsd-signature-type tsd-kind-type-alias">PinPosition</a></span><div class="tsd-comment tsd-typography"><p><code>'start'</code>, <code>'end'</code>, or <code>null</code> to unpin.</p>
|
|
545
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p><code>true</code> if the change was applied, <code>false</code> if cancelled or a no-op.</p>
|
|
546
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-39">Remarks<a href="#remarks-39" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Emits the cancellable <code>columnPinning</code> event first and the <code>columnPinned</code>
|
|
547
|
+
event after the update is applied. The user-supplied <a href="#columns" class="tsd-kind-property">ApexGrid.columns</a>
|
|
548
|
+
array is not reordered — only the visual render order changes.</p>
|
|
549
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-14">Example<a href="#example-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">pinColumn</span><span class="hl-1">(</span><span class="hl-3">'name'</span><span class="hl-1">, </span><span class="hl-3">'start'</span><span class="hl-1">);</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">pinColumn</span><span class="hl-1">(</span><span class="hl-3">'actions'</span><span class="hl-1">, </span><span class="hl-3">'end'</span><span class="hl-1">);</span>
|
|
550
|
+
</code><button type="button">Copy</button></pre>
|
|
551
|
+
|
|
552
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pinrow"><span>pin<wbr/>Row</span><a href="#pinrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="pinrow-1"><span class="tsd-kind-call-signature">pinRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">position</span><span class="tsd-signature-symbol">?:</span> <a href="../types/RowPinPosition.html" class="tsd-signature-type tsd-kind-type-alias">RowPinPosition</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#pinrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Pins <code>row</code> to a sticky top or bottom band, lifting it out of the scrolling
|
|
553
|
+
body. Moves it between bands when already pinned elsewhere.</p>
|
|
554
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li><li><span><span class="tsd-kind-parameter">position</span>: <a href="../types/RowPinPosition.html" class="tsd-signature-type tsd-kind-type-alias">RowPinPosition</a><span class="tsd-signature-symbol"> = 'top'</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> when applied, <code>false</code> when disabled or cancelled.</p>
|
|
555
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-40">Remarks<a href="#remarks-40" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Requires <code>rowPinning.enabled</code>. Goes through the cancellable <code>rowPinning</code>
|
|
556
|
+
event and emits <code>rowPinned</code> on success. Identity is by reference, so pass
|
|
557
|
+
the same object held in <a href="#data" class="tsd-kind-accessor">ApexGrid.data</a>.</p>
|
|
558
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="previouspage"><span>previous<wbr/>Page</span><a href="#previouspage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="previouspage-1"><span class="tsd-kind-call-signature">previousPage</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#previouspage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Navigates to the previous page. No-op if already on the first page.</p>
|
|
559
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="redo"><span>redo</span><a href="#redo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="redo-1"><span class="tsd-kind-call-signature">redo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#redo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Re-applies the most recently undone edit. No-op when there is nothing to
|
|
560
|
+
redo or history is disabled.</p>
|
|
561
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="selectallrows"><span>select<wbr/>All<wbr/>Rows</span><a href="#selectallrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="selectallrows-1"><span class="tsd-kind-call-signature">selectAllRows</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#selectallrows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Selects every row in the current view (<a href="#dataview" class="tsd-kind-accessor">dataView</a>). No-op in
|
|
562
|
+
<code>'single'</code> selection mode.</p>
|
|
563
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="selectrow"><span>select<wbr/>Row</span><a href="#selectrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="selectrow-1"><span class="tsd-kind-call-signature">selectRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#selectrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Selects <code>row</code>, replacing the existing selection in <code>'single'</code> mode or
|
|
564
|
+
adding to it in <code>'multiple'</code> mode.</p>
|
|
565
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p><code>true</code> if the selection changed, <code>false</code> if the change was
|
|
566
|
+
rejected by a <code>rowSelecting</code> listener or selection is disabled.</p>
|
|
567
|
+
</div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setpagesize"><span>set<wbr/>Page<wbr/>Size</span><a href="#setpagesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setpagesize-1"><span class="tsd-kind-call-signature">setPageSize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#setpagesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the grid's page size and returns to the first page.</p>
|
|
568
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The new page size (must be a positive integer).</p>
|
|
569
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p><code>true</code> if the change was applied, <code>false</code> if cancelled or a no-op.</p>
|
|
570
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-41">Remarks<a href="#remarks-41" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Emits the cancellable <code>pageChanging</code> event before applying the change and the
|
|
571
|
+
<code>pageChanged</code> event after.</p>
|
|
572
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setquickfilter"><span>set<wbr/>Quick<wbr/>Filter</span><a href="#setquickfilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setquickfilter-1"><span class="tsd-kind-call-signature">setQuickFilter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#setquickfilter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies a new quick-filter (global search) value, emitting the cancellable
|
|
573
|
+
<code>quickFilterChanging</code> event first and the <code>quickFilterChanged</code> event after the
|
|
574
|
+
pipeline has run. Moving back to the first page fires <code>pageChanged</code> too.</p>
|
|
575
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The new quick-filter value. Pass <code>''</code> to clear.</p>
|
|
576
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p><code>true</code> if the change was applied, <code>false</code> if cancelled or a no-op.</p>
|
|
577
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-15">Example<a href="#example-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">grid</span><span class="hl-1">.</span><span class="hl-4">setQuickFilter</span><span class="hl-1">(</span><span class="hl-3">'john'</span><span class="hl-1">);</span>
|
|
578
|
+
</code><button type="button">Copy</button></pre>
|
|
579
|
+
|
|
580
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setstate"><span>set<wbr/>State</span><a href="#setstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setstate-1"><span class="tsd-kind-call-signature">setState</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GridState.html" class="tsd-signature-type tsd-kind-interface">GridState</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/SetStateOptions.html" class="tsd-signature-type tsd-kind-interface">SetStateOptions</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/SetStateResult.html" class="tsd-signature-type tsd-kind-interface">SetStateResult</a><a href="#setstate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies a (partial) state snapshot produced by <a href="#getstate" class="tsd-kind-method">ApexGrid.getState</a>.</p>
|
|
581
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">state</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/GridState.html" class="tsd-signature-type tsd-kind-interface">GridState</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/SetStateOptions.html" class="tsd-signature-type tsd-kind-interface">SetStateOptions</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/SetStateResult.html" class="tsd-signature-type tsd-kind-interface">SetStateResult</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-42">Remarks<a href="#remarks-42" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Only the slices present on <code>state</code> are applied — omit a slice to leave it
|
|
582
|
+
untouched (e.g. pass <code>{ sort }</code> to change only sorting). A present-but-empty
|
|
583
|
+
<code>sort</code>/<code>filter</code> array clears that operation. Slices are applied in dependency
|
|
584
|
+
order (columns → sort → filter → quick-filter → module structure → row order
|
|
585
|
+
→ tree → expansion → row pinning → selection → pagination) so row-referencing
|
|
586
|
+
state resolves against the transformed view. <code>rowOrder</code> is mutually exclusive
|
|
587
|
+
with an active <code>sort</code>: a snapshot carrying both keeps the sort and drops
|
|
588
|
+
<code>rowOrder</code>.</p>
|
|
589
|
+
<p><strong>Defensive by design.</strong> <code>setState</code> is written into by persisted blobs and
|
|
590
|
+
LLM output, so it never throws on malformed input (unless
|
|
591
|
+
<a href="../interfaces/SetStateOptions.html#strict" class="tsd-kind-property">SetStateOptions.strict</a>): unknown columns / operands, out-of-range
|
|
592
|
+
pages, unresolvable rows, and wrong-typed slices are dropped, clamped, or
|
|
593
|
+
skipped, each recorded in the returned <a href="../interfaces/SetStateResult.html" class="tsd-kind-interface">SetStateResult</a>.</p>
|
|
594
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sort"><span>sort</span><a href="#sort" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sort-1"><span class="tsd-kind-call-signature">sort</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">expressions</span><span class="tsd-signature-symbol">:</span> <a href="../types/SortExpression.html" class="tsd-signature-type tsd-kind-type-alias">SortExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <a href="../types/SortExpression.html" class="tsd-signature-type tsd-kind-type-alias">SortExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#sort-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Performs a sort operation in the grid based on the passed expression(s).</p>
|
|
595
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">expressions</span>: <a href="../types/SortExpression.html" class="tsd-signature-type tsd-kind-type-alias">SortExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <a href="../types/SortExpression.html" class="tsd-signature-type tsd-kind-type-alias">SortExpression</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="togglerowexpansion"><span>toggle<wbr/>Row<wbr/>Expansion</span><a href="#togglerowexpansion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="togglerowexpansion-1"><span class="tsd-kind-call-signature">toggleRowExpansion</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#togglerowexpansion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Toggles expansion of <code>row</code>.</p>
|
|
596
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="togglerowselection"><span>toggle<wbr/>Row<wbr/>Selection</span><a href="#togglerowselection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="togglerowselection-1"><span class="tsd-kind-call-signature">toggleRowSelection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#togglerowselection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Toggles selection of <code>row</code>.</p>
|
|
597
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toggletreerow"><span>toggle<wbr/>Tree<wbr/>Row</span><a href="#toggletreerow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toggletreerow-1"><span class="tsd-kind-call-signature">toggleTreeRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#toggletreerow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Toggles tree-expansion of <code>row</code>. No-op when tree mode is disabled or
|
|
598
|
+
the row has no children.</p>
|
|
599
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="undo"><span>undo</span><a href="#undo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="undo-1"><span class="tsd-kind-call-signature">undo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#undo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reverts the most recent cell-data edit (single, row-mode, or bulk paste /
|
|
600
|
+
fill commits each as one step). No-op when there is nothing to undo or
|
|
601
|
+
history is disabled.</p>
|
|
602
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="unpincolumn"><span>unpin<wbr/>Column</span><a href="#unpincolumn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="unpincolumn-1"><span class="tsd-kind-call-signature">unpinColumn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#unpincolumn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unpins a column. Equivalent to <a href="#pincolumn" class="tsd-kind-method">ApexGrid.pinColumn</a>(<code>key</code>, <code>null</code>).</p>
|
|
603
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span><div class="tsd-comment tsd-typography"><p>The target column key.</p>
|
|
604
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p><code>true</code> if the change was applied, <code>false</code> if the column was already
|
|
605
|
+
unpinned or the operation was cancelled.</p>
|
|
606
|
+
</div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="unpinrow"><span>unpin<wbr/>Row</span><a href="#unpinrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="unpinrow-1"><span class="tsd-kind-call-signature">unpinRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#unpinrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unpins <code>row</code> from whichever band holds it, returning it to the scrolling
|
|
607
|
+
body.</p>
|
|
608
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> when applied (or already unpinned), <code>false</code> when cancelled.</p>
|
|
609
|
+
</div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatecolumns"><span>update<wbr/>Columns</span><a href="#updatecolumns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updatecolumns-1"><span class="tsd-kind-call-signature">updateColumns</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">columns</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <a href="../types/ColumnConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <a href="../types/ColumnConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updatecolumns-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the column configuration of the grid.</p>
|
|
610
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">columns</span>: <a href="../types/ColumnConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <a href="../types/ColumnConfiguration.html" class="tsd-signature-type tsd-kind-type-alias">ColumnConfiguration</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-keyword">keyof</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-43">Remarks<a href="#remarks-43" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Each updated column is replaced with a fresh object reference so that cells
|
|
611
|
+
and headers re-render with the new template / configuration. The
|
|
612
|
+
user-supplied <code>columns</code> array is also reassigned for Lit reactivity.</p>
|
|
613
|
+
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="register"><code class="tsd-tag">Static</code><span>register</span><a href="#register" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="register-1"><span class="tsd-kind-call-signature">register</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#register-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers <code><apex-grid></code> and its internal dependencies with the custom-element
|
|
614
|
+
registry. Idempotent — safe to call more than once.</p>
|
|
615
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-44">Remarks<a href="#remarks-44" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Registering the element is only step one of four required for a visible, styled
|
|
616
|
+
grid. You must also configure an Ignite UI theme + CSS, give the host a bounded
|
|
617
|
+
height, and avoid overriding <code>display</code> on the host. See the README
|
|
618
|
+
"Getting Started" section for the full setup.</p>
|
|
619
|
+
</div></div></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-lifecycle"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>lifecycle</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="connectedcallback"><span>connected<wbr/>Callback</span><a href="#connectedcallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="connectedcallback-1"><span class="tsd-kind-call-signature">connectedCallback</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#connectedcallback-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invoked when the component is added to the document's DOM.</p>
|
|
620
|
+
<p>In <code>connectedCallback()</code> you should setup tasks that should only occur when
|
|
621
|
+
the element is connected to the document. The most common of these is
|
|
622
|
+
adding event listeners to nodes external to the element, like a keydown
|
|
623
|
+
event handler added to the window.</p>
|
|
624
|
+
<pre><code class="ts"><span class="hl-4">connectedCallback</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-5">super</span><span class="hl-1">.</span><span class="hl-4">connectedCallback</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-4">addEventListener</span><span class="hl-1">(</span><span class="hl-3">'keydown'</span><span class="hl-1">, </span><span class="hl-5">this</span><span class="hl-1">.</span><span class="hl-2">_handleKeydown</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
625
|
+
</code><button type="button">Copy</button></pre>
|
|
626
|
+
|
|
627
|
+
<p>Typically, anything done in <code>connectedCallback()</code> should be undone when the
|
|
628
|
+
element is disconnected, in <code>disconnectedCallback()</code>.</p>
|
|
629
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Overrides EventEmitterBase.connectedCallback</p></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-styles"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>styles</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="styles"><code class="tsd-tag">Static</code><span>styles</span><a href="#styles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">styles</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CSSResult</span><span class="tsd-signature-symbol"> = gridStyles</span></div><div class="tsd-comment tsd-typography"><p>Array of styles to apply to the element. The styles should be defined
|
|
630
|
+
using the css tag function, via constructible stylesheets, or
|
|
631
|
+
imported from native CSS module scripts.</p>
|
|
632
|
+
<p>Note on Content Security Policy:</p>
|
|
633
|
+
<p>Element styles are implemented with <code><style></code> tags when the browser doesn't
|
|
634
|
+
support adopted StyleSheets. To use such <code><style></code> tags with the style-src
|
|
635
|
+
CSP directive, the style-src value must either include 'unsafe-inline' or
|
|
636
|
+
<code>nonce-<base64-value></code> with <code><base64-value></code> replaced be a server-generated
|
|
637
|
+
nonce.</p>
|
|
638
|
+
<p>To provide a nonce to use on generated <code><style></code> elements, set
|
|
639
|
+
<code>window.litNonce</code> to a server-generated nonce in your page's HTML, before
|
|
640
|
+
loading application code:</p>
|
|
641
|
+
<pre><code class="html"><span class="hl-9"><</span><span class="hl-10">script</span><span class="hl-9">></span><br/><span class="hl-11"> </span><span class="hl-15">// Generated and unique per request:</span><br/><span class="hl-11"> </span><span class="hl-2">window</span><span class="hl-11">.</span><span class="hl-2">litNonce</span><span class="hl-11"> </span><span class="hl-1">=</span><span class="hl-11"> </span><span class="hl-3">'a1b2c3d4'</span><span class="hl-11">;</span><br/><span class="hl-9"></</span><span class="hl-10">script</span><span class="hl-9">></span>
|
|
642
|
+
</code><button type="button">Copy</button></pre>
|
|
643
|
+
|
|
644
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-nocollapse"><h4 class="tsd-anchor-link" id="nocollapse">Nocollapse<a href="#nocollapse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><aside class="tsd-sources"><p>Overrides EventEmitterBase.styles</p></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-updates"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>updates</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="requestupdate"><span>request<wbr/>Update</span><a href="#requestupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="requestupdate-1"><span class="tsd-kind-call-signature">requestUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PropertyKey</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">oldValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PropertyDeclaration</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">useNewValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">newValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#requestupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests an update which is processed asynchronously. This should be called
|
|
645
|
+
when an element should update based on some state not triggered by setting
|
|
646
|
+
a reactive property. In this case, pass no arguments. It should also be
|
|
647
|
+
called when manually implementing a property setter. In this case, pass the
|
|
648
|
+
property <code>name</code> and <code>oldValue</code> to ensure that any configured property
|
|
649
|
+
options are honored.</p>
|
|
650
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">PropertyKey</span></span><div class="tsd-comment tsd-typography"><p>name of requesting property</p>
|
|
651
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">oldValue</span>: <span class="tsd-signature-type">unknown</span></span><div class="tsd-comment tsd-typography"><p>old value of requesting property</p>
|
|
652
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">PropertyDeclaration</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>property options to use instead of the previously
|
|
653
|
+
configured options</p>
|
|
654
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">useNewValue</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>if true, the newValue argument is used instead of
|
|
655
|
+
reading the property value. This is important to use if the reactive
|
|
656
|
+
property is a standard private accessor, as opposed to a plain
|
|
657
|
+
property, since private members can't be dynamically read by name.</p>
|
|
658
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">newValue</span>: <span class="tsd-signature-type">unknown</span></span><div class="tsd-comment tsd-typography"><p>the new value of the property. This is only used if
|
|
659
|
+
<code>useNewValue</code> is true.</p>
|
|
660
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Overrides EventEmitterBase.requestUpdate</p></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Other"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Other</summary><div><a href="#autogenerate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Generate</span></a><a href="#columngroups"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>column<wbr/>Groups</span></a><a href="#columnmenu"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>column<wbr/>Menu</span></a><a href="#columnreordering"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>column<wbr/>Reordering</span></a><a href="#columns"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>columns</span></a><a href="#columnseparator"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>column<wbr/>Separator</span></a><a href="#coordinatehints"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coordinate<wbr/>Hints</span></a><a href="#datapipelineconfiguration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Pipeline<wbr/>Configuration</span></a><a href="#editing"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>editing</span></a><a href="#expansion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>expansion</span></a><a href="#localetext"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>locale<wbr/>Text</span></a><a href="#pagination"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pagination</span></a><a href="#rowid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>row<wbr/>Id</span></a><a href="#rowpinning"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>row<wbr/>Pinning</span></a><a href="#rowreordering"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>row<wbr/>Reordering</span></a><a href="#selection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selection</span></a><a href="#showexport"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>show<wbr/>Export</span></a><a href="#showquickfilter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>show<wbr/>Quick<wbr/>Filter</span></a><a href="#sortconfiguration"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort<wbr/>Configuration</span></a><a href="#tree"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tree</span></a><a href="#canredo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>can<wbr/>Redo</span></a><a href="#canundo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>can<wbr/>Undo</span></a><a href="#columngroupdepth"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>column<wbr/>Group<wbr/>Depth</span></a><a href="#data"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data</span></a><a href="#dataview"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>data<wbr/>View</span></a><a href="#displaycolumns"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>display<wbr/>Columns</span></a><a href="#editingcell"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>editing<wbr/>Cell</span></a><a href="#editingrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>editing<wbr/>Row</span></a><a href="#expandedrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>expanded<wbr/>Rows</span></a><a href="#exportformats"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>export<wbr/>Formats</span></a><a href="#filterexpressions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>filter<wbr/>Expressions</span></a><a href="#hascolumngroups"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Column<wbr/>Groups</span></a><a href="#page"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>page</span></a><a href="#pagecount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>page<wbr/>Count</span></a><a href="#pageitems"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>page<wbr/>Items</span></a><a href="#pagesize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>page<wbr/>Size</span></a><a href="#pinnedrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pinned<wbr/>Rows</span></a><a href="#quickfilter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>quick<wbr/>Filter</span></a><a href="#rows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>rows</span></a><a href="#selectedrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>selected<wbr/>Rows</span></a><a href="#sortexpressions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sort<wbr/>Expressions</span></a><a href="#toolbaractions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>toolbar<wbr/>Actions</span></a><a href="#totalitems"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>total<wbr/>Items</span></a><a href="#announce"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>announce</span></a><a href="#applyedits"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Edits</span></a><a href="#canceledit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Edit</span></a><a href="#clearfilter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Filter</span></a><a href="#clearhistory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>History</span></a><a href="#clearselection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Selection</span></a><a href="#clearsort"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Sort</span></a><a href="#collapseallrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collapse<wbr/>All<wbr/>Rows</span></a><a href="#collapsealltreerows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collapse<wbr/>All<wbr/>Tree<wbr/>Rows</span></a><a href="#collapserow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collapse<wbr/>Row</span></a><a href="#collapsetreerow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collapse<wbr/>Tree<wbr/>Row</span></a><a href="#commitedit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>commit<wbr/>Edit</span></a><a href="#deselectrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deselect<wbr/>Row</span></a><a href="#editcell"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Cell</span></a><a href="#editrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Row</span></a><a href="#expandallrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>expand<wbr/>All<wbr/>Rows</span></a><a href="#expandalltreerows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>expand<wbr/>All<wbr/>Tree<wbr/>Rows</span></a><a href="#expandrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>expand<wbr/>Row</span></a><a href="#expandtreerow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>expand<wbr/>Tree<wbr/>Row</span></a><a href="#exportas"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>As</span></a><a href="#exporttocsv"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>To<wbr/>CSV</span></a><a href="#filter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>filter</span></a><a href="#firstpage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>first<wbr/>Page</span></a><a href="#getcolumn"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Column</span></a><a href="#getschema"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Schema</span></a><a href="#getstate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>State</span></a><a href="#gotopage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>goto<wbr/>Page</span></a><a href="#isrowexpanded"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Row<wbr/>Expanded</span></a><a href="#isrowselected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Row<wbr/>Selected</span></a><a href="#istreerowexpanded"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Tree<wbr/>Row<wbr/>Expanded</span></a><a href="#lastpage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>last<wbr/>Page</span></a><a href="#localize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>localize</span></a><a href="#movecolumn"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Column</span></a><a href="#moverow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Row</span></a><a href="#nextpage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>next<wbr/>Page</span></a><a href="#ownsevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>owns<wbr/>Event</span></a><a href="#pincolumn"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pin<wbr/>Column</span></a><a href="#pinrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pin<wbr/>Row</span></a><a href="#previouspage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>previous<wbr/>Page</span></a><a href="#redo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>redo</span></a><a href="#selectallrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>All<wbr/>Rows</span></a><a href="#selectrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Row</span></a><a href="#setpagesize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Page<wbr/>Size</span></a><a href="#setquickfilter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Quick<wbr/>Filter</span></a><a href="#setstate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>State</span></a><a href="#sort"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sort</span></a><a href="#togglerowexpansion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Row<wbr/>Expansion</span></a><a href="#togglerowselection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Row<wbr/>Selection</span></a><a href="#toggletreerow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Tree<wbr/>Row</span></a><a href="#undo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>undo</span></a><a href="#unpincolumn"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unpin<wbr/>Column</span></a><a href="#unpinrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unpin<wbr/>Row</span></a><a href="#updatecolumns"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Columns</span></a><a href="#register"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-lifecycle"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>lifecycle</summary><div><a href="#connectedcallback"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connected<wbr/>Callback</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-styles"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>styles</summary><div><a href="#styles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>styles</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-updates"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>updates</summary><div><a href="#requestupdate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Update</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">apex-grid</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|