apex-grid 3.5.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 +338 -0
- package/LICENSE.md +125 -0
- package/README.md +64 -10
- 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 +146 -36
- package/components/grid.js +442 -103
- 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 +11 -9
- package/components/header-row.js.map +1 -1
- package/components/header.js +32 -20
- package/components/header.js.map +1 -1
- package/components/row.d.ts +19 -3
- package/components/row.js +69 -23
- 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 +40 -0
- package/components/virtualizer.js +116 -5
- 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 +67 -13
- package/controllers/navigation.js +191 -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 +38 -22
- 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 +56 -7
- package/controllers/state.js +76 -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 +3156 -277
- 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 +155 -81
- package/docs/classes/ApexGridPaginator.html +1 -1
- package/docs/classes/ApexGridToolbar.html +3 -3
- package/docs/functions/localize.html +2 -2
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +74 -11
- package/docs/interfaces/ApexCellValidationFailedEvent.html +3 -2
- package/docs/interfaces/ApexCellValueChangedEvent.html +4 -2
- package/docs/interfaces/ApexCellValueChangingEvent.html +3 -2
- package/docs/interfaces/ApexGridEventMap.html +5 -2
- 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/BaseFilterExpression.html +2 -2
- package/docs/interfaces/CSVExportOptions.html +12 -4
- package/docs/interfaces/DataPipelineConfiguration.html +1 -1
- package/docs/interfaces/ExportOptions.html +5 -3
- package/docs/interfaces/GridExpansionConfiguration.html +6 -2
- package/docs/interfaces/GridRowReorderingConfiguration.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 +3 -2
- package/docs/modules.html +1 -1
- package/docs/types/ExportSource.html +6 -4
- package/docs/types/OperandKeys.html +9 -0
- package/docs/variables/EN_LOCALE.html +2 -2
- package/i18n/en.d.ts +5 -0
- package/i18n/en.js +5 -0
- package/i18n/en.js.map +1 -1
- package/i18n/es.js +5 -0
- package/i18n/es.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 +60 -3
- package/internal/feature-module.js +6 -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 +34 -6
- package/internal/utils.js +30 -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 -3
- package/setup.d.ts +11 -0
- package/setup.js +9 -19
- package/setup.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 -214
|
@@ -45,7 +45,7 @@ and "Theming" sections for the full example and token list.</p>
|
|
|
45
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
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
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> for the elevated card look, or <code>none</code> to remove it.</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
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
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
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>
|
|
@@ -56,11 +56,22 @@ and "Theming" sections for the full example and token list.</p>
|
|
|
56
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
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
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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>
|
|
64
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>
|
|
65
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>
|
|
66
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>
|
|
@@ -69,20 +80,18 @@ and "Theming" sections for the full example and token list.</p>
|
|
|
69
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>
|
|
70
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>
|
|
71
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>
|
|
72
|
-
</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="
|
|
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>
|
|
73
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>
|
|
74
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>
|
|
75
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>
|
|
76
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>
|
|
77
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>
|
|
78
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>
|
|
79
|
-
<a href="#data" 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</span></a>
|
|
80
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>
|
|
81
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>
|
|
82
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>
|
|
83
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>
|
|
84
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>
|
|
85
|
-
<a href="#quickfilter" 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>quick<wbr/>Filter</span></a>
|
|
86
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>
|
|
87
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>
|
|
88
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>
|
|
@@ -94,6 +103,7 @@ and "Theming" sections for the full example and token list.</p>
|
|
|
94
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>
|
|
95
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>
|
|
96
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>
|
|
97
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>
|
|
98
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>
|
|
99
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>
|
|
@@ -107,6 +117,7 @@ and "Theming" sections for the full example and token list.</p>
|
|
|
107
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>
|
|
108
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>
|
|
109
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>
|
|
110
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>
|
|
111
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>
|
|
112
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>
|
|
@@ -147,6 +158,7 @@ and "Theming" sections for the full example and token list.</p>
|
|
|
147
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>
|
|
148
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>
|
|
149
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>
|
|
150
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>
|
|
151
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>
|
|
152
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,7 +177,9 @@ and "Theming" sections for the full example and token list.</p>
|
|
|
165
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>
|
|
166
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>
|
|
167
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>
|
|
168
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>
|
|
169
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
|
|
170
184
|
data source.</p>
|
|
171
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
|
|
@@ -217,7 +231,6 @@ gutter (1, 2, 3, ...) and A / B / C column letters are revealed so cell
|
|
|
217
231
|
references are discoverable. Enterprise toggles this while a formula cell is
|
|
218
232
|
being edited; it can also be set directly for a persistent spreadsheet look.
|
|
219
233
|
Reflected so styling / tests can observe it on the host.</p>
|
|
220
|
-
</div></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><div class="tsd-signature"><span class="tsd-kind-property">data</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-comment tsd-typography"><p>The data source for the grid.</p>
|
|
221
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>
|
|
222
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>
|
|
223
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>
|
|
@@ -234,7 +247,7 @@ expansion entirely through the public API or a custom cell template.</p>
|
|
|
234
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>
|
|
235
248
|
</code><button type="button">Copy</button></pre>
|
|
236
249
|
|
|
237
|
-
</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">"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.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.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">"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
|
|
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
|
|
238
251
|
operators and controls, row/selection labels, the toolbar, and so on).</p>
|
|
239
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
|
|
240
253
|
omit falls back to the built-in English default, so partial maps are valid.
|
|
@@ -252,51 +265,46 @@ emits the cancellable <code>pageChanging</code> event before applying a change a
|
|
|
252
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>
|
|
253
266
|
</code><button type="button">Copy</button></pre>
|
|
254
267
|
|
|
255
|
-
</div></div></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><div class="tsd-signature"><span class="tsd-kind-property">quickFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ''</span></div><div class="tsd-comment tsd-typography"><p>The quick-filter (global search) value applied to the dataView.</p>
|
|
256
|
-
</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 non-empty, the grid filters records whose visible-column values contain
|
|
257
|
-
the term (case-insensitive substring match). Customise by providing
|
|
258
|
-
<a href="../interfaces/DataPipelineConfiguration.html#quickfilter" class="tsd-kind-property">DataPipelineConfiguration.quickFilter</a>.</p>
|
|
259
|
-
</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>quick-filter</p>
|
|
260
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>
|
|
261
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
262
|
-
tree rows by the returned id, so they survive a wholesale <a href="#data" class="tsd-kind-
|
|
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>
|
|
263
271
|
reload. Without it those rows are captured by positional index into
|
|
264
|
-
<a href="#data" class="tsd-kind-
|
|
272
|
+
<a href="#data" class="tsd-kind-accessor">ApexGrid.data</a>, which round-trips within a session but not across a
|
|
265
273
|
data swap. The id must be unique per row and stable across reloads.</p>
|
|
266
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>
|
|
267
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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
|
|
268
276
|
top / bottom band via <a href="#pinrow" class="tsd-kind-method">ApexGrid.pinRow</a>.</p>
|
|
269
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>
|
|
270
278
|
</code><button type="button">Copy</button></pre>
|
|
271
279
|
|
|
272
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>
|
|
273
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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
|
|
274
282
|
and <a href="#moverow" class="tsd-kind-method">ApexGrid.moveRow</a>. A manual order is mutually exclusive with
|
|
275
283
|
column sorting (applying a sort clears it). Set <code>applyToData: true</code> to also
|
|
276
|
-
splice <a href="#data" class="tsd-kind-
|
|
284
|
+
splice <a href="#data" class="tsd-kind-accessor">ApexGrid.data</a> in place.</p>
|
|
277
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>
|
|
278
286
|
</code><button type="button">Copy</button></pre>
|
|
279
287
|
|
|
280
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>
|
|
281
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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)
|
|
282
290
|
<code>mode</code> (<code>'single' | 'multiple'</code>) and <code>showCheckboxColumn</code> to opt in.</p>
|
|
283
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>
|
|
284
292
|
</code><button type="button">Copy</button></pre>
|
|
285
293
|
|
|
286
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>
|
|
287
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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;
|
|
288
296
|
clicking it opens a menu with one entry per <a href="#exportformats" class="tsd-kind-accessor">ApexGrid.exportFormats</a>
|
|
289
297
|
(CSV in the community grid) that calls <a href="#exportas" class="tsd-kind-method">ApexGrid.exportAs</a>.
|
|
290
298
|
<a href="#exporttocsv" class="tsd-kind-method">ApexGrid.exportToCSV</a> remains callable programmatically regardless
|
|
291
299
|
of this flag.</p>
|
|
292
|
-
</div><div class="tsd-tag-attr"><h4 class="tsd-anchor-link" id="attr-
|
|
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>
|
|
293
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>
|
|
294
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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
|
|
295
303
|
regardless of this flag; this only controls the toolbar input UI.</p>
|
|
296
|
-
</div><div class="tsd-tag-attr"><h4 class="tsd-anchor-link" id="attr-
|
|
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>
|
|
297
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>
|
|
298
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>
|
|
299
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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
|
|
300
308
|
hierarchy from a user-supplied <code>getDataPath(row)</code> callback (the
|
|
301
309
|
flat-array "tree data" pattern). When enabled, the first visible data column (or
|
|
302
310
|
the column referenced by <code>groupColumnKey</code>) renders a chevron toggle
|
|
@@ -306,65 +314,90 @@ and depth-based indentation.</p>
|
|
|
306
314
|
|
|
307
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>
|
|
308
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>
|
|
309
|
-
</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-
|
|
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>
|
|
310
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>
|
|
311
|
-
</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="
|
|
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
|
|
312
325
|
have been applied.</p>
|
|
313
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
|
|
314
327
|
unpinned columns, then <code>'end'</code>-pinned columns.</p>
|
|
315
|
-
</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-
|
|
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
|
|
316
329
|
actually displays them (for example to build a column chooser). Public APIs
|
|
317
330
|
like <a href="#getcolumn" class="tsd-kind-method">ApexGrid.getColumn</a> continue to operate on the user-supplied
|
|
318
331
|
<a href="#columns" class="tsd-kind-property">ApexGrid.columns</a> array.</p>
|
|
319
|
-
</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
|
|
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>
|
|
320
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
|
|
321
|
-
only), or <code>null</code
|
|
336
|
+
only), or <code>null</code>. It is -1 when the edited record is pinned or on another
|
|
337
|
+
page.</p>
|
|
322
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>
|
|
323
|
-
</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-
|
|
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
|
|
324
340
|
not change the grid's expansion state. Set this property to replace the
|
|
325
341
|
expansion set programmatically (goes through the cancellable
|
|
326
342
|
<code>rowExpanding</code> event).</p>
|
|
327
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>
|
|
328
|
-
</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-
|
|
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
|
|
329
345
|
contribute more formats: <code>@apexcharts/grid-enterprise</code> overrides it to add
|
|
330
346
|
<code>'xlsx'</code>. The toolbar renders one menu item per entry and dispatches the
|
|
331
347
|
chosen id to <a href="#exportas" class="tsd-kind-method">ApexGrid.exportAs</a>.</p>
|
|
332
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>
|
|
333
|
-
</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><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-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>
|
|
334
|
-
</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></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
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
|
|
335
353
|
a visible member column.</p>
|
|
336
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>
|
|
337
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4
|
|
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>
|
|
338
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>
|
|
339
|
-
</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-
|
|
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
|
|
340
363
|
enabled (<code>'local'</code> mode) this is the active page slice.</p>
|
|
341
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>
|
|
342
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>
|
|
343
|
-
</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="
|
|
344
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">
|
|
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
|
|
345
376
|
chunk of elements in the DOM.</p>
|
|
346
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>
|
|
347
|
-
</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-
|
|
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
|
|
348
379
|
not change the grid's selection. Set this property to replace the
|
|
349
380
|
selection programmatically (goes through the cancellable
|
|
350
381
|
<code>rowSelecting</code> event).</p>
|
|
351
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>
|
|
352
|
-
</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-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>
|
|
353
|
-
</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></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
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
|
|
354
387
|
order.</p>
|
|
355
|
-
</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-
|
|
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
|
|
356
389
|
add toolbar buttons (mirroring <a href="#exportformats" class="tsd-kind-accessor">ApexGrid.exportFormats</a>):
|
|
357
390
|
<code>@apexcharts/grid-enterprise</code> overrides it to add a "Create chart" action.
|
|
358
391
|
The toolbar renders one button per entry and calls its <code>run()</code> on click.</p>
|
|
359
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>
|
|
360
|
-
</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-
|
|
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.
|
|
361
394
|
Use <a href="#pageitems" class="tsd-kind-accessor">ApexGrid.pageItems</a> to read the rows currently rendered into the body.</p>
|
|
362
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
|
|
363
396
|
read polite live updates will read the new value aloud.</p>
|
|
364
|
-
</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-
|
|
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
|
|
365
398
|
the change is announced. Built-in operations (sort / filter / page /
|
|
366
399
|
select / expand) call this internally already.</p>
|
|
367
|
-
</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> <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">rowIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"
|
|
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>
|
|
368
401
|
<p>Every write goes through the same choke point interactive editing uses, so
|
|
369
402
|
each one emits the cancellable <code>cellValueChanging</code> and then
|
|
370
403
|
<code>cellValueChanged</code>, and runs the column's validators. What differs from
|
|
@@ -372,20 +405,28 @@ calling <a href="#editcell" class="tsd-kind-method">editCell</a> + <a href="#com
|
|
|
372
405
|
set lands as one undo step and triggers one pipeline run, which is the
|
|
373
406
|
point: a thousand <code>editCell</code> round-trips would be a thousand entries in the
|
|
374
407
|
undo stack and a thousand re-renders.</p>
|
|
375
|
-
<p
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
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
|
|
381
422
|
cell win.</p>
|
|
382
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
|
|
383
424
|
changed; <code>unchanged</code>, <code>invalid</code> and <code>cancelled</code> explain the rest, so a caller
|
|
384
425
|
can tell a rejected batch from a no-op one.</p>
|
|
385
|
-
<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">Example: Bulk-clear a column for the rows the user selected<a href="#example-bulk-clear-a-column-for-the-rows-the-user-selected" aria-label="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><
|
|
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>
|
|
386
427
|
</code><button type="button">Copy</button></pre>
|
|
387
428
|
|
|
388
|
-
</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-
|
|
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>
|
|
389
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>
|
|
390
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>
|
|
391
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>
|
|
@@ -395,13 +436,13 @@ can tell a rejected batch from a no-op one.</p>
|
|
|
395
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>
|
|
396
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>
|
|
397
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>
|
|
398
|
-
</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-
|
|
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
|
|
399
440
|
flushes all pending values for the active row. Emits <code>cellValueChanging</code>
|
|
400
441
|
per changed cell (cancellable) and <code>cellValueChanged</code> after, followed by
|
|
401
442
|
<code>rowEditEnded</code> in row mode.</p>
|
|
402
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>
|
|
403
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>
|
|
404
|
-
</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-
|
|
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>).
|
|
405
446
|
Returns <code>false</code> when the column isn't editable, the row index is out of
|
|
406
447
|
range, or the request was rejected (for example in row mode with pending
|
|
407
448
|
changes that couldn't be committed).</p>
|
|
@@ -421,7 +462,7 @@ derived grids override to handle additional formats, delegating to <code>super</
|
|
|
421
462
|
for the ones they don't add.</p>
|
|
422
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
|
|
423
464
|
context) triggers a download.</p>
|
|
424
|
-
</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-
|
|
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
|
|
425
466
|
every visible column with <code>exportable !== false</code>, and prepends a UTF-8 BOM
|
|
426
467
|
so Excel opens the file with the right encoding. Pass <code>source: 'page'</code> to
|
|
427
468
|
export only the current page, <code>source: 'selected'</code> to export the current
|
|
@@ -437,7 +478,7 @@ tests or routing the bytes elsewhere.</p>
|
|
|
437
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
|
|
438
479
|
operations available per column (sort directions, filter operands), the
|
|
439
480
|
grid-level capabilities, and the current <a href="#getstate" class="tsd-kind-method">ApexGrid.getState</a> snapshot.</p>
|
|
440
|
-
</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-
|
|
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)
|
|
441
482
|
and validates a returned patch against before <a href="#setstate" class="tsd-kind-method">ApexGrid.setState</a>, but
|
|
442
483
|
it is AI-agnostic: it equally drives a view-editor UI or documentation. It is
|
|
443
484
|
a descriptor, not a JSON-Schema document. The enterprise grid extends it with
|
|
@@ -446,7 +487,7 @@ grouping / pivot / aggregation availability.</p>
|
|
|
446
487
|
column layout, sort, filter, quick-filter, pagination, selection, expansion,
|
|
447
488
|
tree expansion, and any feature-module state. Functions and templates are
|
|
448
489
|
omitted (see <a href="../interfaces/GridState.html" class="tsd-kind-interface">GridState</a>).</p>
|
|
449
|
-
</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-
|
|
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
|
|
450
491
|
assistant, or implement save/restore. Set <a href="#rowid" class="tsd-kind-property">ApexGrid.rowId</a> for
|
|
451
492
|
selection/expansion to survive a wholesale data reload.</p>
|
|
452
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>
|
|
@@ -455,7 +496,7 @@ selection/expansion to survive a wholesale data reload.</p>
|
|
|
455
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>
|
|
456
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>
|
|
457
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>
|
|
458
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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
|
|
459
500
|
<code>pageChanged</code> event after. Out-of-range values are clamped into <code>[0, pageCount - 1]</code>.</p>
|
|
460
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>
|
|
461
502
|
</code><button type="button">Copy</button></pre>
|
|
@@ -464,10 +505,10 @@ selection/expansion to survive a wholesale data reload.</p>
|
|
|
464
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>
|
|
465
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>
|
|
466
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>
|
|
467
|
-
</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">"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.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.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">"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
|
|
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
|
|
468
509
|
<a href="#localetext" class="tsd-kind-property">ApexGrid.localeText</a> override over the English default and
|
|
469
510
|
interpolating <code>{placeholder}</code> tokens from <code>params</code>.</p>
|
|
470
|
-
</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">"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.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.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">"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-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>Used internally by the grid's components. <code>fallback</code> is returned when the
|
|
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
|
|
471
512
|
key is not part of the built-in set (for example a custom filter operand's
|
|
472
513
|
own label).</p>
|
|
473
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>
|
|
@@ -475,7 +516,7 @@ own label).</p>
|
|
|
475
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>
|
|
476
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>
|
|
477
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>
|
|
478
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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.
|
|
479
520
|
Reordering only succeeds when the source and target columns share the same
|
|
480
521
|
pinning group (start / unpinned / end) — cross-group moves return <code>false</code>.
|
|
481
522
|
Use <a href="#pincolumn" class="tsd-kind-method">ApexGrid.pinColumn</a> to change a column's pinning group first.</p>
|
|
@@ -485,17 +526,24 @@ Use <a href="#pincolumn" class="tsd-kind-method">ApexGrid.pinColumn</a> to chang
|
|
|
485
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> /
|
|
486
527
|
<code>'after'</code>) the row at view index <code>to</code>. Indices are into
|
|
487
528
|
<a href="#pageitems" class="tsd-kind-accessor">ApexGrid.pageItems</a>.</p>
|
|
488
|
-
</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,
|
|
489
|
-
cancelled.</p>
|
|
490
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
491
|
-
|
|
492
|
-
event, emits <code>rowMoved</code>, and animates the affected
|
|
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>
|
|
493
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>
|
|
494
|
-
</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="
|
|
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>
|
|
495
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>
|
|
496
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>
|
|
497
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>
|
|
498
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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>
|
|
499
547
|
event after the update is applied. The user-supplied <a href="#columns" class="tsd-kind-property">ApexGrid.columns</a>
|
|
500
548
|
array is not reordered — only the visual render order changes.</p>
|
|
501
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>
|
|
@@ -504,9 +552,9 @@ array is not reordered — only the visual render order changes.</p>
|
|
|
504
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
|
|
505
553
|
body. Moves it between bands when already pinned elsewhere.</p>
|
|
506
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>
|
|
507
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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>
|
|
508
556
|
event and emits <code>rowPinned</code> on success. Identity is by reference, so pass
|
|
509
|
-
the same object held in <a href="#data" class="tsd-kind-
|
|
557
|
+
the same object held in <a href="#data" class="tsd-kind-accessor">ApexGrid.data</a>.</p>
|
|
510
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>
|
|
511
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
|
|
512
560
|
redo or history is disabled.</p>
|
|
@@ -519,18 +567,18 @@ rejected by a <code>rowSelecting</code> listener or selection is disabled.</p>
|
|
|
519
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>
|
|
520
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>
|
|
521
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>
|
|
522
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-
|
|
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
|
|
523
571
|
<code>pageChanged</code> event after.</p>
|
|
524
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
|
|
525
573
|
<code>quickFilterChanging</code> event first and the <code>quickFilterChanged</code> event after the
|
|
526
|
-
pipeline has run.</p>
|
|
574
|
+
pipeline has run. Moving back to the first page fires <code>pageChanged</code> too.</p>
|
|
527
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>
|
|
528
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>
|
|
529
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>
|
|
530
578
|
</code><button type="button">Copy</button></pre>
|
|
531
579
|
|
|
532
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>
|
|
533
|
-
</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-
|
|
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
|
|
534
582
|
untouched (e.g. pass <code>{ sort }</code> to change only sorting). A present-but-empty
|
|
535
583
|
<code>sort</code>/<code>filter</code> array clears that operation. Slices are applied in dependency
|
|
536
584
|
order (columns → sort → filter → quick-filter → module structure → row order
|
|
@@ -559,16 +607,26 @@ unpinned or the operation was cancelled.</p>
|
|
|
559
607
|
body.</p>
|
|
560
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>
|
|
561
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>
|
|
562
|
-
</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-
|
|
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
|
|
563
611
|
and headers re-render with the new template / configuration. The
|
|
564
612
|
user-supplied <code>columns</code> array is also reassigned for Lit reactivity.</p>
|
|
565
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
|
|
566
614
|
registry. Idempotent — safe to call more than once.</p>
|
|
567
|
-
</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-
|
|
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
|
|
568
616
|
grid. You must also configure an Ignite UI theme + CSS, give the host a bounded
|
|
569
617
|
height, and avoid overriding <code>display</code> on the host. See the README
|
|
570
618
|
"Getting Started" section for the full setup.</p>
|
|
571
|
-
</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-
|
|
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
|
|
572
630
|
using the css tag function, via constructible stylesheets, or
|
|
573
631
|
imported from native CSS module scripts.</p>
|
|
574
632
|
<p>Note on Content Security Policy:</p>
|
|
@@ -583,4 +641,20 @@ loading application code:</p>
|
|
|
583
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>
|
|
584
642
|
</code><button type="button">Copy</button></pre>
|
|
585
643
|
|
|
586
|
-
</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></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="#data"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</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="#quickfilter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>quick<wbr/>Filter</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="#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="#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="#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-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></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>
|
|
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>
|