@genesislcap/grid-pro 15.13.1 → 15.14.0-FUI-2601.2
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/dist/custom-elements.json +1988 -563
- package/dist/dts/columns-tool-panel/columns-tool-panel.d.ts +98 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel.d.ts.map +1 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel.styles.d.ts +9 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel.styles.d.ts.map +1 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel.template.d.ts +12 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel.template.d.ts.map +1 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel.utils.d.ts +24 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel.utils.d.ts.map +1 -0
- package/dist/dts/columns-tool-panel/index.d.ts +5 -0
- package/dist/dts/columns-tool-panel/index.d.ts.map +1 -0
- package/dist/dts/grid-pro-beta.d.ts +39 -4
- package/dist/dts/grid-pro-beta.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +10 -0
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/grid-pro.styles.d.ts.map +1 -1
- package/dist/dts/grid-pro.template.d.ts.map +1 -1
- package/dist/dts/grid-pro.types.d.ts +10 -0
- package/dist/dts/grid-pro.types.d.ts.map +1 -1
- package/dist/dts/index.d.ts +2 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/react.d.ts +24 -4
- package/dist/dts/side-bar/index.d.ts +6 -0
- package/dist/dts/side-bar/index.d.ts.map +1 -0
- package/dist/dts/side-bar/side-bar.d.ts +412 -0
- package/dist/dts/side-bar/side-bar.d.ts.map +1 -0
- package/dist/dts/side-bar/side-bar.styles.d.ts +19 -0
- package/dist/dts/side-bar/side-bar.styles.d.ts.map +1 -0
- package/dist/dts/side-bar/side-bar.template.d.ts +11 -0
- package/dist/dts/side-bar/side-bar.template.d.ts.map +1 -0
- package/dist/dts/side-bar/side-bar.tools.d.ts +12 -0
- package/dist/dts/side-bar/side-bar.tools.d.ts.map +1 -0
- package/dist/dts/side-bar/side-bar.types.d.ts +77 -0
- package/dist/dts/side-bar/side-bar.types.d.ts.map +1 -0
- package/dist/esm/columns-tool-panel/columns-tool-panel.js +312 -0
- package/dist/esm/columns-tool-panel/columns-tool-panel.styles.js +122 -0
- package/dist/esm/columns-tool-panel/columns-tool-panel.template.js +79 -0
- package/dist/esm/columns-tool-panel/columns-tool-panel.utils.js +129 -0
- package/dist/esm/columns-tool-panel/index.js +4 -0
- package/dist/esm/grid-pro-beta.js +89 -3
- package/dist/esm/grid-pro.js +24 -1
- package/dist/esm/grid-pro.styles.js +4 -0
- package/dist/esm/grid-pro.template.js +18 -2
- package/dist/esm/grid-pro.types.js +11 -0
- package/dist/esm/index.js +2 -0
- package/dist/esm/side-bar/index.js +5 -0
- package/dist/esm/side-bar/side-bar.js +166 -0
- package/dist/esm/side-bar/side-bar.styles.js +154 -0
- package/dist/esm/side-bar/side-bar.template.js +48 -0
- package/dist/esm/side-bar/side-bar.tools.js +19 -0
- package/dist/esm/side-bar/side-bar.types.js +45 -0
- package/dist/grid-pro.api.json +8838 -6330
- package/dist/grid-pro.d.ts +906 -168
- package/dist/react.cjs +17 -3
- package/dist/react.mjs +14 -2
- package/package.json +14 -14
package/dist/grid-pro.d.ts
CHANGED
|
@@ -26,8 +26,8 @@ import { ColDef as ColDef_2 } from 'ag-grid-community';
|
|
|
26
26
|
import { ColGroupDef } from '@ag-grid-community/core';
|
|
27
27
|
import { ColSpanFunc } from 'ag-grid-community';
|
|
28
28
|
import { ColSpanParams } from '@ag-grid-community/core';
|
|
29
|
-
import { Column } from '
|
|
30
|
-
import { Column as Column_2 } from 'ag-grid-community';
|
|
29
|
+
import { Column } from 'ag-grid-community';
|
|
30
|
+
import { Column as Column_2 } from '@ag-grid-community/core';
|
|
31
31
|
import type { ColumnApi } from '@ag-grid-community/core';
|
|
32
32
|
import { ColumnChooserParams } from 'ag-grid-community';
|
|
33
33
|
import { ColumnMenuTab } from '@ag-grid-community/core';
|
|
@@ -69,8 +69,8 @@ import { GetQuickFilterTextParams } from '@ag-grid-community/core';
|
|
|
69
69
|
import { Grid } from '@ag-grid-community/core';
|
|
70
70
|
import type { GridApi } from '@ag-grid-community/core';
|
|
71
71
|
import type { GridApi as GridApi_2 } from 'ag-grid-community';
|
|
72
|
-
import { GridOptions } from '
|
|
73
|
-
import { GridOptions as GridOptions_2 } from 'ag-grid-community';
|
|
72
|
+
import { GridOptions } from 'ag-grid-community';
|
|
73
|
+
import { GridOptions as GridOptions_2 } from '@ag-grid-community/core';
|
|
74
74
|
import type { GridParams } from '@ag-grid-community/core';
|
|
75
75
|
import type { GridParams as GridParams_2 } from 'ag-grid-community';
|
|
76
76
|
import { GridReadyEvent } from 'ag-grid-community';
|
|
@@ -99,6 +99,8 @@ import { IRowDragItem } from '@ag-grid-community/core';
|
|
|
99
99
|
import { IRowNode } from '@ag-grid-community/core';
|
|
100
100
|
import { IStatusPanelComp } from 'ag-grid-community';
|
|
101
101
|
import { IStatusPanelParams } from 'ag-grid-community';
|
|
102
|
+
import type { IToolPanelComp } from 'ag-grid-community';
|
|
103
|
+
import type { IToolPanelParams } from 'ag-grid-community';
|
|
102
104
|
import { ITooltipComp } from '@ag-grid-community/core';
|
|
103
105
|
import { ITooltipParams } from '@ag-grid-community/core';
|
|
104
106
|
import { JSONSerializer } from '@genesislcap/foundation-utils';
|
|
@@ -145,6 +147,7 @@ import { SwatchRGB } from '@microsoft/fast-components';
|
|
|
145
147
|
import { TextField } from '@genesislcap/foundation-ui';
|
|
146
148
|
import { ToolPanelClassParams } from '@ag-grid-community/core';
|
|
147
149
|
import { ToolPanelClassParams as ToolPanelClassParams_2 } from 'ag-grid-community';
|
|
150
|
+
import type { ToolPanelDef } from 'ag-grid-community';
|
|
148
151
|
import { TooltipValueGetterFunc } from 'ag-grid-community';
|
|
149
152
|
import { ValueFormatterFunc } from '@ag-grid-community/core';
|
|
150
153
|
import { ValueFormatterFunc as ValueFormatterFunc_2 } from 'ag-grid-community';
|
|
@@ -569,6 +572,11 @@ export declare const agThemeTokenMapClassname: (themeName: string) => string;
|
|
|
569
572
|
*/
|
|
570
573
|
export declare const agThemeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<any>) => ElementStyles;
|
|
571
574
|
|
|
575
|
+
export declare function applyVisibleOrder<T extends {
|
|
576
|
+
colId?: string;
|
|
577
|
+
hide?: boolean | null;
|
|
578
|
+
}>(columnState: T[], visibleOrder: string[]): T[];
|
|
579
|
+
|
|
572
580
|
/**
|
|
573
581
|
* The background color swatch.
|
|
574
582
|
* @internal
|
|
@@ -642,6 +650,122 @@ export declare type BooleanRendererParams = {
|
|
|
642
650
|
*/
|
|
643
651
|
export declare const CellTemplate: ViewTemplate<GridProCell, any>;
|
|
644
652
|
|
|
653
|
+
export declare interface ColumnPickerItem {
|
|
654
|
+
colId: string;
|
|
655
|
+
headerName: string;
|
|
656
|
+
visible: boolean;
|
|
657
|
+
lockVisible: boolean;
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
/**
|
|
661
|
+
* Custom columns tool panel. Replaces AG Grid Enterprise `agColumnsToolPanel`.
|
|
662
|
+
*
|
|
663
|
+
* @public
|
|
664
|
+
* @remarks
|
|
665
|
+
* Registered as `gridProColumnsToolPanel` (`GridProToolPanelTypes.columns`).
|
|
666
|
+
* `resolveGridProSideBar` rewrites `sideBar: ['columns']` / `agColumnsToolPanel` to this
|
|
667
|
+
* component when using AG's Enterprise `SideBarModule`.
|
|
668
|
+
*
|
|
669
|
+
* Prefer mounting via `with-side-bar` on {@link GridProBeta} for a Community-only UI
|
|
670
|
+
* that does not register any AG Enterprise modules.
|
|
671
|
+
*
|
|
672
|
+
* Layout: search → visible columns (drag to reorder) → divider → hidden columns.
|
|
673
|
+
* Checkboxes toggle visibility via `api.setColumnsVisible`; drag is limited to the
|
|
674
|
+
* visible list and disabled while a search filter is active.
|
|
675
|
+
*
|
|
676
|
+
* HTML Element: \<grid-pro-columns-tool-panel\>
|
|
677
|
+
*/
|
|
678
|
+
export declare class ColumnsToolPanel extends FoundationElement implements IToolPanelComp {
|
|
679
|
+
prefix: string;
|
|
680
|
+
private params;
|
|
681
|
+
private api;
|
|
682
|
+
/** Source colId while a visible-row drag is in progress. */
|
|
683
|
+
private dragColId;
|
|
684
|
+
/** Row currently showing drag-over highlight (avoid observable updates mid-drag). */
|
|
685
|
+
private dragOverElement;
|
|
686
|
+
/** Cancels row drag listeners when the selected list re-renders. */
|
|
687
|
+
private dragBindingAbort;
|
|
688
|
+
/** Optimistic visibility while the grid applies setColumnsVisible. */
|
|
689
|
+
private pendingVisibility;
|
|
690
|
+
search: string;
|
|
691
|
+
selectedItems: ColumnPickerItem[];
|
|
692
|
+
unselectedItems: ColumnPickerItem[];
|
|
693
|
+
/** Stable listener refs so `destroy` can remove the same functions `init` added. */
|
|
694
|
+
private readonly boundRefresh;
|
|
695
|
+
/** Drag reorder is only allowed on the full visible list (no active search). */
|
|
696
|
+
get canDrag(): boolean;
|
|
697
|
+
connectedCallback(): void;
|
|
698
|
+
/**
|
|
699
|
+
* AG Grid `IToolPanelComp` entry. Subscribes to column events so the picker
|
|
700
|
+
* stays in sync with header menu / API visibility changes.
|
|
701
|
+
*/
|
|
702
|
+
init(params: IToolPanelParams): void;
|
|
703
|
+
/**
|
|
704
|
+
* Rebuilds both lists from current grid column state.
|
|
705
|
+
* Displayed columns stay first (grid order); hidden columns follow so search
|
|
706
|
+
* and drag operate on a single ordered picker model.
|
|
707
|
+
*/
|
|
708
|
+
refresh(): void;
|
|
709
|
+
private applyPendingVisibility;
|
|
710
|
+
/** HTML5 drag on visible row handles only (disabled while search is active). */
|
|
711
|
+
private bindSelectedRowDrag;
|
|
712
|
+
/** Root element AG Grid mounts into the sidebar. */
|
|
713
|
+
getGui(): HTMLElement;
|
|
714
|
+
destroy(): void;
|
|
715
|
+
/**
|
|
716
|
+
* @internal
|
|
717
|
+
*/
|
|
718
|
+
onSearchInput(value: string): void;
|
|
719
|
+
/**
|
|
720
|
+
* @internal
|
|
721
|
+
*/
|
|
722
|
+
onCheckboxClick(item: ColumnPickerItem, event: MouseEvent): void;
|
|
723
|
+
/**
|
|
724
|
+
* @internal
|
|
725
|
+
*/
|
|
726
|
+
onVisibilityChange(item: ColumnPickerItem, visible: boolean): void;
|
|
727
|
+
/**
|
|
728
|
+
* @internal
|
|
729
|
+
*/
|
|
730
|
+
onDragStart(event: DragEvent, colId: string, row?: HTMLElement): void;
|
|
731
|
+
/**
|
|
732
|
+
* @internal
|
|
733
|
+
*/
|
|
734
|
+
onDragEnd(): void;
|
|
735
|
+
/**
|
|
736
|
+
* @internal
|
|
737
|
+
*/
|
|
738
|
+
onDragOver(event: DragEvent, row: HTMLElement): void;
|
|
739
|
+
/**
|
|
740
|
+
* @internal
|
|
741
|
+
*/
|
|
742
|
+
onDragLeave(event: DragEvent, row: HTMLElement): void;
|
|
743
|
+
/**
|
|
744
|
+
* @internal
|
|
745
|
+
*/
|
|
746
|
+
onDrop(event: DragEvent, colId: string): void;
|
|
747
|
+
private clearDragOverHighlight;
|
|
748
|
+
/**
|
|
749
|
+
* Applies a new visible-column order via `applyColumnState({ applyOrder: true })`.
|
|
750
|
+
* Hidden columns keep their relative positions; only the visible slice is permuted.
|
|
751
|
+
*/
|
|
752
|
+
private reorderSelected;
|
|
753
|
+
}
|
|
754
|
+
|
|
755
|
+
/**
|
|
756
|
+
* Styles for {@link ColumnsToolPanel}.
|
|
757
|
+
* Class selectors only — the element has no shadow root so styles land on the
|
|
758
|
+
* parent root (Grid Pro shadow / document); `:host` would target the wrong node.
|
|
759
|
+
* @public
|
|
760
|
+
*/
|
|
761
|
+
export declare const columnsToolPanelStyles: ElementStyles;
|
|
762
|
+
|
|
763
|
+
/**
|
|
764
|
+
* Default columns tool panel template (`foundation-*` components).
|
|
765
|
+
* @public
|
|
766
|
+
*/
|
|
767
|
+
export declare const columnsToolPanelTemplate: ViewTemplate<ColumnsToolPanel, any>;
|
|
768
|
+
|
|
645
769
|
/**
|
|
646
770
|
* The Grid Pro Column Template.
|
|
647
771
|
* @public
|
|
@@ -679,6 +803,12 @@ export declare const convertToKebabCase: (value: string) => string;
|
|
|
679
803
|
*/
|
|
680
804
|
export declare function copyAttributesToGridOptions(gridOptions: any, component: Record<string, any>): any;
|
|
681
805
|
|
|
806
|
+
/**
|
|
807
|
+
* Builds a custom tool panel def (AG-style registration into our shell).
|
|
808
|
+
* @public
|
|
809
|
+
*/
|
|
810
|
+
export declare function createGridProSideBarTool(def: GridProSideBarToolDef): GridProSideBarToolDef;
|
|
811
|
+
|
|
682
812
|
/**
|
|
683
813
|
* The delimiter for the criteria string.
|
|
684
814
|
* @public
|
|
@@ -1399,7 +1529,7 @@ export declare interface FuiCellRendererParams extends ICellRendererParams {
|
|
|
1399
1529
|
export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base {
|
|
1400
1530
|
connect: Connect;
|
|
1401
1531
|
datasource: Datasource;
|
|
1402
|
-
deferredGridOptions:
|
|
1532
|
+
deferredGridOptions: GridOptions_2;
|
|
1403
1533
|
deferredColumnStates: ColumnState[];
|
|
1404
1534
|
/**
|
|
1405
1535
|
* Allows grid data updates to be processed via and external function before applying in grid
|
|
@@ -1967,6 +2097,12 @@ export declare function getAvailableIndexes(data: Map<string, [string]>): string
|
|
|
1967
2097
|
*/
|
|
1968
2098
|
export declare function getAvailableIndexFields(data: Map<string, [string]>): string[];
|
|
1969
2099
|
|
|
2100
|
+
/**
|
|
2101
|
+
* Columns tool panel template with Design System prefix (`rapid-text-field`, etc.).
|
|
2102
|
+
* @public
|
|
2103
|
+
*/
|
|
2104
|
+
export declare const getColumnsToolPanelTemplate: (prefix?: string) => ViewTemplate<ColumnsToolPanel, any>;
|
|
2105
|
+
|
|
1970
2106
|
/**
|
|
1971
2107
|
* Return a column type base on each field's metadata from the selected resource.
|
|
1972
2108
|
* @param metadataType - The type of the field/column
|
|
@@ -1993,6 +2129,12 @@ export declare function getEnumFilterParams(field: FieldMetadata, filterType: st
|
|
|
1993
2129
|
|
|
1994
2130
|
export declare function getErrorHandlerDialogTemplate(prefix: string, gridErrorItems: GridProErrorItem<any>[]): ViewTemplate<any, any>;
|
|
1995
2131
|
|
|
2132
|
+
/**
|
|
2133
|
+
* Community side bar chrome. Prefix selects DS buttons (`rapid-button`, `zero-button`).
|
|
2134
|
+
* @public
|
|
2135
|
+
*/
|
|
2136
|
+
export declare const getGridProSideBarTemplate: (prefix?: string) => ViewTemplate<GridProSideBar, any>;
|
|
2137
|
+
|
|
1996
2138
|
/**
|
|
1997
2139
|
* Get a Design System prefixed The Grid Pro template.
|
|
1998
2140
|
* @param prefix - The design system prefix to use. Defaults to 'foundation'.
|
|
@@ -2033,6 +2175,8 @@ export declare const getMultiselectEditorTemplate: (designSystem?: string) => Vi
|
|
|
2033
2175
|
*/
|
|
2034
2176
|
export declare const getNumberEditorTemplate: (designSystem?: string) => ViewTemplate<NumberEditor, any>;
|
|
2035
2177
|
|
|
2178
|
+
export declare function getPickerItems(columns: Column[]): ColumnPickerItem[];
|
|
2179
|
+
|
|
2036
2180
|
/**
|
|
2037
2181
|
* Get a Design System prefixed Select template.
|
|
2038
2182
|
* @param designSystem - The design system prefix to use. Defaults to 'foundation'.
|
|
@@ -2079,6 +2223,12 @@ export declare const getTextFieldRendererTemplate: (designSystem?: string) => Vi
|
|
|
2079
2223
|
*/
|
|
2080
2224
|
export declare const getTextRendererTemplate: (designSystem?: string) => ViewTemplate<AgTextFieldRenderer, any>;
|
|
2081
2225
|
|
|
2226
|
+
/**
|
|
2227
|
+
* Default tools when `with-side-bar` is set and `sideBarTools` is not provided.
|
|
2228
|
+
* @public
|
|
2229
|
+
*/
|
|
2230
|
+
export declare const GRID_PRO_DEFAULT_SIDE_BAR_TOOLS: ReadonlyArray<GridProSideBarToolDef>;
|
|
2231
|
+
|
|
2082
2232
|
/**
|
|
2083
2233
|
* Event fired when grid is ready
|
|
2084
2234
|
* @public
|
|
@@ -2107,7 +2257,7 @@ export declare interface GridCssClassEventDetail {
|
|
|
2107
2257
|
* Grid options config used to configure grids across the application
|
|
2108
2258
|
* @public
|
|
2109
2259
|
*/
|
|
2110
|
-
export declare type GridOptionsConfig =
|
|
2260
|
+
export declare type GridOptionsConfig = GridOptions | GridOptions_2;
|
|
2111
2261
|
|
|
2112
2262
|
/**
|
|
2113
2263
|
* Grid options config used to inject into grids in application
|
|
@@ -2229,6 +2379,16 @@ export declare class GridPro extends GridPro_base {
|
|
|
2229
2379
|
classNames: string;
|
|
2230
2380
|
agGrid: Grid;
|
|
2231
2381
|
gridSlot: HTMLSlotElement;
|
|
2382
|
+
/**
|
|
2383
|
+
* The slot ref binds asynchronously, and the queued `initGrid` skips any run that beats it. FAST
|
|
2384
|
+
* calls this the moment the ref lands, so a grid whose options were set BEFORE the view bound
|
|
2385
|
+
* still initialises rather than staying blank — closing the one gap that skip would leave.
|
|
2386
|
+
*
|
|
2387
|
+
* Guarded on `agGridOptions` as well: without options there is nothing to build, and AG Grid
|
|
2388
|
+
* would only log "no gridOptions provided to the grid". Those arrive via a grid-options change,
|
|
2389
|
+
* which re-runs `initGrid` on its own.
|
|
2390
|
+
*/
|
|
2391
|
+
gridSlotChanged(): void;
|
|
2232
2392
|
themeMode: 'light' | 'dark';
|
|
2233
2393
|
gridComponents: {
|
|
2234
2394
|
[componentName: string]: any;
|
|
@@ -2260,7 +2420,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
2260
2420
|
private columnState;
|
|
2261
2421
|
protected agAttributes: Record<string, string>;
|
|
2262
2422
|
protected agPropertiesMap: Record<string, string>;
|
|
2263
|
-
protected agGridOptions:
|
|
2423
|
+
protected agGridOptions: GridOptions_2;
|
|
2264
2424
|
/**
|
|
2265
2425
|
* Last grid options supplied via the public `gridOptions` setter (not datasource init).
|
|
2266
2426
|
* Used as the merge base in `handleInitialize` so user options survive datasource restart.
|
|
@@ -2534,7 +2694,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
2534
2694
|
private addMaxRowsPanel;
|
|
2535
2695
|
private addAggregationPanel;
|
|
2536
2696
|
private addDatasourcePanels;
|
|
2537
|
-
protected setupStatusBar(gridOptions:
|
|
2697
|
+
protected setupStatusBar(gridOptions: GridOptions_2): void;
|
|
2538
2698
|
/**
|
|
2539
2699
|
* Handles column sizing based on sizeColumnsToContent and sizeColumnsToFit attributes
|
|
2540
2700
|
* @private
|
|
@@ -3072,6 +3232,16 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3072
3232
|
classNames: string;
|
|
3073
3233
|
agGrid: GridApi_2;
|
|
3074
3234
|
gridSlot: HTMLSlotElement;
|
|
3235
|
+
/**
|
|
3236
|
+
* The slot ref binds asynchronously, and the queued `initGrid` skips any run that beats it. FAST
|
|
3237
|
+
* calls this the moment the ref lands, so a grid whose options were set BEFORE the view bound
|
|
3238
|
+
* still initialises rather than staying blank — closing the one gap that skip would leave.
|
|
3239
|
+
*
|
|
3240
|
+
* Guarded on `agGridOptions` as well: without options there is nothing to build, and AG Grid
|
|
3241
|
+
* would only log "no gridOptions provided to the grid". Those arrive via a grid-options change,
|
|
3242
|
+
* which re-runs `initGrid` on its own.
|
|
3243
|
+
*/
|
|
3244
|
+
gridSlotChanged(): void;
|
|
3075
3245
|
themeMode: 'light' | 'dark';
|
|
3076
3246
|
gridComponents: {
|
|
3077
3247
|
[componentName: string]: any;
|
|
@@ -3092,6 +3262,20 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3092
3262
|
* This requires AG Grid Enterprise module to be available for the status bar to be displayed when enabled.
|
|
3093
3263
|
*/
|
|
3094
3264
|
withStatusBar: boolean;
|
|
3265
|
+
/**
|
|
3266
|
+
* Community side bar shell (no AG side-bar chrome). Tools come from `sideBarTools`.
|
|
3267
|
+
*/
|
|
3268
|
+
withSideBar: boolean;
|
|
3269
|
+
/**
|
|
3270
|
+
* Dynamic side-bar tools (Columns, AG Filters, custom `IToolPanelComp`, etc.).
|
|
3271
|
+
* Defaults to {@link GRID_PRO_DEFAULT_SIDE_BAR_TOOLS} (Columns only).
|
|
3272
|
+
*/
|
|
3273
|
+
sideBarTools: GridProSideBarToolDef[] | null;
|
|
3274
|
+
sideBarToolsChanged(): void;
|
|
3275
|
+
/** Resolved tools list used by the template. */
|
|
3276
|
+
get resolvedSideBarTools(): ReadonlyArray<GridProSideBarToolDef>;
|
|
3277
|
+
/** Community side bar element. */
|
|
3278
|
+
sideBar: GridProSideBar;
|
|
3095
3279
|
/**
|
|
3096
3280
|
* Custom error handler dialog template function.
|
|
3097
3281
|
* @remarks
|
|
@@ -3103,7 +3287,7 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3103
3287
|
private columnState;
|
|
3104
3288
|
protected agAttributes: Record<string, any>;
|
|
3105
3289
|
protected agPropertiesMap: Record<string, string>;
|
|
3106
|
-
protected agGridOptions:
|
|
3290
|
+
protected agGridOptions: GridOptions;
|
|
3107
3291
|
/** User-supplied grid options cached as merge base for datasource re-init. */
|
|
3108
3292
|
private userProvidedGridOptions;
|
|
3109
3293
|
private applyingDatasourceGridOptions;
|
|
@@ -3317,7 +3501,7 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3317
3501
|
/**
|
|
3318
3502
|
* @public
|
|
3319
3503
|
*/
|
|
3320
|
-
get gridOptions():
|
|
3504
|
+
get gridOptions(): GridOptions;
|
|
3321
3505
|
/**
|
|
3322
3506
|
* @public
|
|
3323
3507
|
*/
|
|
@@ -3338,8 +3522,15 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3338
3522
|
* @internal
|
|
3339
3523
|
*/
|
|
3340
3524
|
private notifyDatasourceVisibleColumns;
|
|
3341
|
-
set gridOptions(options:
|
|
3525
|
+
set gridOptions(options: GridOptions);
|
|
3342
3526
|
private setLocalGridOptions;
|
|
3527
|
+
private applyCommunitySideBarOptions;
|
|
3528
|
+
/**
|
|
3529
|
+
* Selects a Community side-bar tool. Clicking the active open tool collapses the panel.
|
|
3530
|
+
* @public
|
|
3531
|
+
*/
|
|
3532
|
+
selectSideBarTool(tool: GridProSideBarToolId): void;
|
|
3533
|
+
private destroySideBarTools;
|
|
3343
3534
|
/**
|
|
3344
3535
|
* Clears the local grid options, this is used to clear the grid options when the grid is restarted.
|
|
3345
3536
|
* @public
|
|
@@ -3464,7 +3655,7 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3464
3655
|
resizable?: boolean;
|
|
3465
3656
|
suppressSizeToFit?: boolean;
|
|
3466
3657
|
suppressAutoSize?: boolean;
|
|
3467
|
-
pivotValueColumn?:
|
|
3658
|
+
pivotValueColumn?: Column_2 | Column<any>;
|
|
3468
3659
|
pivotTotalColumnIds?: string[];
|
|
3469
3660
|
spanHeaderHeight?: boolean;
|
|
3470
3661
|
headerName?: string;
|
|
@@ -3528,7 +3719,7 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3528
3719
|
private addMaxRowsPanel;
|
|
3529
3720
|
private addAggregationPanel;
|
|
3530
3721
|
private addDatasourcePanels;
|
|
3531
|
-
protected setupStatusBar(gridOptions:
|
|
3722
|
+
protected setupStatusBar(gridOptions: GridOptions): void;
|
|
3532
3723
|
get observedAttributes(): string[];
|
|
3533
3724
|
agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
|
|
3534
3725
|
globalEventListener(eventType: any, event: any): void;
|
|
@@ -3578,7 +3769,12 @@ declare const GridProBeta_base: (new (...args: any[]) => {
|
|
|
3578
3769
|
hidePopover(): void;
|
|
3579
3770
|
showPopover(): void;
|
|
3580
3771
|
togglePopover(options?: boolean): boolean;
|
|
3581
|
-
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options
|
|
3772
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options
|
|
3773
|
+
/**
|
|
3774
|
+
* Timeout function used to debounce resize calls
|
|
3775
|
+
* @internal
|
|
3776
|
+
*/
|
|
3777
|
+
?: boolean | AddEventListenerOptions): void;
|
|
3582
3778
|
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
3583
3779
|
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
3584
3780
|
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
@@ -3610,9 +3806,7 @@ declare const GridProBeta_base: (new (...args: any[]) => {
|
|
|
3610
3806
|
slot: string;
|
|
3611
3807
|
readonly tagName: string;
|
|
3612
3808
|
attachShadow(init: ShadowRootInit): ShadowRoot;
|
|
3613
|
-
checkVisibility(options
|
|
3614
|
-
* The key to use for persisting the filter model in local browser or KV storage.
|
|
3615
|
-
*/: CheckVisibilityOptions): boolean;
|
|
3809
|
+
checkVisibility(options?: CheckVisibilityOptions): boolean;
|
|
3616
3810
|
closest<K extends keyof HTMLElementTagNameMap>(selector: K): HTMLElementTagNameMap[K];
|
|
3617
3811
|
closest<K extends keyof SVGElementTagNameMap>(selector: K): SVGElementTagNameMap[K];
|
|
3618
3812
|
closest<K extends keyof MathMLElementTagNameMap>(selector: K): MathMLElementTagNameMap[K];
|
|
@@ -4354,6 +4548,8 @@ declare const GridProColumn_base: (new (...args: any[]) => {
|
|
|
4354
4548
|
*/
|
|
4355
4549
|
export declare function gridProColumns<TSource = any>(itemsBinding: Binding<TSource, readonly ColDef[]> | readonly ColDef[], includeRenderers?: boolean): CaptureType<TSource>;
|
|
4356
4550
|
|
|
4551
|
+
export declare const gridProColumnsToolPanelDef: ToolPanelDef;
|
|
4552
|
+
|
|
4357
4553
|
/**
|
|
4358
4554
|
* Grid Pro possible error events
|
|
4359
4555
|
* @public
|
|
@@ -4397,7 +4593,7 @@ export declare const gridProEventNames: {
|
|
|
4397
4593
|
* @remarks - This type is used to define the events and callbacks that can be passed to the grid
|
|
4398
4594
|
* @public
|
|
4399
4595
|
*/
|
|
4400
|
-
export declare type GridProEventsAndCallbacks = OnlyFunctions<UntypeNonFunctions<
|
|
4596
|
+
export declare type GridProEventsAndCallbacks = OnlyFunctions<UntypeNonFunctions<GridOptions>>;
|
|
4401
4597
|
|
|
4402
4598
|
/**
|
|
4403
4599
|
* Grid Pro Event Listeners
|
|
@@ -5545,168 +5741,670 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
|
5545
5741
|
}) & typeof GridProBaseDatasource;
|
|
5546
5742
|
|
|
5547
5743
|
/**
|
|
5548
|
-
*
|
|
5744
|
+
* The Grid Pro Side Bar element.
|
|
5745
|
+
* @remarks No shadow root — chrome stays in Grid Pro's tree so host CSS still applies.
|
|
5549
5746
|
* @public
|
|
5550
5747
|
* @remarks
|
|
5551
|
-
*
|
|
5552
|
-
|
|
5553
|
-
|
|
5554
|
-
|
|
5555
|
-
|
|
5556
|
-
|
|
5557
|
-
|
|
5558
|
-
|
|
5559
|
-
|
|
5560
|
-
|
|
5561
|
-
|
|
5562
|
-
|
|
5563
|
-
|
|
5564
|
-
|
|
5565
|
-
|
|
5566
|
-
|
|
5567
|
-
* Configure load more button status bar component.
|
|
5568
|
-
* @remarks Can be boolean for simple enable/disable or object for detailed configuration.
|
|
5569
|
-
*/
|
|
5570
|
-
loadMore?: boolean | GridProStatusBarLoadMoreConfig;
|
|
5571
|
-
/**
|
|
5572
|
-
* Configure reload button status bar component.
|
|
5573
|
-
* @remarks Can be boolean for simple enable/disable or object for detailed configuration.
|
|
5574
|
-
*/
|
|
5575
|
-
reload?: boolean | GridProStatusBarReloadConfig;
|
|
5576
|
-
/**
|
|
5577
|
-
* Enable aggregation status bar component.
|
|
5578
|
-
* @remarks Default is true. Shows aggregation values for selected columns.
|
|
5579
|
-
*/
|
|
5580
|
-
aggregation?: boolean;
|
|
5581
|
-
}
|
|
5582
|
-
|
|
5583
|
-
/**
|
|
5584
|
-
* Configuration for the label-value status bar component
|
|
5585
|
-
* @public
|
|
5586
|
-
*/
|
|
5587
|
-
export declare interface GridProStatusBarLabelConfig {
|
|
5588
|
-
/**
|
|
5589
|
-
* The label text to display
|
|
5590
|
-
*/
|
|
5591
|
-
label: string;
|
|
5592
|
-
/**
|
|
5593
|
-
* The value to display
|
|
5594
|
-
*/
|
|
5595
|
-
value: any;
|
|
5596
|
-
/**
|
|
5597
|
-
* Whether to hide the status bar component
|
|
5598
|
-
* @remarks Default is false.
|
|
5599
|
-
*/
|
|
5600
|
-
hide?: boolean;
|
|
5601
|
-
}
|
|
5602
|
-
|
|
5603
|
-
/**
|
|
5604
|
-
* Configuration options for load more status bar component
|
|
5605
|
-
* @public
|
|
5606
|
-
*/
|
|
5607
|
-
export declare interface GridProStatusBarLoadMoreConfig {
|
|
5608
|
-
/**
|
|
5609
|
-
* Custom callback function to execute when the action is triggered.
|
|
5610
|
-
* If not provided, the component will use the default datasource behavior.
|
|
5611
|
-
*/
|
|
5612
|
-
onLoadMore?: () => void;
|
|
5613
|
-
/**
|
|
5614
|
-
* Custom appearance for the button.
|
|
5615
|
-
* @remarks Options: 'accent', 'lightweight', 'neutral', 'outline', 'stealth'
|
|
5616
|
-
*/
|
|
5617
|
-
appearance?: string;
|
|
5748
|
+
* HTML Element: \<grid-pro-side-bar\>
|
|
5749
|
+
*/
|
|
5750
|
+
export declare class GridProSideBar extends GridProSideBar_base {
|
|
5751
|
+
prefix: string;
|
|
5752
|
+
prefixChanged(): void;
|
|
5753
|
+
tools: ReadonlyArray<GridProSideBarToolDef>;
|
|
5754
|
+
toolsChanged(): void;
|
|
5755
|
+
gridApi: GridApi_2 | undefined;
|
|
5756
|
+
gridApiChanged(): void;
|
|
5757
|
+
open: boolean;
|
|
5758
|
+
activeTool: GridProSideBarToolId;
|
|
5759
|
+
panelHost: HTMLElement;
|
|
5760
|
+
panelHostChanged(): void;
|
|
5761
|
+
private mountedPanels;
|
|
5762
|
+
connectedCallback(): void;
|
|
5763
|
+
disconnectedCallback(): void;
|
|
5618
5764
|
/**
|
|
5619
|
-
*
|
|
5620
|
-
* @
|
|
5765
|
+
* Selects a tool. Clicking the active open tool collapses the panel.
|
|
5766
|
+
* @public
|
|
5621
5767
|
*/
|
|
5622
|
-
|
|
5623
|
-
}
|
|
5624
|
-
|
|
5625
|
-
/**
|
|
5626
|
-
* Configuration options for reload status bar component
|
|
5627
|
-
* @public
|
|
5628
|
-
*/
|
|
5629
|
-
export declare interface GridProStatusBarReloadConfig {
|
|
5768
|
+
selectTool(tool: GridProSideBarToolId): void;
|
|
5630
5769
|
/**
|
|
5631
|
-
*
|
|
5632
|
-
* If not provided, the component will use the default datasource behavior.
|
|
5770
|
+
* @internal
|
|
5633
5771
|
*/
|
|
5634
|
-
|
|
5772
|
+
handleToolClick(id: GridProSideBarToolId): void;
|
|
5635
5773
|
/**
|
|
5636
|
-
*
|
|
5637
|
-
* @remarks Default is 'refresh'.
|
|
5774
|
+
* @public
|
|
5638
5775
|
*/
|
|
5639
|
-
|
|
5776
|
+
mountActiveTool(): void;
|
|
5640
5777
|
/**
|
|
5641
|
-
*
|
|
5642
|
-
* @remarks Default is 'Reload'.
|
|
5778
|
+
* @public
|
|
5643
5779
|
*/
|
|
5644
|
-
|
|
5645
|
-
|
|
5646
|
-
|
|
5647
|
-
/**
|
|
5648
|
-
* The available Grid Pro Status Bar Types
|
|
5649
|
-
* @public
|
|
5650
|
-
* @remarks
|
|
5651
|
-
* These status bar components require AG Grid Enterprise module to be enabled.
|
|
5652
|
-
* Status bar components will only be displayed if the Enterprise module is available.
|
|
5653
|
-
* @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
|
|
5654
|
-
*/
|
|
5655
|
-
export declare enum GridProStatusBarTypes {
|
|
5656
|
-
labelValue = "labelValue",
|
|
5657
|
-
loadMore = "loadMore",
|
|
5658
|
-
reload = "reload",
|
|
5659
|
-
rowCount = "rowCount"
|
|
5660
|
-
}
|
|
5661
|
-
|
|
5662
|
-
/**
|
|
5663
|
-
*
|
|
5664
|
-
* @public
|
|
5665
|
-
* @remarks
|
|
5666
|
-
* HTML Element: <foundation-grid-pro>
|
|
5667
|
-
*/
|
|
5668
|
-
export declare const gridProTemplate: ViewTemplate;
|
|
5669
|
-
|
|
5670
|
-
/**
|
|
5671
|
-
* Event detail for the `gridReady`/`onGridReady` signals.
|
|
5672
|
-
* @public
|
|
5673
|
-
* @remarks Only accurate for {@link @genesislcap/grid-pro#GridProBeta}, which is built on
|
|
5674
|
-
* `ag-grid-community` (v36). {@link @genesislcap/grid-pro#GridPro} fires the same event names
|
|
5675
|
-
* but its `event` field is a `@ag-grid-community/core` (v29) `GridReadyEvent`.
|
|
5676
|
-
*/
|
|
5677
|
-
export declare interface GridReadyEventDetail {
|
|
5678
|
-
event: GridReadyEvent;
|
|
5679
|
-
gridId: string;
|
|
5780
|
+
destroyTools(): void;
|
|
5781
|
+
private closeAgToolPanel;
|
|
5680
5782
|
}
|
|
5681
5783
|
|
|
5682
|
-
|
|
5683
|
-
|
|
5684
|
-
|
|
5685
|
-
|
|
5686
|
-
|
|
5687
|
-
|
|
5688
|
-
|
|
5689
|
-
|
|
5690
|
-
|
|
5691
|
-
|
|
5692
|
-
|
|
5693
|
-
|
|
5694
|
-
|
|
5695
|
-
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
|
-
|
|
5699
|
-
|
|
5700
|
-
|
|
5701
|
-
|
|
5702
|
-
|
|
5703
|
-
|
|
5704
|
-
|
|
5705
|
-
|
|
5706
|
-
|
|
5707
|
-
|
|
5708
|
-
|
|
5709
|
-
|
|
5784
|
+
declare const GridProSideBar_base: (new (...args: any[]) => {
|
|
5785
|
+
#_container: FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
|
|
5786
|
+
#_latestTokenCode: string;
|
|
5787
|
+
#_hasFirstLoaded: boolean;
|
|
5788
|
+
#_cleanupTimeout: NodeJS.Timeout;
|
|
5789
|
+
#_shouldForceLifecycle: boolean;
|
|
5790
|
+
#_blockedDisconnectSurvivedGracePeriod: boolean;
|
|
5791
|
+
cloneNode(deep?: boolean): Node;
|
|
5792
|
+
deepClone(): Node;
|
|
5793
|
+
get shouldRunDisconnect(): boolean;
|
|
5794
|
+
get shouldRunConnect(): boolean;
|
|
5795
|
+
#_blockLifecycleDueToTokenChange(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
|
|
5796
|
+
#_tryFindContainingLayout(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
|
|
5797
|
+
connectedCallback(): void;
|
|
5798
|
+
readonly $fastController: Controller;
|
|
5799
|
+
$emit(type: string, detail?: any, options?: Omit<CustomEventInit, "detail">): boolean | void;
|
|
5800
|
+
disconnectedCallback(): void;
|
|
5801
|
+
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
5802
|
+
accessKey: string;
|
|
5803
|
+
readonly accessKeyLabel: string;
|
|
5804
|
+
autocapitalize: string;
|
|
5805
|
+
autocorrect: boolean;
|
|
5806
|
+
dir: string;
|
|
5807
|
+
draggable: boolean;
|
|
5808
|
+
hidden: boolean;
|
|
5809
|
+
inert: boolean;
|
|
5810
|
+
innerText: string;
|
|
5811
|
+
lang: string;
|
|
5812
|
+
readonly offsetHeight: number;
|
|
5813
|
+
readonly offsetLeft: number;
|
|
5814
|
+
readonly offsetParent: Element | null;
|
|
5815
|
+
readonly offsetTop: number;
|
|
5816
|
+
readonly offsetWidth: number;
|
|
5817
|
+
outerText: string;
|
|
5818
|
+
popover: string | null;
|
|
5819
|
+
spellcheck: boolean;
|
|
5820
|
+
title: string;
|
|
5821
|
+
translate: boolean;
|
|
5822
|
+
writingSuggestions: string;
|
|
5823
|
+
attachInternals(): ElementInternals;
|
|
5824
|
+
click(): void;
|
|
5825
|
+
hidePopover(): void;
|
|
5826
|
+
showPopover(): void;
|
|
5827
|
+
togglePopover(options?: boolean): boolean;
|
|
5828
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
5829
|
+
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
5830
|
+
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
5831
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
5832
|
+
readonly attributes: NamedNodeMap;
|
|
5833
|
+
get classList(): DOMTokenList;
|
|
5834
|
+
set classList(value: string): any;
|
|
5835
|
+
className: string;
|
|
5836
|
+
readonly clientHeight: number;
|
|
5837
|
+
readonly clientLeft: number;
|
|
5838
|
+
readonly clientTop: number;
|
|
5839
|
+
readonly clientWidth: number;
|
|
5840
|
+
readonly currentCSSZoom: number;
|
|
5841
|
+
id: string;
|
|
5842
|
+
innerHTML: string;
|
|
5843
|
+
readonly localName: string;
|
|
5844
|
+
readonly namespaceURI: string | null;
|
|
5845
|
+
onfullscreenchange: (this: Element, ev: Event) => any;
|
|
5846
|
+
onfullscreenerror: (this: Element, ev: Event) => any;
|
|
5847
|
+
outerHTML: string;
|
|
5848
|
+
readonly ownerDocument: Document;
|
|
5849
|
+
get part(): DOMTokenList;
|
|
5850
|
+
set part(value: string): any;
|
|
5851
|
+
readonly prefix: string | null;
|
|
5852
|
+
readonly scrollHeight: number;
|
|
5853
|
+
scrollLeft: number;
|
|
5854
|
+
scrollTop: number;
|
|
5855
|
+
readonly scrollWidth: number;
|
|
5856
|
+
readonly shadowRoot: ShadowRoot | null;
|
|
5857
|
+
slot: string;
|
|
5858
|
+
readonly tagName: string;
|
|
5859
|
+
attachShadow(init: ShadowRootInit): ShadowRoot;
|
|
5860
|
+
checkVisibility(options?: CheckVisibilityOptions): boolean;
|
|
5861
|
+
closest<K extends keyof HTMLElementTagNameMap>(selector: K): HTMLElementTagNameMap[K];
|
|
5862
|
+
closest<K extends keyof SVGElementTagNameMap>(selector: K): SVGElementTagNameMap[K];
|
|
5863
|
+
closest<K extends keyof MathMLElementTagNameMap>(selector: K): MathMLElementTagNameMap[K];
|
|
5864
|
+
closest<E extends Element = Element>(selectors: string): E;
|
|
5865
|
+
computedStyleMap(): StylePropertyMapReadOnly;
|
|
5866
|
+
getAttribute(qualifiedName: string): string | null;
|
|
5867
|
+
getAttributeNS(namespace: string | null, localName: string): string | null;
|
|
5868
|
+
getAttributeNames(): string[];
|
|
5869
|
+
getAttributeNode(qualifiedName: string): Attr | null;
|
|
5870
|
+
getAttributeNodeNS(namespace: string | null, localName: string): Attr | null;
|
|
5871
|
+
getBoundingClientRect(): DOMRect;
|
|
5872
|
+
getClientRects(): DOMRectList;
|
|
5873
|
+
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
|
|
5874
|
+
getElementsByTagName<K extends keyof HTMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
|
|
5875
|
+
getElementsByTagName<K extends keyof SVGElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>;
|
|
5876
|
+
getElementsByTagName<K extends keyof MathMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
|
|
5877
|
+
getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
|
|
5878
|
+
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
|
|
5879
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
|
5880
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
|
5881
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
|
|
5882
|
+
getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf<Element>;
|
|
5883
|
+
getHTML(options?: GetHTMLOptions): string;
|
|
5884
|
+
hasAttribute(qualifiedName: string): boolean;
|
|
5885
|
+
hasAttributeNS(namespace: string | null, localName: string): boolean;
|
|
5886
|
+
hasAttributes(): boolean;
|
|
5887
|
+
hasPointerCapture(pointerId: number): boolean;
|
|
5888
|
+
insertAdjacentElement(where: InsertPosition, element: Element): Element | null;
|
|
5889
|
+
insertAdjacentHTML(position: InsertPosition, string: string): void;
|
|
5890
|
+
insertAdjacentText(where: InsertPosition, data: string): void;
|
|
5891
|
+
matches(selectors: string): boolean;
|
|
5892
|
+
releasePointerCapture(pointerId: number): void;
|
|
5893
|
+
removeAttribute(qualifiedName: string): void;
|
|
5894
|
+
removeAttributeNS(namespace: string | null, localName: string): void;
|
|
5895
|
+
removeAttributeNode(attr: Attr): Attr;
|
|
5896
|
+
requestFullscreen(options?: FullscreenOptions): Promise<void>;
|
|
5897
|
+
requestPointerLock(options?: PointerLockOptions): Promise<void>;
|
|
5898
|
+
scroll(options?: ScrollToOptions): void;
|
|
5899
|
+
scroll(x: number, y: number): void;
|
|
5900
|
+
scrollBy(options?: ScrollToOptions): void;
|
|
5901
|
+
scrollBy(x: number, y: number): void;
|
|
5902
|
+
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
5903
|
+
scrollTo(options?: ScrollToOptions): void;
|
|
5904
|
+
scrollTo(x: number, y: number): void;
|
|
5905
|
+
setAttribute(qualifiedName: string, value: string): void;
|
|
5906
|
+
setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void;
|
|
5907
|
+
setAttributeNode(attr: Attr): Attr | null;
|
|
5908
|
+
setAttributeNodeNS(attr: Attr): Attr | null;
|
|
5909
|
+
setHTMLUnsafe(html: string): void;
|
|
5910
|
+
setPointerCapture(pointerId: number): void;
|
|
5911
|
+
toggleAttribute(qualifiedName: string, force?: boolean): boolean;
|
|
5912
|
+
webkitMatchesSelector(selectors: string): boolean;
|
|
5913
|
+
textContent: string;
|
|
5914
|
+
readonly baseURI: string;
|
|
5915
|
+
readonly childNodes: NodeListOf<ChildNode>;
|
|
5916
|
+
readonly firstChild: ChildNode | null;
|
|
5917
|
+
readonly isConnected: boolean;
|
|
5918
|
+
readonly lastChild: ChildNode | null;
|
|
5919
|
+
readonly nextSibling: ChildNode | null;
|
|
5920
|
+
readonly nodeName: string;
|
|
5921
|
+
readonly nodeType: number;
|
|
5922
|
+
nodeValue: string | null;
|
|
5923
|
+
readonly parentElement: HTMLElement | null;
|
|
5924
|
+
readonly parentNode: ParentNode | null;
|
|
5925
|
+
readonly previousSibling: ChildNode | null;
|
|
5926
|
+
appendChild<T_1 extends Node>(node: T_1): T_1;
|
|
5927
|
+
compareDocumentPosition(other: Node): number;
|
|
5928
|
+
contains(other: Node | null): boolean;
|
|
5929
|
+
getRootNode(options?: GetRootNodeOptions): Node;
|
|
5930
|
+
hasChildNodes(): boolean;
|
|
5931
|
+
insertBefore<T_1 extends Node>(node: T_1, child: Node | null): T_1;
|
|
5932
|
+
isDefaultNamespace(namespace: string | null): boolean;
|
|
5933
|
+
isEqualNode(otherNode: Node | null): boolean;
|
|
5934
|
+
isSameNode(otherNode: Node | null): boolean;
|
|
5935
|
+
lookupNamespaceURI(prefix: string | null): string | null;
|
|
5936
|
+
lookupPrefix(namespace: string | null): string | null;
|
|
5937
|
+
normalize(): void;
|
|
5938
|
+
removeChild<T_1 extends Node>(child: T_1): T_1;
|
|
5939
|
+
replaceChild<T_1 extends Node>(node: Node, child: T_1): T_1;
|
|
5940
|
+
readonly ELEMENT_NODE: 1;
|
|
5941
|
+
readonly ATTRIBUTE_NODE: 2;
|
|
5942
|
+
readonly TEXT_NODE: 3;
|
|
5943
|
+
readonly CDATA_SECTION_NODE: 4;
|
|
5944
|
+
readonly ENTITY_REFERENCE_NODE: 5;
|
|
5945
|
+
readonly ENTITY_NODE: 6;
|
|
5946
|
+
readonly PROCESSING_INSTRUCTION_NODE: 7;
|
|
5947
|
+
readonly COMMENT_NODE: 8;
|
|
5948
|
+
readonly DOCUMENT_NODE: 9;
|
|
5949
|
+
readonly DOCUMENT_TYPE_NODE: 10;
|
|
5950
|
+
readonly DOCUMENT_FRAGMENT_NODE: 11;
|
|
5951
|
+
readonly NOTATION_NODE: 12;
|
|
5952
|
+
readonly DOCUMENT_POSITION_DISCONNECTED: 1;
|
|
5953
|
+
readonly DOCUMENT_POSITION_PRECEDING: 2;
|
|
5954
|
+
readonly DOCUMENT_POSITION_FOLLOWING: 4;
|
|
5955
|
+
readonly DOCUMENT_POSITION_CONTAINS: 8;
|
|
5956
|
+
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
|
|
5957
|
+
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
|
|
5958
|
+
dispatchEvent(event: Event): boolean;
|
|
5959
|
+
ariaActiveDescendantElement: Element | null;
|
|
5960
|
+
ariaAtomic: string | null;
|
|
5961
|
+
ariaAutoComplete: string | null;
|
|
5962
|
+
ariaBrailleLabel: string | null;
|
|
5963
|
+
ariaBrailleRoleDescription: string | null;
|
|
5964
|
+
ariaBusy: string | null;
|
|
5965
|
+
ariaChecked: string | null;
|
|
5966
|
+
ariaColCount: string | null;
|
|
5967
|
+
ariaColIndex: string | null;
|
|
5968
|
+
ariaColIndexText: string | null;
|
|
5969
|
+
ariaColSpan: string | null;
|
|
5970
|
+
ariaControlsElements: ReadonlyArray<Element> | null;
|
|
5971
|
+
ariaCurrent: string | null;
|
|
5972
|
+
ariaDescribedByElements: ReadonlyArray<Element> | null;
|
|
5973
|
+
ariaDescription: string | null;
|
|
5974
|
+
ariaDetailsElements: ReadonlyArray<Element> | null;
|
|
5975
|
+
ariaDisabled: string | null;
|
|
5976
|
+
ariaErrorMessageElements: ReadonlyArray<Element> | null;
|
|
5977
|
+
ariaExpanded: string | null;
|
|
5978
|
+
ariaFlowToElements: ReadonlyArray<Element> | null;
|
|
5979
|
+
ariaHasPopup: string | null;
|
|
5980
|
+
ariaHidden: string | null;
|
|
5981
|
+
ariaInvalid: string | null;
|
|
5982
|
+
ariaKeyShortcuts: string | null;
|
|
5983
|
+
ariaLabel: string | null;
|
|
5984
|
+
ariaLabelledByElements: ReadonlyArray<Element> | null;
|
|
5985
|
+
ariaLevel: string | null;
|
|
5986
|
+
ariaLive: string | null;
|
|
5987
|
+
ariaModal: string | null;
|
|
5988
|
+
ariaMultiLine: string | null;
|
|
5989
|
+
ariaMultiSelectable: string | null;
|
|
5990
|
+
ariaOrientation: string | null;
|
|
5991
|
+
ariaOwnsElements: ReadonlyArray<Element> | null;
|
|
5992
|
+
ariaPlaceholder: string | null;
|
|
5993
|
+
ariaPosInSet: string | null;
|
|
5994
|
+
ariaPressed: string | null;
|
|
5995
|
+
ariaReadOnly: string | null;
|
|
5996
|
+
ariaRelevant: string | null;
|
|
5997
|
+
ariaRequired: string | null;
|
|
5998
|
+
ariaRoleDescription: string | null;
|
|
5999
|
+
ariaRowCount: string | null;
|
|
6000
|
+
ariaRowIndex: string | null;
|
|
6001
|
+
ariaRowIndexText: string | null;
|
|
6002
|
+
ariaRowSpan: string | null;
|
|
6003
|
+
ariaSelected: string | null;
|
|
6004
|
+
ariaSetSize: string | null;
|
|
6005
|
+
ariaSort: string | null;
|
|
6006
|
+
ariaValueMax: string | null;
|
|
6007
|
+
ariaValueMin: string | null;
|
|
6008
|
+
ariaValueNow: string | null;
|
|
6009
|
+
ariaValueText: string | null;
|
|
6010
|
+
role: string | null;
|
|
6011
|
+
animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation;
|
|
6012
|
+
getAnimations(options?: GetAnimationsOptions): Animation[];
|
|
6013
|
+
after(...nodes: (Node | string)[]): void;
|
|
6014
|
+
before(...nodes: (Node | string)[]): void;
|
|
6015
|
+
remove(): void;
|
|
6016
|
+
replaceWith(...nodes: (Node | string)[]): void;
|
|
6017
|
+
readonly nextElementSibling: Element | null;
|
|
6018
|
+
readonly previousElementSibling: Element | null;
|
|
6019
|
+
readonly childElementCount: number;
|
|
6020
|
+
readonly children: HTMLCollection;
|
|
6021
|
+
readonly firstElementChild: Element | null;
|
|
6022
|
+
readonly lastElementChild: Element | null;
|
|
6023
|
+
append(...nodes: (Node | string)[]): void;
|
|
6024
|
+
prepend(...nodes: (Node | string)[]): void;
|
|
6025
|
+
querySelector<K extends keyof HTMLElementTagNameMap>(selectors: K): HTMLElementTagNameMap[K] | null;
|
|
6026
|
+
querySelector<K extends keyof SVGElementTagNameMap>(selectors: K): SVGElementTagNameMap[K] | null;
|
|
6027
|
+
querySelector<K extends keyof MathMLElementTagNameMap>(selectors: K): MathMLElementTagNameMap[K] | null;
|
|
6028
|
+
querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): HTMLElementDeprecatedTagNameMap[K] | null;
|
|
6029
|
+
querySelector<E extends Element = Element>(selectors: string): E | null;
|
|
6030
|
+
querySelectorAll<K extends keyof HTMLElementTagNameMap>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>;
|
|
6031
|
+
querySelectorAll<K extends keyof SVGElementTagNameMap>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>;
|
|
6032
|
+
querySelectorAll<K extends keyof MathMLElementTagNameMap>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>;
|
|
6033
|
+
querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
|
|
6034
|
+
querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>;
|
|
6035
|
+
replaceChildren(...nodes: (Node | string)[]): void;
|
|
6036
|
+
readonly assignedSlot: HTMLSlotElement | null;
|
|
6037
|
+
readonly attributeStyleMap: StylePropertyMap;
|
|
6038
|
+
get style(): CSSStyleDeclaration;
|
|
6039
|
+
set style(cssText: string): any;
|
|
6040
|
+
contentEditable: string;
|
|
6041
|
+
enterKeyHint: string;
|
|
6042
|
+
inputMode: string;
|
|
6043
|
+
readonly isContentEditable: boolean;
|
|
6044
|
+
onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
|
|
6045
|
+
onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
|
|
6046
|
+
onanimationend: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
|
|
6047
|
+
onanimationiteration: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
|
|
6048
|
+
onanimationstart: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
|
|
6049
|
+
onauxclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6050
|
+
onbeforeinput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null;
|
|
6051
|
+
onbeforematch: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6052
|
+
onbeforetoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;
|
|
6053
|
+
onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
|
|
6054
|
+
oncancel: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6055
|
+
oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6056
|
+
oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6057
|
+
onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6058
|
+
onclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6059
|
+
onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6060
|
+
oncontextlost: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6061
|
+
oncontextmenu: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6062
|
+
oncontextrestored: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6063
|
+
oncopy: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
|
|
6064
|
+
oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6065
|
+
oncut: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
|
|
6066
|
+
ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6067
|
+
ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6068
|
+
ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6069
|
+
ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6070
|
+
ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6071
|
+
ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6072
|
+
ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6073
|
+
ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6074
|
+
ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6075
|
+
onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6076
|
+
onended: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6077
|
+
onerror: OnErrorEventHandler;
|
|
6078
|
+
onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
|
|
6079
|
+
onformdata: ((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null;
|
|
6080
|
+
ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6081
|
+
oninput: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6082
|
+
oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6083
|
+
onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
|
|
6084
|
+
onkeypress: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
|
|
6085
|
+
onkeyup: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
|
|
6086
|
+
onload: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6087
|
+
onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6088
|
+
onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6089
|
+
onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6090
|
+
onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6091
|
+
onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6092
|
+
onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6093
|
+
onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6094
|
+
onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6095
|
+
onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6096
|
+
onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6097
|
+
onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6098
|
+
onpaste: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
|
|
6099
|
+
onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6100
|
+
onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6101
|
+
onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6102
|
+
onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6103
|
+
onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6104
|
+
onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6105
|
+
onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6106
|
+
onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6107
|
+
onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6108
|
+
onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6109
|
+
onpointerrawupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6110
|
+
onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6111
|
+
onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null;
|
|
6112
|
+
onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6113
|
+
onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6114
|
+
onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
|
|
6115
|
+
onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6116
|
+
onscrollend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6117
|
+
onsecuritypolicyviolation: ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null;
|
|
6118
|
+
onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6119
|
+
onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6120
|
+
onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6121
|
+
onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6122
|
+
onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6123
|
+
onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6124
|
+
onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6125
|
+
onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null;
|
|
6126
|
+
onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6127
|
+
ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6128
|
+
ontoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;
|
|
6129
|
+
ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
|
|
6130
|
+
ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
|
|
6131
|
+
ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
|
|
6132
|
+
ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
|
|
6133
|
+
ontransitioncancel: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
|
|
6134
|
+
ontransitionend: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
|
|
6135
|
+
ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
|
|
6136
|
+
ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
|
|
6137
|
+
onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6138
|
+
onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6139
|
+
onwebkitanimationend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6140
|
+
onwebkitanimationiteration: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6141
|
+
onwebkitanimationstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6142
|
+
onwebkittransitionend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6143
|
+
onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null;
|
|
6144
|
+
autofocus: boolean;
|
|
6145
|
+
readonly dataset: DOMStringMap;
|
|
6146
|
+
nonce?: string;
|
|
6147
|
+
tabIndex: number;
|
|
6148
|
+
blur(): void;
|
|
6149
|
+
focus(options?: FocusOptions): void;
|
|
6150
|
+
}) & typeof FoundationElement;
|
|
6151
|
+
|
|
6152
|
+
/**
|
|
6153
|
+
* Chrome for {@link GridProSideBar}. Uses class selectors (no `:host`) because the
|
|
6154
|
+
* element has no shadow — styles land on Grid Pro's shadow root.
|
|
6155
|
+
* @public
|
|
6156
|
+
*/
|
|
6157
|
+
export declare const gridProSideBarChromeStyles: ElementStyles;
|
|
6158
|
+
|
|
6159
|
+
/**
|
|
6160
|
+
* Built-in Columns picker (Community, no AG SideBarModule).
|
|
6161
|
+
* @public
|
|
6162
|
+
*/
|
|
6163
|
+
export declare const gridProSideBarColumnsTool: GridProSideBarToolDef;
|
|
6164
|
+
|
|
6165
|
+
/**
|
|
6166
|
+
* Built-in AG Filters tool (Enterprise `FiltersToolPanelModule` required at app register).
|
|
6167
|
+
* @public
|
|
6168
|
+
*/
|
|
6169
|
+
export declare const gridProSideBarFiltersTool: GridProSideBarToolDef;
|
|
6170
|
+
|
|
6171
|
+
/**
|
|
6172
|
+
* Layout on the Grid Pro host when `with-side-bar` is set.
|
|
6173
|
+
* @public
|
|
6174
|
+
*/
|
|
6175
|
+
export declare const gridProSideBarHostStyles: ElementStyles;
|
|
6176
|
+
|
|
6177
|
+
/**
|
|
6178
|
+
* Host + chrome. Prefer {@link gridProSideBarHostStyles} on Grid Pro and
|
|
6179
|
+
* {@link gridProSideBarChromeStyles} on the side-bar element.
|
|
6180
|
+
* @public
|
|
6181
|
+
*/
|
|
6182
|
+
export declare const gridProSideBarStyles: ElementStyles;
|
|
6183
|
+
|
|
6184
|
+
/**
|
|
6185
|
+
* @public
|
|
6186
|
+
*/
|
|
6187
|
+
export declare const gridProSideBarTemplate: ViewTemplate<GridProSideBar, any>;
|
|
6188
|
+
|
|
6189
|
+
/**
|
|
6190
|
+
* Well-known Community side-bar tool ids.
|
|
6191
|
+
* @public
|
|
6192
|
+
*/
|
|
6193
|
+
export declare const GridProSideBarTool: {
|
|
6194
|
+
readonly columns: "columns";
|
|
6195
|
+
readonly filters: "filters";
|
|
6196
|
+
};
|
|
6197
|
+
|
|
6198
|
+
/**
|
|
6199
|
+
* Tool definition for the Community Grid Pro side bar shell.
|
|
6200
|
+
*
|
|
6201
|
+
* - `createPanel`: local `IToolPanelComp` (no AG SideBar chrome); preferred for custom / Genesis panels.
|
|
6202
|
+
* - `toolPanel`: AG registered name or component class (e.g. `'agFiltersToolPanel'` or a custom
|
|
6203
|
+
* class from https://www.ag-grid.com/javascript-data-grid/component-tool-panel/); mounted via
|
|
6204
|
+
* `api.openToolPanel(id, host)` with AG sideBar `hideButtons`.
|
|
6205
|
+
*
|
|
6206
|
+
* @public
|
|
6207
|
+
*/
|
|
6208
|
+
export declare interface GridProSideBarToolDef {
|
|
6209
|
+
id: GridProSideBarToolId;
|
|
6210
|
+
label: string;
|
|
6211
|
+
/** Localisation key for AG toolPanels; defaults to `id`. */
|
|
6212
|
+
labelKey?: string;
|
|
6213
|
+
/** AG icon key (`columns`, `filter`, …). Shown on the tab; also passed to AG `toolPanels`. */
|
|
6214
|
+
iconKey?: string;
|
|
6215
|
+
/**
|
|
6216
|
+
* AG tool panel component (`agFiltersToolPanel`, custom class, etc.).
|
|
6217
|
+
* Requires `SideBarModule` (pulled in by Filters / Enterprise modules).
|
|
6218
|
+
*/
|
|
6219
|
+
toolPanel?: any;
|
|
6220
|
+
/** Params passed to the AG / custom tool panel. */
|
|
6221
|
+
toolPanelParams?: any;
|
|
6222
|
+
/**
|
|
6223
|
+
* Factory for a locally mounted IToolPanelComp.
|
|
6224
|
+
* When set, the panel is created/mounted in our host (does not use `openToolPanel`).
|
|
6225
|
+
*/
|
|
6226
|
+
createPanel?: () => IToolPanelComp;
|
|
6227
|
+
}
|
|
6228
|
+
|
|
6229
|
+
/**
|
|
6230
|
+
* @public
|
|
6231
|
+
*/
|
|
6232
|
+
export declare type GridProSideBarToolId = (typeof GridProSideBarTool)[keyof typeof GridProSideBarTool] | (string & {});
|
|
6233
|
+
|
|
6234
|
+
/**
|
|
6235
|
+
* Configuration options for the grid status bar components
|
|
6236
|
+
* @public
|
|
6237
|
+
* @remarks
|
|
6238
|
+
* This requires AG Grid Enterprise module to be enabled.
|
|
6239
|
+
* Status bar components will only be displayed if the Enterprise module is available.
|
|
6240
|
+
* @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
|
|
6241
|
+
*/
|
|
6242
|
+
export declare interface GridProStatusBarConfig {
|
|
6243
|
+
/**
|
|
6244
|
+
* Enable row count status bar component.
|
|
6245
|
+
* @remarks Default is false.
|
|
6246
|
+
*/
|
|
6247
|
+
rows?: boolean;
|
|
6248
|
+
/**
|
|
6249
|
+
* Enable max rows status bar component.
|
|
6250
|
+
* @remarks Default is false.
|
|
6251
|
+
*/
|
|
6252
|
+
maxRows?: boolean;
|
|
6253
|
+
/**
|
|
6254
|
+
* Configure load more button status bar component.
|
|
6255
|
+
* @remarks Can be boolean for simple enable/disable or object for detailed configuration.
|
|
6256
|
+
*/
|
|
6257
|
+
loadMore?: boolean | GridProStatusBarLoadMoreConfig;
|
|
6258
|
+
/**
|
|
6259
|
+
* Configure reload button status bar component.
|
|
6260
|
+
* @remarks Can be boolean for simple enable/disable or object for detailed configuration.
|
|
6261
|
+
*/
|
|
6262
|
+
reload?: boolean | GridProStatusBarReloadConfig;
|
|
6263
|
+
/**
|
|
6264
|
+
* Enable aggregation status bar component.
|
|
6265
|
+
* @remarks Default is true. Shows aggregation values for selected columns.
|
|
6266
|
+
*/
|
|
6267
|
+
aggregation?: boolean;
|
|
6268
|
+
}
|
|
6269
|
+
|
|
6270
|
+
/**
|
|
6271
|
+
* Configuration for the label-value status bar component
|
|
6272
|
+
* @public
|
|
6273
|
+
*/
|
|
6274
|
+
export declare interface GridProStatusBarLabelConfig {
|
|
6275
|
+
/**
|
|
6276
|
+
* The label text to display
|
|
6277
|
+
*/
|
|
6278
|
+
label: string;
|
|
6279
|
+
/**
|
|
6280
|
+
* The value to display
|
|
6281
|
+
*/
|
|
6282
|
+
value: any;
|
|
6283
|
+
/**
|
|
6284
|
+
* Whether to hide the status bar component
|
|
6285
|
+
* @remarks Default is false.
|
|
6286
|
+
*/
|
|
6287
|
+
hide?: boolean;
|
|
6288
|
+
}
|
|
6289
|
+
|
|
6290
|
+
/**
|
|
6291
|
+
* Configuration options for load more status bar component
|
|
6292
|
+
* @public
|
|
6293
|
+
*/
|
|
6294
|
+
export declare interface GridProStatusBarLoadMoreConfig {
|
|
6295
|
+
/**
|
|
6296
|
+
* Custom callback function to execute when the action is triggered.
|
|
6297
|
+
* If not provided, the component will use the default datasource behavior.
|
|
6298
|
+
*/
|
|
6299
|
+
onLoadMore?: () => void;
|
|
6300
|
+
/**
|
|
6301
|
+
* Custom appearance for the button.
|
|
6302
|
+
* @remarks Options: 'accent', 'lightweight', 'neutral', 'outline', 'stealth'
|
|
6303
|
+
*/
|
|
6304
|
+
appearance?: string;
|
|
6305
|
+
/**
|
|
6306
|
+
* Custom tooltip text that appears on hover.
|
|
6307
|
+
* @remarks Default is 'Load More'.
|
|
6308
|
+
*/
|
|
6309
|
+
tooltip?: string;
|
|
6310
|
+
}
|
|
6311
|
+
|
|
6312
|
+
/**
|
|
6313
|
+
* Configuration options for reload status bar component
|
|
6314
|
+
* @public
|
|
6315
|
+
*/
|
|
6316
|
+
export declare interface GridProStatusBarReloadConfig {
|
|
6317
|
+
/**
|
|
6318
|
+
* Custom callback function to execute when the action is triggered.
|
|
6319
|
+
* If not provided, the component will use the default datasource behavior.
|
|
6320
|
+
*/
|
|
6321
|
+
onReload?: () => void;
|
|
6322
|
+
/**
|
|
6323
|
+
* Custom FontAwesome icon name (without 'fa-' prefix).
|
|
6324
|
+
* @remarks Default is 'refresh'.
|
|
6325
|
+
*/
|
|
6326
|
+
icon?: string;
|
|
6327
|
+
/**
|
|
6328
|
+
* Custom tooltip text that appears on hover.
|
|
6329
|
+
* @remarks Default is 'Reload'.
|
|
6330
|
+
*/
|
|
6331
|
+
tooltip?: string;
|
|
6332
|
+
}
|
|
6333
|
+
|
|
6334
|
+
/**
|
|
6335
|
+
* The available Grid Pro Status Bar Types
|
|
6336
|
+
* @public
|
|
6337
|
+
* @remarks
|
|
6338
|
+
* These status bar components require AG Grid Enterprise module to be enabled.
|
|
6339
|
+
* Status bar components will only be displayed if the Enterprise module is available.
|
|
6340
|
+
* @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
|
|
6341
|
+
*/
|
|
6342
|
+
export declare enum GridProStatusBarTypes {
|
|
6343
|
+
labelValue = "labelValue",
|
|
6344
|
+
loadMore = "loadMore",
|
|
6345
|
+
reload = "reload",
|
|
6346
|
+
rowCount = "rowCount"
|
|
6347
|
+
}
|
|
6348
|
+
|
|
6349
|
+
/**
|
|
6350
|
+
*
|
|
6351
|
+
* @public
|
|
6352
|
+
* @remarks
|
|
6353
|
+
* HTML Element: <foundation-grid-pro>
|
|
6354
|
+
*/
|
|
6355
|
+
export declare const gridProTemplate: ViewTemplate;
|
|
6356
|
+
|
|
6357
|
+
/**
|
|
6358
|
+
* Custom Grid Pro tool panel component names.
|
|
6359
|
+
* @public
|
|
6360
|
+
* @remarks
|
|
6361
|
+
* Registered for AG `sideBar` hosts (`SideBarModule` still required for that path).
|
|
6362
|
+
* Prefer `with-side-bar` on {@link GridProBeta} for a Community-only columns UI.
|
|
6363
|
+
*/
|
|
6364
|
+
export declare enum GridProToolPanelTypes {
|
|
6365
|
+
columns = "gridProColumnsToolPanel"
|
|
6366
|
+
}
|
|
6367
|
+
|
|
6368
|
+
/**
|
|
6369
|
+
* Event detail for the `gridReady`/`onGridReady` signals.
|
|
6370
|
+
* @public
|
|
6371
|
+
* @remarks Only accurate for {@link @genesislcap/grid-pro#GridProBeta}, which is built on
|
|
6372
|
+
* `ag-grid-community` (v36). {@link @genesislcap/grid-pro#GridPro} fires the same event names
|
|
6373
|
+
* but its `event` field is a `@ag-grid-community/core` (v29) `GridReadyEvent`.
|
|
6374
|
+
*/
|
|
6375
|
+
export declare interface GridReadyEventDetail {
|
|
6376
|
+
event: GridReadyEvent;
|
|
6377
|
+
gridId: string;
|
|
6378
|
+
}
|
|
6379
|
+
|
|
6380
|
+
/**
|
|
6381
|
+
* The change size event grid pro genesis datasource.
|
|
6382
|
+
* @public
|
|
6383
|
+
*/
|
|
6384
|
+
export declare type GrigProGenesisDatasourceSizeChangedEvent = CustomEvent<GrigProGenesisDatasourceSizeChangedEventDetail>;
|
|
6385
|
+
|
|
6386
|
+
/**
|
|
6387
|
+
* The event detail for the grid pro genesis datasource `sizeChanged` event.
|
|
6388
|
+
* @public
|
|
6389
|
+
*/
|
|
6390
|
+
export declare type GrigProGenesisDatasourceSizeChangedEventDetail = {
|
|
6391
|
+
value: number;
|
|
6392
|
+
oldValue: number;
|
|
6393
|
+
};
|
|
6394
|
+
|
|
6395
|
+
declare type IconByNameParams = {
|
|
6396
|
+
/**
|
|
6397
|
+
* The name of the icon to display.
|
|
6398
|
+
* @remarks a string for the icon. Valid values are from the free set of font awesome icons which can be found here https://fontawesome.com/search?ic=free
|
|
6399
|
+
*/
|
|
6400
|
+
iconName: string;
|
|
6401
|
+
/**
|
|
6402
|
+
* The size of the icon.
|
|
6403
|
+
* @remarks Size values depend on the design system (e.g., 'xs', 'sm', 'md', 'lg').
|
|
6404
|
+
*/
|
|
6405
|
+
iconSize: string;
|
|
6406
|
+
};
|
|
6407
|
+
|
|
5710
6408
|
declare type IconBySrcParams = {
|
|
5711
6409
|
/**
|
|
5712
6410
|
* The source URL of an image icon to display.
|
|
@@ -5790,6 +6488,11 @@ export declare interface InitializeEventDetail {
|
|
|
5790
6488
|
};
|
|
5791
6489
|
}
|
|
5792
6490
|
|
|
6491
|
+
/**
|
|
6492
|
+
* @internal
|
|
6493
|
+
*/
|
|
6494
|
+
export declare function initLocalSideBarPanel(panel: IToolPanelComp, params: IToolPanelParams): IToolPanelComp;
|
|
6495
|
+
|
|
5793
6496
|
/**
|
|
5794
6497
|
* Implementation for the KV Storage State Persistence interface.
|
|
5795
6498
|
* @public
|
|
@@ -5924,6 +6627,15 @@ export declare type MoreRowsDetail = {
|
|
|
5924
6627
|
sourceRef: string;
|
|
5925
6628
|
};
|
|
5926
6629
|
|
|
6630
|
+
/**
|
|
6631
|
+
* @internal
|
|
6632
|
+
*/
|
|
6633
|
+
export declare type MountedSideBarPanel = {
|
|
6634
|
+
defId: string;
|
|
6635
|
+
panel: IToolPanelComp;
|
|
6636
|
+
destroy?: () => void;
|
|
6637
|
+
};
|
|
6638
|
+
|
|
5927
6639
|
/**
|
|
5928
6640
|
* @beta
|
|
5929
6641
|
* A dropdown component that displays its options in a multi-column AG Grid.
|
|
@@ -6487,6 +7199,11 @@ export declare enum OperationType {
|
|
|
6487
7199
|
/** The CSS class to use for the options element's class in the dropdown */
|
|
6488
7200
|
export declare const optionsClass = "options";
|
|
6489
7201
|
|
|
7202
|
+
export declare function partitionPickerItems(items: ColumnPickerItem[], search: string): {
|
|
7203
|
+
selected: ColumnPickerItem[];
|
|
7204
|
+
unselected: ColumnPickerItem[];
|
|
7205
|
+
};
|
|
7206
|
+
|
|
6490
7207
|
/**
|
|
6491
7208
|
* Event detail for requesting a server-side row model refresh.
|
|
6492
7209
|
*/
|
|
@@ -6530,6 +7247,25 @@ export declare type ReloadStatusBarParams = {
|
|
|
6530
7247
|
tooltip?: string;
|
|
6531
7248
|
};
|
|
6532
7249
|
|
|
7250
|
+
export declare function reorderVisibleIds(allVisibleIds: string[], shownIds: string[], fromId: string, toId: string): string[] | null;
|
|
7251
|
+
|
|
7252
|
+
/**
|
|
7253
|
+
* @internal
|
|
7254
|
+
*/
|
|
7255
|
+
export declare function resolveAgSideBarToolPanels(tools: ReadonlyArray<GridProSideBarToolDef>): {
|
|
7256
|
+
toolPanelParams?: any;
|
|
7257
|
+
id: GridProSideBarToolId;
|
|
7258
|
+
labelKey: string;
|
|
7259
|
+
labelDefault: string;
|
|
7260
|
+
iconKey: string;
|
|
7261
|
+
toolPanel: any;
|
|
7262
|
+
}[];
|
|
7263
|
+
|
|
7264
|
+
/**
|
|
7265
|
+
* Rewrites `sideBar: ['columns']` / `agColumnsToolPanel` to the custom Grid Pro picker.
|
|
7266
|
+
*/
|
|
7267
|
+
export declare function resolveGridProSideBar(sideBar: GridOptions['sideBar']): GridOptions['sideBar'];
|
|
7268
|
+
|
|
6533
7269
|
/**
|
|
6534
7270
|
* Resolves the field names of the currently visible columns.
|
|
6535
7271
|
* @remarks Prefers the grid's displayed columns (`getAllDisplayedColumns()` — already excludes
|
|
@@ -6822,6 +7558,8 @@ export declare const textFieldRendererStyles: ElementStyles;
|
|
|
6822
7558
|
*/
|
|
6823
7559
|
export declare const textRendererStyles: ElementStyles;
|
|
6824
7560
|
|
|
7561
|
+
export declare function toPickerItem(col: Column): ColumnPickerItem | null;
|
|
7562
|
+
|
|
6825
7563
|
/**
|
|
6826
7564
|
* @public
|
|
6827
7565
|
*/
|