@genesislcap/grid-pro 15.17.1 → 15.18.0-FUI-2601.4
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 +5163 -3233
- package/dist/dts/columns-tool-panel/columns-tool-panel-ag-drag.d.ts +12 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel-ag-drag.d.ts.map +1 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel.d.ts +150 -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 +48 -0
- package/dist/dts/columns-tool-panel/columns-tool-panel.utils.d.ts.map +1 -0
- package/dist/dts/columns-tool-panel/grid-pro-column-drag-bridge.d.ts +39 -0
- package/dist/dts/columns-tool-panel/grid-pro-column-drag-bridge.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 +27 -3
- package/dist/dts/grid-pro-beta.d.ts.map +1 -1
- 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 +20 -0
- package/dist/dts/row-alert/row-alert.d.ts +2 -0
- package/dist/dts/row-alert/row-alert.d.ts.map +1 -1
- 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 +418 -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 +19 -0
- package/dist/dts/side-bar/side-bar.tools.d.ts.map +1 -0
- package/dist/dts/side-bar/side-bar.types.d.ts +86 -0
- package/dist/dts/side-bar/side-bar.types.d.ts.map +1 -0
- package/dist/esm/columns-tool-panel/columns-tool-panel-ag-drag.js +50 -0
- package/dist/esm/columns-tool-panel/columns-tool-panel.js +500 -0
- package/dist/esm/columns-tool-panel/columns-tool-panel.styles.js +180 -0
- package/dist/esm/columns-tool-panel/columns-tool-panel.template.js +70 -0
- package/dist/esm/columns-tool-panel/columns-tool-panel.utils.js +185 -0
- package/dist/esm/columns-tool-panel/grid-pro-column-drag-bridge.js +57 -0
- package/dist/esm/columns-tool-panel/index.js +4 -0
- package/dist/esm/grid-pro-beta.js +95 -3
- package/dist/esm/grid-pro.js +2 -2
- package/dist/esm/grid-pro.styles.js +4 -0
- package/dist/esm/grid-pro.template.js +13 -1
- package/dist/esm/grid-pro.types.js +11 -0
- package/dist/esm/index.js +2 -0
- package/dist/esm/row-alert/row-alert.js +4 -0
- package/dist/esm/side-bar/index.js +5 -0
- package/dist/esm/side-bar/side-bar.js +204 -0
- package/dist/esm/side-bar/side-bar.styles.js +155 -0
- package/dist/esm/side-bar/side-bar.template.js +53 -0
- package/dist/esm/side-bar/side-bar.tools.js +26 -0
- package/dist/esm/side-bar/side-bar.types.js +45 -0
- package/dist/grid-pro.api.json +11006 -7961
- package/dist/grid-pro.d.ts +986 -150
- package/dist/react.cjs +14 -0
- package/dist/react.mjs +12 -0
- 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,10 @@ 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 {
|
|
73
|
-
import { GridOptions
|
|
72
|
+
import { GridDragSource } from 'ag-grid-community';
|
|
73
|
+
import { GridOptions } from 'ag-grid-community';
|
|
74
|
+
import { GridOptions as GridOptions_2 } from '@ag-grid-community/core';
|
|
75
|
+
import { GridOptionsService } from 'ag-grid-community';
|
|
74
76
|
import type { GridParams } from '@ag-grid-community/core';
|
|
75
77
|
import type { GridParams as GridParams_2 } from 'ag-grid-community';
|
|
76
78
|
import { GridReadyEvent } from 'ag-grid-community';
|
|
@@ -99,6 +101,8 @@ import { IRowDragItem } from '@ag-grid-community/core';
|
|
|
99
101
|
import { IRowNode } from '@ag-grid-community/core';
|
|
100
102
|
import { IStatusPanelComp } from 'ag-grid-community';
|
|
101
103
|
import { IStatusPanelParams } from 'ag-grid-community';
|
|
104
|
+
import type { IToolPanelComp } from 'ag-grid-community';
|
|
105
|
+
import type { IToolPanelParams } from 'ag-grid-community';
|
|
102
106
|
import { ITooltipComp } from '@ag-grid-community/core';
|
|
103
107
|
import { ITooltipParams } from '@ag-grid-community/core';
|
|
104
108
|
import { JSONSerializer } from '@genesislcap/foundation-utils';
|
|
@@ -145,6 +149,7 @@ import { SwatchRGB } from '@microsoft/fast-components';
|
|
|
145
149
|
import { TextField } from '@genesislcap/foundation-ui';
|
|
146
150
|
import { ToolPanelClassParams } from '@ag-grid-community/core';
|
|
147
151
|
import { ToolPanelClassParams as ToolPanelClassParams_2 } from 'ag-grid-community';
|
|
152
|
+
import type { ToolPanelDef } from 'ag-grid-community';
|
|
148
153
|
import { TooltipValueGetterFunc } from 'ag-grid-community';
|
|
149
154
|
import { ValueFormatterFunc } from '@ag-grid-community/core';
|
|
150
155
|
import { ValueFormatterFunc as ValueFormatterFunc_2 } from 'ag-grid-community';
|
|
@@ -569,6 +574,11 @@ export declare const agThemeTokenMapClassname: (themeName: string) => string;
|
|
|
569
574
|
*/
|
|
570
575
|
export declare const agThemeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<any>) => ElementStyles;
|
|
571
576
|
|
|
577
|
+
export declare function applyVisibleOrder<T extends {
|
|
578
|
+
colId?: string;
|
|
579
|
+
hide?: boolean | null;
|
|
580
|
+
}>(columnState: T[], visibleOrder: string[]): T[];
|
|
581
|
+
|
|
572
582
|
/**
|
|
573
583
|
* The background color swatch.
|
|
574
584
|
* @internal
|
|
@@ -642,6 +652,159 @@ export declare type BooleanRendererParams = {
|
|
|
642
652
|
*/
|
|
643
653
|
export declare const CellTemplate: ViewTemplate<GridProCell, any>;
|
|
644
654
|
|
|
655
|
+
export declare interface ColumnPickerItem {
|
|
656
|
+
colId: string;
|
|
657
|
+
headerName: string;
|
|
658
|
+
visible: boolean;
|
|
659
|
+
lockVisible: boolean;
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
/**
|
|
663
|
+
* Custom columns tool panel. Replaces AG Grid Enterprise `agColumnsToolPanel`.
|
|
664
|
+
*
|
|
665
|
+
* @public
|
|
666
|
+
* @remarks
|
|
667
|
+
* Registered as `gridProColumnsToolPanel` (`GridProToolPanelTypes.columns`).
|
|
668
|
+
* `resolveGridProSideBar` rewrites `sideBar: ['columns']` / `agColumnsToolPanel` to this
|
|
669
|
+
* component when using AG's Enterprise `SideBarModule`.
|
|
670
|
+
*
|
|
671
|
+
* Prefer mounting via `sideBarConfig` on {@link GridProBeta} for a Community-only UI
|
|
672
|
+
* that does not register any AG Enterprise modules.
|
|
673
|
+
*
|
|
674
|
+
* Layout: select-all + search → column list. Ordering via `toolPanelParams.sort`
|
|
675
|
+
* (`selected-first` default, or `ag-grid`). Checkboxes toggle visibility via
|
|
676
|
+
* `api.setColumnsVisible`; drag handles on hidden rows use AG native DnD onto the grid
|
|
677
|
+
* (`allowDragFromColumnsToolPanel`); visible rows reorder inside the picker via HTML5 drag.
|
|
678
|
+
*
|
|
679
|
+
* HTML Element: \<grid-pro-columns-tool-panel\>
|
|
680
|
+
*/
|
|
681
|
+
export declare class ColumnsToolPanel extends FoundationElement implements IToolPanelComp {
|
|
682
|
+
prefix: string;
|
|
683
|
+
private params;
|
|
684
|
+
private api;
|
|
685
|
+
/** From `toolPanelParams.sort`; default `selected-first`. */
|
|
686
|
+
private sort;
|
|
687
|
+
/** Source colId while a visible-row drag is in progress. */
|
|
688
|
+
private dragColId;
|
|
689
|
+
/** Row currently showing drag-over highlight (avoid observable updates mid-drag). */
|
|
690
|
+
private dragOverElement;
|
|
691
|
+
/** Cancels row drag listeners when the selected list re-renders. */
|
|
692
|
+
private dragBindingAbort;
|
|
693
|
+
/** AG ToolPanel drag sources registered on hidden-row handles (grid drop). */
|
|
694
|
+
private agDragBindings;
|
|
695
|
+
/** Shared DnD bridge from Grid Pro (`toolPanelParams` / context). */
|
|
696
|
+
private columnDragBridge;
|
|
697
|
+
/** Retries `bindRowDrag` until the DnD bridge is populated. */
|
|
698
|
+
private dragBridgeRetryId;
|
|
699
|
+
/** Optimistic visibility while the grid applies setColumnsVisible. */
|
|
700
|
+
private pendingVisibility;
|
|
701
|
+
search: string;
|
|
702
|
+
selectedItems: ColumnPickerItem[];
|
|
703
|
+
unselectedItems: ColumnPickerItem[];
|
|
704
|
+
/** Master checkbox checked when every toggleable column is visible. */
|
|
705
|
+
selectAllChecked: boolean;
|
|
706
|
+
/** Master checkbox mixed when some (but not all) toggleable columns are visible. */
|
|
707
|
+
selectAllIndeterminate: boolean;
|
|
708
|
+
/** Stable listener refs so `destroy` can remove the same functions `init` added. */
|
|
709
|
+
private readonly boundRefresh;
|
|
710
|
+
/** Drag reorder / grid drop disabled while search filter is active. */
|
|
711
|
+
get canDrag(): boolean;
|
|
712
|
+
/** Handle is draggable onto the grid (hidden columns, or all when using ag-grid sort). */
|
|
713
|
+
canDragToGrid(item: ColumnPickerItem): boolean;
|
|
714
|
+
/** Columns in the current (search-filtered) picker lists that can be toggled. */
|
|
715
|
+
private get toggleableItems();
|
|
716
|
+
connectedCallback(): void;
|
|
717
|
+
/**
|
|
718
|
+
* AG Grid `IToolPanelComp` entry. Subscribes to column events so the picker
|
|
719
|
+
* stays in sync with header menu / API visibility changes.
|
|
720
|
+
*/
|
|
721
|
+
init(params: IToolPanelParams & GridProColumnsToolPanelParams): void;
|
|
722
|
+
/**
|
|
723
|
+
* Rebuilds picker lists from current grid column state.
|
|
724
|
+
* Ordering follows `toolPanelParams.sort` (`selected-first` | `ag-grid`).
|
|
725
|
+
*/
|
|
726
|
+
refresh(params?: IToolPanelParams & GridProColumnsToolPanelParams): void;
|
|
727
|
+
/**
|
|
728
|
+
* AG Columns uses `height: var(--ag-header-height)` on `.ag-column-select-header` /
|
|
729
|
+
* `.ag-pivot-mode-panel`. That var lives on the grid root (sibling of our side bar),
|
|
730
|
+
* so copy it onto this panel for the same alignment without measuring DOM height.
|
|
731
|
+
*/
|
|
732
|
+
private syncAgHeaderHeightVar;
|
|
733
|
+
private syncSelectAllState;
|
|
734
|
+
/**
|
|
735
|
+
* FAST checkbox `indeterminate` is an observable property (not a boolean attr), and its
|
|
736
|
+
* click handler clears it — re-apply after render so mixed state stays visible.
|
|
737
|
+
*/
|
|
738
|
+
private applySelectAllCheckboxState;
|
|
739
|
+
private applyPendingVisibility;
|
|
740
|
+
private resolveDragBridge;
|
|
741
|
+
/**
|
|
742
|
+
* Visible rows: HTML5 reorder inside the picker.
|
|
743
|
+
* Hidden rows (or all rows when `sort=ag-grid`): AG ToolPanel drag onto the grid header.
|
|
744
|
+
*/
|
|
745
|
+
private bindRowDrag;
|
|
746
|
+
private scheduleDragBridgeRetry;
|
|
747
|
+
/** Root element AG Grid mounts into the sidebar. */
|
|
748
|
+
getGui(): HTMLElement;
|
|
749
|
+
destroy(): void;
|
|
750
|
+
/**
|
|
751
|
+
* @internal
|
|
752
|
+
*/
|
|
753
|
+
onSearchInput(value: string): void;
|
|
754
|
+
/**
|
|
755
|
+
* @internal
|
|
756
|
+
*/
|
|
757
|
+
onSelectAllClick(event: MouseEvent): void;
|
|
758
|
+
/**
|
|
759
|
+
* @internal
|
|
760
|
+
*/
|
|
761
|
+
onCheckboxClick(item: ColumnPickerItem, event: MouseEvent): void;
|
|
762
|
+
/**
|
|
763
|
+
* @internal
|
|
764
|
+
*/
|
|
765
|
+
onVisibilityChange(item: ColumnPickerItem, visible: boolean): void;
|
|
766
|
+
/**
|
|
767
|
+
* @internal
|
|
768
|
+
*/
|
|
769
|
+
onDragStart(event: DragEvent, colId: string, row?: HTMLElement): void;
|
|
770
|
+
/**
|
|
771
|
+
* @internal
|
|
772
|
+
*/
|
|
773
|
+
onDragEnd(): void;
|
|
774
|
+
/**
|
|
775
|
+
* @internal
|
|
776
|
+
*/
|
|
777
|
+
onDragOver(event: DragEvent, row: HTMLElement): void;
|
|
778
|
+
/**
|
|
779
|
+
* @internal
|
|
780
|
+
*/
|
|
781
|
+
onDragLeave(event: DragEvent, row: HTMLElement): void;
|
|
782
|
+
/**
|
|
783
|
+
* @internal
|
|
784
|
+
*/
|
|
785
|
+
onDrop(event: DragEvent, colId: string): void;
|
|
786
|
+
private clearDragOverHighlight;
|
|
787
|
+
/**
|
|
788
|
+
* Applies a new visible-column order via `applyColumnState({ applyOrder: true })`.
|
|
789
|
+
* Hidden columns keep their relative positions; only the visible slice is permuted.
|
|
790
|
+
*/
|
|
791
|
+
private reorderSelected;
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
/**
|
|
795
|
+
* Styles for {@link ColumnsToolPanel}.
|
|
796
|
+
* Class selectors only — the element has no shadow root so styles land on the
|
|
797
|
+
* parent root (Grid Pro shadow / document); `:host` would target the wrong node.
|
|
798
|
+
* @public
|
|
799
|
+
*/
|
|
800
|
+
export declare const columnsToolPanelStyles: ElementStyles;
|
|
801
|
+
|
|
802
|
+
/**
|
|
803
|
+
* Default columns tool panel template (`foundation-*` components).
|
|
804
|
+
* @public
|
|
805
|
+
*/
|
|
806
|
+
export declare const columnsToolPanelTemplate: ViewTemplate<ColumnsToolPanel, any>;
|
|
807
|
+
|
|
645
808
|
/**
|
|
646
809
|
* The Grid Pro Column Template.
|
|
647
810
|
* @public
|
|
@@ -679,6 +842,12 @@ export declare const convertToKebabCase: (value: string) => string;
|
|
|
679
842
|
*/
|
|
680
843
|
export declare function copyAttributesToGridOptions(gridOptions: any, component: Record<string, any>): any;
|
|
681
844
|
|
|
845
|
+
/**
|
|
846
|
+
* Builds a custom tool panel def (AG-style registration into our shell).
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
export declare function createGridProSideBarTool(def: GridProSideBarToolDef): GridProSideBarToolDef;
|
|
850
|
+
|
|
682
851
|
/**
|
|
683
852
|
* Builds the class rules that flash rows matching `criteria`, together with the context menu
|
|
684
853
|
* that lets a user recolor, retime, or narrow that flash to a single cell.
|
|
@@ -951,6 +1120,14 @@ export declare function dateValueFormatter({ value }: ValueFormatterParams): any
|
|
|
951
1120
|
*/
|
|
952
1121
|
export declare const DEBOUNCED_RESIZE_TIME = 5;
|
|
953
1122
|
|
|
1123
|
+
/**
|
|
1124
|
+
* Default side bar config (Columns only).
|
|
1125
|
+
* @public
|
|
1126
|
+
*/
|
|
1127
|
+
export declare const DEFAULT_SIDE_BAR_CONFIG: {
|
|
1128
|
+
tools: GridProSideBarToolDef[];
|
|
1129
|
+
};
|
|
1130
|
+
|
|
954
1131
|
/**
|
|
955
1132
|
* Default status bar configuration
|
|
956
1133
|
* @public
|
|
@@ -1549,7 +1726,7 @@ export declare interface FuiCellRendererParams extends ICellRendererParams {
|
|
|
1549
1726
|
export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base {
|
|
1550
1727
|
connect: Connect;
|
|
1551
1728
|
datasource: Datasource;
|
|
1552
|
-
deferredGridOptions:
|
|
1729
|
+
deferredGridOptions: GridOptions_2;
|
|
1553
1730
|
deferredColumnStates: ColumnState[];
|
|
1554
1731
|
/**
|
|
1555
1732
|
* Allows grid data updates to be processed via and external function before applying in grid
|
|
@@ -2117,6 +2294,12 @@ export declare function getAvailableIndexes(data: Map<string, [string]>): string
|
|
|
2117
2294
|
*/
|
|
2118
2295
|
export declare function getAvailableIndexFields(data: Map<string, [string]>): string[];
|
|
2119
2296
|
|
|
2297
|
+
/**
|
|
2298
|
+
* Columns tool panel template with Design System prefix (`rapid-text-field`, etc.).
|
|
2299
|
+
* @public
|
|
2300
|
+
*/
|
|
2301
|
+
export declare const getColumnsToolPanelTemplate: (prefix?: string) => ViewTemplate<ColumnsToolPanel, any>;
|
|
2302
|
+
|
|
2120
2303
|
/**
|
|
2121
2304
|
* Return a column type base on each field's metadata from the selected resource.
|
|
2122
2305
|
* @param metadataType - The type of the field/column
|
|
@@ -2143,6 +2326,12 @@ export declare function getEnumFilterParams(field: FieldMetadata, filterType: st
|
|
|
2143
2326
|
|
|
2144
2327
|
export declare function getErrorHandlerDialogTemplate(prefix: string, gridErrorItems: GridProErrorItem<any>[]): ViewTemplate<any, any>;
|
|
2145
2328
|
|
|
2329
|
+
/**
|
|
2330
|
+
* Community side bar chrome. Prefix selects DS buttons (`rapid-button`, `zero-button`).
|
|
2331
|
+
* @public
|
|
2332
|
+
*/
|
|
2333
|
+
export declare const getGridProSideBarTemplate: (prefix?: string) => ViewTemplate<GridProSideBar, any>;
|
|
2334
|
+
|
|
2146
2335
|
/**
|
|
2147
2336
|
* Get a Design System prefixed The Grid Pro template.
|
|
2148
2337
|
* @param prefix - The design system prefix to use. Defaults to 'foundation'.
|
|
@@ -2183,6 +2372,8 @@ export declare const getMultiselectEditorTemplate: (designSystem?: string) => Vi
|
|
|
2183
2372
|
*/
|
|
2184
2373
|
export declare const getNumberEditorTemplate: (designSystem?: string) => ViewTemplate<NumberEditor, any>;
|
|
2185
2374
|
|
|
2375
|
+
export declare function getPickerItems(columns: Column[]): ColumnPickerItem[];
|
|
2376
|
+
|
|
2186
2377
|
/**
|
|
2187
2378
|
* Get a Design System prefixed Select template.
|
|
2188
2379
|
* @param designSystem - The design system prefix to use. Defaults to 'foundation'.
|
|
@@ -2229,6 +2420,14 @@ export declare const getTextFieldRendererTemplate: (designSystem?: string) => Vi
|
|
|
2229
2420
|
*/
|
|
2230
2421
|
export declare const getTextRendererTemplate: (designSystem?: string) => ViewTemplate<AgTextFieldRenderer, any>;
|
|
2231
2422
|
|
|
2423
|
+
export declare const GRID_PRO_COLUMNS_TOOL_PANEL_SORT_DEFAULT: GridProColumnsToolPanelSort;
|
|
2424
|
+
|
|
2425
|
+
/**
|
|
2426
|
+
* Preset: Columns picker only. Use in {@link GridProSideBarConfig.tools}.
|
|
2427
|
+
* @public
|
|
2428
|
+
*/
|
|
2429
|
+
export declare const GRID_PRO_DEFAULT_SIDE_BAR_TOOLS: ReadonlyArray<GridProSideBarToolDef>;
|
|
2430
|
+
|
|
2232
2431
|
/**
|
|
2233
2432
|
* Event fired when grid is ready
|
|
2234
2433
|
* @public
|
|
@@ -2257,7 +2456,7 @@ export declare interface GridCssClassEventDetail {
|
|
|
2257
2456
|
* Grid options config used to configure grids across the application
|
|
2258
2457
|
* @public
|
|
2259
2458
|
*/
|
|
2260
|
-
export declare type GridOptionsConfig =
|
|
2459
|
+
export declare type GridOptionsConfig = GridOptions | GridOptions_2;
|
|
2261
2460
|
|
|
2262
2461
|
/**
|
|
2263
2462
|
* Grid options config used to inject into grids in application
|
|
@@ -2420,7 +2619,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
2420
2619
|
private columnState;
|
|
2421
2620
|
protected agAttributes: Record<string, string>;
|
|
2422
2621
|
protected agPropertiesMap: Record<string, string>;
|
|
2423
|
-
protected agGridOptions:
|
|
2622
|
+
protected agGridOptions: GridOptions_2;
|
|
2424
2623
|
/**
|
|
2425
2624
|
* Last grid options supplied via the public `gridOptions` setter (not datasource init).
|
|
2426
2625
|
* Used as the merge base in `handleInitialize` so user options survive datasource restart.
|
|
@@ -2694,7 +2893,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
2694
2893
|
private addMaxRowsPanel;
|
|
2695
2894
|
private addAggregationPanel;
|
|
2696
2895
|
private addDatasourcePanels;
|
|
2697
|
-
protected setupStatusBar(gridOptions:
|
|
2896
|
+
protected setupStatusBar(gridOptions: GridOptions_2): void;
|
|
2698
2897
|
/**
|
|
2699
2898
|
* Handles column sizing based on sizeColumnsToContent and sizeColumnsToFit attributes
|
|
2700
2899
|
* @private
|
|
@@ -3187,6 +3386,10 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3187
3386
|
private readonly debouncedSaveColumnState;
|
|
3188
3387
|
private readonly debouncedSaveFilterModel;
|
|
3189
3388
|
private readonly debouncedNotifyDatasourceVisibleColumns;
|
|
3389
|
+
/** Wired to `gridOptions.context` for columns picker → grid drag (see bridge module). */
|
|
3390
|
+
private readonly columnDragBridge;
|
|
3391
|
+
/** @internal Shared AG column-drag bridge for custom tool panels. */
|
|
3392
|
+
getColumnDragBridge(): GridProColumnDragBridge;
|
|
3190
3393
|
autoCellRendererByType: boolean;
|
|
3191
3394
|
onlyTemplateColDefs: boolean;
|
|
3192
3395
|
/**
|
|
@@ -3262,6 +3465,18 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3262
3465
|
* This requires AG Grid Enterprise module to be available for the status bar to be displayed when enabled.
|
|
3263
3466
|
*/
|
|
3264
3467
|
withStatusBar: boolean;
|
|
3468
|
+
/**
|
|
3469
|
+
* Side bar configuration. When set, enables the Community side-bar shell and its tool tabs.
|
|
3470
|
+
* Omit for no side bar. Use {@link DEFAULT_SIDE_BAR_CONFIG} for Columns only.
|
|
3471
|
+
*/
|
|
3472
|
+
sideBarConfig: GridProSideBarConfig | null;
|
|
3473
|
+
sideBarConfigChanged(): void;
|
|
3474
|
+
/** Whether the Community side bar is enabled (`sideBarConfig` is set). */
|
|
3475
|
+
get hasSideBar(): boolean;
|
|
3476
|
+
/** Tools from {@link GridProBeta.sideBarConfig} (empty when config is omitted). */
|
|
3477
|
+
get resolvedSideBarTools(): ReadonlyArray<GridProSideBarToolDef>;
|
|
3478
|
+
/** Community side bar element. */
|
|
3479
|
+
sideBar: GridProSideBar;
|
|
3265
3480
|
/**
|
|
3266
3481
|
* Custom error handler dialog template function.
|
|
3267
3482
|
* @remarks
|
|
@@ -3273,7 +3488,7 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3273
3488
|
private columnState;
|
|
3274
3489
|
protected agAttributes: Record<string, any>;
|
|
3275
3490
|
protected agPropertiesMap: Record<string, string>;
|
|
3276
|
-
protected agGridOptions:
|
|
3491
|
+
protected agGridOptions: GridOptions;
|
|
3277
3492
|
/** User-supplied grid options cached as merge base for datasource re-init. */
|
|
3278
3493
|
private userProvidedGridOptions;
|
|
3279
3494
|
private applyingDatasourceGridOptions;
|
|
@@ -3487,7 +3702,7 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3487
3702
|
/**
|
|
3488
3703
|
* @public
|
|
3489
3704
|
*/
|
|
3490
|
-
get gridOptions():
|
|
3705
|
+
get gridOptions(): GridOptions;
|
|
3491
3706
|
/**
|
|
3492
3707
|
* @public
|
|
3493
3708
|
*/
|
|
@@ -3508,8 +3723,16 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3508
3723
|
* @internal
|
|
3509
3724
|
*/
|
|
3510
3725
|
private notifyDatasourceVisibleColumns;
|
|
3511
|
-
set gridOptions(options:
|
|
3726
|
+
set gridOptions(options: GridOptions);
|
|
3512
3727
|
private setLocalGridOptions;
|
|
3728
|
+
private applyCommunitySideBarOptions;
|
|
3729
|
+
/**
|
|
3730
|
+
* Selects a Community side-bar tool. Clicking the active open tool collapses the panel.
|
|
3731
|
+
* @public
|
|
3732
|
+
*/
|
|
3733
|
+
selectSideBarTool(tool: GridProSideBarToolId): void;
|
|
3734
|
+
private syncSideBarHostLayout;
|
|
3735
|
+
private destroySideBarTools;
|
|
3513
3736
|
/**
|
|
3514
3737
|
* Clears the local grid options, this is used to clear the grid options when the grid is restarted.
|
|
3515
3738
|
* @public
|
|
@@ -3634,7 +3857,7 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3634
3857
|
resizable?: boolean;
|
|
3635
3858
|
suppressSizeToFit?: boolean;
|
|
3636
3859
|
suppressAutoSize?: boolean;
|
|
3637
|
-
pivotValueColumn?:
|
|
3860
|
+
pivotValueColumn?: Column_2 | Column<any>;
|
|
3638
3861
|
pivotTotalColumnIds?: string[];
|
|
3639
3862
|
spanHeaderHeight?: boolean;
|
|
3640
3863
|
headerName?: string;
|
|
@@ -3698,7 +3921,7 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3698
3921
|
private addMaxRowsPanel;
|
|
3699
3922
|
private addAggregationPanel;
|
|
3700
3923
|
private addDatasourcePanels;
|
|
3701
|
-
protected setupStatusBar(gridOptions:
|
|
3924
|
+
protected setupStatusBar(gridOptions: GridOptions): void;
|
|
3702
3925
|
get observedAttributes(): string[];
|
|
3703
3926
|
agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
|
|
3704
3927
|
globalEventListener(eventType: any, event: any): void;
|
|
@@ -3780,9 +4003,7 @@ declare const GridProBeta_base: (new (...args: any[]) => {
|
|
|
3780
4003
|
slot: string;
|
|
3781
4004
|
readonly tagName: string;
|
|
3782
4005
|
attachShadow(init: ShadowRootInit): ShadowRoot;
|
|
3783
|
-
checkVisibility(options
|
|
3784
|
-
* The key to use for persisting the filter model in local browser or KV storage.
|
|
3785
|
-
*/: CheckVisibilityOptions): boolean;
|
|
4006
|
+
checkVisibility(options?: CheckVisibilityOptions): boolean;
|
|
3786
4007
|
closest<K extends keyof HTMLElementTagNameMap>(selector: K): HTMLElementTagNameMap[K];
|
|
3787
4008
|
closest<K extends keyof SVGElementTagNameMap>(selector: K): SVGElementTagNameMap[K];
|
|
3788
4009
|
closest<K extends keyof MathMLElementTagNameMap>(selector: K): MathMLElementTagNameMap[K];
|
|
@@ -4515,6 +4736,18 @@ declare const GridProColumn_base: (new (...args: any[]) => {
|
|
|
4515
4736
|
focus(options?: FocusOptions): void;
|
|
4516
4737
|
}) & typeof FoundationElement;
|
|
4517
4738
|
|
|
4739
|
+
/**
|
|
4740
|
+
* Filled by {@link gridProColumnDragBridgeModule} after grid beans init.
|
|
4741
|
+
* Read from `IToolPanelParams.context` / `api.getGridOption('context')`.
|
|
4742
|
+
*/
|
|
4743
|
+
declare interface GridProColumnDragBridge {
|
|
4744
|
+
dragAndDrop?: {
|
|
4745
|
+
addDragSource: (source: GridDragSource, touchEnabled?: boolean) => void;
|
|
4746
|
+
removeDragSource: (source: GridDragSource) => void;
|
|
4747
|
+
};
|
|
4748
|
+
gos?: GridOptionsService;
|
|
4749
|
+
}
|
|
4750
|
+
|
|
4518
4751
|
/**
|
|
4519
4752
|
* A directive that renders a set of grid-pro-column elements from a given input binding
|
|
4520
4753
|
*
|
|
@@ -4524,6 +4757,26 @@ declare const GridProColumn_base: (new (...args: any[]) => {
|
|
|
4524
4757
|
*/
|
|
4525
4758
|
export declare function gridProColumns<TSource = any>(itemsBinding: Binding<TSource, readonly ColDef[]> | readonly ColDef[], includeRenderers?: boolean): CaptureType<TSource>;
|
|
4526
4759
|
|
|
4760
|
+
export declare const gridProColumnsToolPanelDef: ToolPanelDef;
|
|
4761
|
+
|
|
4762
|
+
/**
|
|
4763
|
+
* Params accepted by {@link ColumnsToolPanel} via AG / side-bar `toolPanelParams`.
|
|
4764
|
+
* @public
|
|
4765
|
+
*/
|
|
4766
|
+
export declare interface GridProColumnsToolPanelParams {
|
|
4767
|
+
/**
|
|
4768
|
+
* Column list ordering.
|
|
4769
|
+
* - `selected-first` (default): visible first (grid display order), then hidden A–Z.
|
|
4770
|
+
* - `ag-grid`: `api.getColumnState()` order (visible/hidden interleaved).
|
|
4771
|
+
*/
|
|
4772
|
+
sort?: GridProColumnsToolPanelSort;
|
|
4773
|
+
/** Injected by Grid Pro; same object as `context.gridProColumnDragBridge`. */
|
|
4774
|
+
columnDragBridge?: GridProColumnDragBridge;
|
|
4775
|
+
}
|
|
4776
|
+
|
|
4777
|
+
/** Column list ordering for the columns tool panel (`toolPanelParams.sort`). */
|
|
4778
|
+
export declare type GridProColumnsToolPanelSort = 'selected-first' | 'ag-grid';
|
|
4779
|
+
|
|
4527
4780
|
/**
|
|
4528
4781
|
* Grid Pro possible error events
|
|
4529
4782
|
* @public
|
|
@@ -4567,7 +4820,7 @@ export declare const gridProEventNames: {
|
|
|
4567
4820
|
* @remarks - This type is used to define the events and callbacks that can be passed to the grid
|
|
4568
4821
|
* @public
|
|
4569
4822
|
*/
|
|
4570
|
-
export declare type GridProEventsAndCallbacks = OnlyFunctions<UntypeNonFunctions<
|
|
4823
|
+
export declare type GridProEventsAndCallbacks = OnlyFunctions<UntypeNonFunctions<GridOptions>>;
|
|
4571
4824
|
|
|
4572
4825
|
/**
|
|
4573
4826
|
* Grid Pro Event Listeners
|
|
@@ -5715,151 +5968,668 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
|
5715
5968
|
}) & typeof GridProBaseDatasource;
|
|
5716
5969
|
|
|
5717
5970
|
/**
|
|
5718
|
-
*
|
|
5971
|
+
* The Grid Pro Side Bar element.
|
|
5972
|
+
* @remarks No shadow root — chrome stays in Grid Pro's tree so host CSS still applies.
|
|
5719
5973
|
* @public
|
|
5720
5974
|
* @remarks
|
|
5721
|
-
*
|
|
5722
|
-
|
|
5723
|
-
|
|
5724
|
-
|
|
5725
|
-
|
|
5726
|
-
|
|
5727
|
-
|
|
5728
|
-
|
|
5729
|
-
|
|
5730
|
-
|
|
5731
|
-
|
|
5732
|
-
|
|
5733
|
-
|
|
5734
|
-
|
|
5735
|
-
|
|
5736
|
-
|
|
5737
|
-
|
|
5738
|
-
|
|
5739
|
-
|
|
5740
|
-
|
|
5741
|
-
/**
|
|
5742
|
-
* Configure reload button status bar component.
|
|
5743
|
-
* @remarks Can be boolean for simple enable/disable or object for detailed configuration.
|
|
5744
|
-
*/
|
|
5745
|
-
reload?: boolean | GridProStatusBarReloadConfig;
|
|
5746
|
-
/**
|
|
5747
|
-
* Enable aggregation status bar component.
|
|
5748
|
-
* @remarks Default is true. Shows aggregation values for selected columns.
|
|
5749
|
-
*/
|
|
5750
|
-
aggregation?: boolean;
|
|
5751
|
-
}
|
|
5752
|
-
|
|
5753
|
-
/**
|
|
5754
|
-
* Configuration for the label-value status bar component
|
|
5755
|
-
* @public
|
|
5756
|
-
*/
|
|
5757
|
-
export declare interface GridProStatusBarLabelConfig {
|
|
5758
|
-
/**
|
|
5759
|
-
* The label text to display
|
|
5760
|
-
*/
|
|
5761
|
-
label: string;
|
|
5762
|
-
/**
|
|
5763
|
-
* The value to display
|
|
5764
|
-
*/
|
|
5765
|
-
value: any;
|
|
5766
|
-
/**
|
|
5767
|
-
* Whether to hide the status bar component
|
|
5768
|
-
* @remarks Default is false.
|
|
5769
|
-
*/
|
|
5770
|
-
hide?: boolean;
|
|
5771
|
-
}
|
|
5772
|
-
|
|
5773
|
-
/**
|
|
5774
|
-
* Configuration options for load more status bar component
|
|
5775
|
-
* @public
|
|
5776
|
-
*/
|
|
5777
|
-
export declare interface GridProStatusBarLoadMoreConfig {
|
|
5778
|
-
/**
|
|
5779
|
-
* Custom callback function to execute when the action is triggered.
|
|
5780
|
-
* If not provided, the component will use the default datasource behavior.
|
|
5781
|
-
*/
|
|
5782
|
-
onLoadMore?: () => void;
|
|
5783
|
-
/**
|
|
5784
|
-
* Custom appearance for the button.
|
|
5785
|
-
* @remarks Options: 'accent', 'lightweight', 'neutral', 'outline', 'stealth'
|
|
5786
|
-
*/
|
|
5787
|
-
appearance?: string;
|
|
5975
|
+
* HTML Element: \<grid-pro-side-bar\>
|
|
5976
|
+
*/
|
|
5977
|
+
export declare class GridProSideBar extends GridProSideBar_base {
|
|
5978
|
+
prefix: string;
|
|
5979
|
+
prefixChanged(): void;
|
|
5980
|
+
tools: ReadonlyArray<GridProSideBarToolDef>;
|
|
5981
|
+
toolsChanged(): void;
|
|
5982
|
+
gridApi: GridApi_2 | undefined;
|
|
5983
|
+
gridApiChanged(): void;
|
|
5984
|
+
columnDragBridge: GridProColumnDragBridge | undefined;
|
|
5985
|
+
columnDragBridgeChanged(): void;
|
|
5986
|
+
open: boolean;
|
|
5987
|
+
activeTool: GridProSideBarToolId;
|
|
5988
|
+
panelHost: HTMLElement;
|
|
5989
|
+
panelHostChanged(): void;
|
|
5990
|
+
private mountedPanels;
|
|
5991
|
+
private getToolPanelParams;
|
|
5992
|
+
private refreshMountedLocalPanels;
|
|
5993
|
+
connectedCallback(): void;
|
|
5994
|
+
disconnectedCallback(): void;
|
|
5788
5995
|
/**
|
|
5789
|
-
*
|
|
5790
|
-
* @
|
|
5996
|
+
* Selects a tool. Clicking the active open tool collapses the panel.
|
|
5997
|
+
* @public
|
|
5791
5998
|
*/
|
|
5792
|
-
|
|
5793
|
-
}
|
|
5794
|
-
|
|
5795
|
-
/**
|
|
5796
|
-
* Configuration options for reload status bar component
|
|
5797
|
-
* @public
|
|
5798
|
-
*/
|
|
5799
|
-
export declare interface GridProStatusBarReloadConfig {
|
|
5999
|
+
selectTool(tool: GridProSideBarToolId): void;
|
|
5800
6000
|
/**
|
|
5801
|
-
*
|
|
5802
|
-
* If not provided, the component will use the default datasource behavior.
|
|
6001
|
+
* @internal
|
|
5803
6002
|
*/
|
|
5804
|
-
|
|
6003
|
+
handleToolClick(id: GridProSideBarToolId): void;
|
|
5805
6004
|
/**
|
|
5806
|
-
*
|
|
5807
|
-
* @remarks Default is 'refresh'.
|
|
6005
|
+
* @public
|
|
5808
6006
|
*/
|
|
5809
|
-
|
|
6007
|
+
mountActiveTool(): void;
|
|
5810
6008
|
/**
|
|
5811
|
-
*
|
|
5812
|
-
* @remarks Default is 'Reload'.
|
|
6009
|
+
* @public
|
|
5813
6010
|
*/
|
|
5814
|
-
|
|
5815
|
-
|
|
5816
|
-
|
|
5817
|
-
/**
|
|
5818
|
-
* The available Grid Pro Status Bar Types
|
|
5819
|
-
* @public
|
|
5820
|
-
* @remarks
|
|
5821
|
-
* These status bar components require AG Grid Enterprise module to be enabled.
|
|
5822
|
-
* Status bar components will only be displayed if the Enterprise module is available.
|
|
5823
|
-
* @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
|
|
5824
|
-
*/
|
|
5825
|
-
export declare enum GridProStatusBarTypes {
|
|
5826
|
-
labelValue = "labelValue",
|
|
5827
|
-
loadMore = "loadMore",
|
|
5828
|
-
reload = "reload",
|
|
5829
|
-
rowCount = "rowCount"
|
|
5830
|
-
}
|
|
5831
|
-
|
|
5832
|
-
/**
|
|
5833
|
-
*
|
|
5834
|
-
* @public
|
|
5835
|
-
* @remarks
|
|
5836
|
-
* HTML Element: <foundation-grid-pro>
|
|
5837
|
-
*/
|
|
5838
|
-
export declare const gridProTemplate: ViewTemplate;
|
|
5839
|
-
|
|
5840
|
-
/**
|
|
5841
|
-
* Event detail for the `gridReady`/`onGridReady` signals.
|
|
5842
|
-
* @public
|
|
5843
|
-
* @remarks Only accurate for {@link @genesislcap/grid-pro#GridProBeta}, which is built on
|
|
5844
|
-
* `ag-grid-community` (v36). {@link @genesislcap/grid-pro#GridPro} fires the same event names
|
|
5845
|
-
* but its `event` field is a `@ag-grid-community/core` (v29) `GridReadyEvent`.
|
|
5846
|
-
*/
|
|
5847
|
-
export declare interface GridReadyEventDetail {
|
|
5848
|
-
event: GridReadyEvent;
|
|
5849
|
-
gridId: string;
|
|
6011
|
+
destroyTools(): void;
|
|
6012
|
+
private closeAgToolPanel;
|
|
6013
|
+
private syncSideBarVisibility;
|
|
5850
6014
|
}
|
|
5851
6015
|
|
|
5852
|
-
|
|
5853
|
-
|
|
5854
|
-
|
|
5855
|
-
|
|
5856
|
-
|
|
5857
|
-
|
|
5858
|
-
|
|
5859
|
-
|
|
5860
|
-
|
|
5861
|
-
|
|
5862
|
-
|
|
6016
|
+
declare const GridProSideBar_base: (new (...args: any[]) => {
|
|
6017
|
+
#_container: FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
|
|
6018
|
+
#_latestTokenCode: string;
|
|
6019
|
+
#_hasFirstLoaded: boolean;
|
|
6020
|
+
#_cleanupTimeout: NodeJS.Timeout;
|
|
6021
|
+
#_shouldForceLifecycle: boolean;
|
|
6022
|
+
#_blockedDisconnectSurvivedGracePeriod: boolean;
|
|
6023
|
+
cloneNode(deep?: boolean): Node;
|
|
6024
|
+
deepClone(): Node;
|
|
6025
|
+
get shouldRunDisconnect(): boolean;
|
|
6026
|
+
get shouldRunConnect(): boolean;
|
|
6027
|
+
#_blockLifecycleDueToTokenChange(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
|
|
6028
|
+
#_tryFindContainingLayout(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
|
|
6029
|
+
connectedCallback(): void;
|
|
6030
|
+
readonly $fastController: Controller;
|
|
6031
|
+
$emit(type: string, detail?: any, options?: Omit<CustomEventInit, "detail">): boolean | void;
|
|
6032
|
+
disconnectedCallback(): void;
|
|
6033
|
+
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
6034
|
+
accessKey: string;
|
|
6035
|
+
readonly accessKeyLabel: string;
|
|
6036
|
+
autocapitalize: string;
|
|
6037
|
+
autocorrect: boolean;
|
|
6038
|
+
dir: string;
|
|
6039
|
+
draggable: boolean;
|
|
6040
|
+
hidden: boolean;
|
|
6041
|
+
inert: boolean;
|
|
6042
|
+
innerText: string;
|
|
6043
|
+
lang: string;
|
|
6044
|
+
readonly offsetHeight: number;
|
|
6045
|
+
readonly offsetLeft: number;
|
|
6046
|
+
readonly offsetParent: Element | null;
|
|
6047
|
+
readonly offsetTop: number;
|
|
6048
|
+
readonly offsetWidth: number;
|
|
6049
|
+
outerText: string;
|
|
6050
|
+
popover: string | null;
|
|
6051
|
+
spellcheck: boolean;
|
|
6052
|
+
title: string;
|
|
6053
|
+
translate: boolean;
|
|
6054
|
+
writingSuggestions: string;
|
|
6055
|
+
attachInternals(): ElementInternals;
|
|
6056
|
+
click(): void;
|
|
6057
|
+
hidePopover(): void;
|
|
6058
|
+
showPopover(): void;
|
|
6059
|
+
togglePopover(options?: boolean): boolean;
|
|
6060
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
6061
|
+
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
6062
|
+
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
6063
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
6064
|
+
readonly attributes: NamedNodeMap;
|
|
6065
|
+
get classList(): DOMTokenList;
|
|
6066
|
+
set classList(value: string): any;
|
|
6067
|
+
className: string;
|
|
6068
|
+
readonly clientHeight: number;
|
|
6069
|
+
readonly clientLeft: number;
|
|
6070
|
+
readonly clientTop: number;
|
|
6071
|
+
readonly clientWidth: number;
|
|
6072
|
+
readonly currentCSSZoom: number;
|
|
6073
|
+
id: string;
|
|
6074
|
+
innerHTML: string;
|
|
6075
|
+
readonly localName: string;
|
|
6076
|
+
readonly namespaceURI: string | null;
|
|
6077
|
+
onfullscreenchange: (this: Element, ev: Event) => any;
|
|
6078
|
+
onfullscreenerror: (this: Element, ev: Event) => any;
|
|
6079
|
+
outerHTML: string;
|
|
6080
|
+
readonly ownerDocument: Document;
|
|
6081
|
+
get part(): DOMTokenList;
|
|
6082
|
+
set part(value: string): any;
|
|
6083
|
+
readonly prefix: string | null;
|
|
6084
|
+
readonly scrollHeight: number;
|
|
6085
|
+
scrollLeft: number;
|
|
6086
|
+
scrollTop: number;
|
|
6087
|
+
readonly scrollWidth: number;
|
|
6088
|
+
readonly shadowRoot: ShadowRoot | null;
|
|
6089
|
+
slot: string;
|
|
6090
|
+
readonly tagName: string;
|
|
6091
|
+
attachShadow(init: ShadowRootInit): ShadowRoot;
|
|
6092
|
+
checkVisibility(options?: CheckVisibilityOptions): boolean;
|
|
6093
|
+
closest<K extends keyof HTMLElementTagNameMap>(selector: K): HTMLElementTagNameMap[K];
|
|
6094
|
+
closest<K extends keyof SVGElementTagNameMap>(selector: K): SVGElementTagNameMap[K];
|
|
6095
|
+
closest<K extends keyof MathMLElementTagNameMap>(selector: K): MathMLElementTagNameMap[K];
|
|
6096
|
+
closest<E extends Element = Element>(selectors: string): E;
|
|
6097
|
+
computedStyleMap(): StylePropertyMapReadOnly;
|
|
6098
|
+
getAttribute(qualifiedName: string): string | null;
|
|
6099
|
+
getAttributeNS(namespace: string | null, localName: string): string | null;
|
|
6100
|
+
getAttributeNames(): string[];
|
|
6101
|
+
getAttributeNode(qualifiedName: string): Attr | null;
|
|
6102
|
+
getAttributeNodeNS(namespace: string | null, localName: string): Attr | null;
|
|
6103
|
+
getBoundingClientRect(): DOMRect;
|
|
6104
|
+
getClientRects(): DOMRectList;
|
|
6105
|
+
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
|
|
6106
|
+
getElementsByTagName<K extends keyof HTMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
|
|
6107
|
+
getElementsByTagName<K extends keyof SVGElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>;
|
|
6108
|
+
getElementsByTagName<K extends keyof MathMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
|
|
6109
|
+
getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
|
|
6110
|
+
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
|
|
6111
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
|
6112
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
|
6113
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
|
|
6114
|
+
getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf<Element>;
|
|
6115
|
+
getHTML(options?: GetHTMLOptions): string;
|
|
6116
|
+
hasAttribute(qualifiedName: string): boolean;
|
|
6117
|
+
hasAttributeNS(namespace: string | null, localName: string): boolean;
|
|
6118
|
+
hasAttributes(): boolean;
|
|
6119
|
+
hasPointerCapture(pointerId: number): boolean;
|
|
6120
|
+
insertAdjacentElement(where: InsertPosition, element: Element): Element | null;
|
|
6121
|
+
insertAdjacentHTML(position: InsertPosition, string: string): void;
|
|
6122
|
+
insertAdjacentText(where: InsertPosition, data: string): void;
|
|
6123
|
+
matches(selectors: string): boolean;
|
|
6124
|
+
releasePointerCapture(pointerId: number): void;
|
|
6125
|
+
removeAttribute(qualifiedName: string): void;
|
|
6126
|
+
removeAttributeNS(namespace: string | null, localName: string): void;
|
|
6127
|
+
removeAttributeNode(attr: Attr): Attr;
|
|
6128
|
+
requestFullscreen(options?: FullscreenOptions): Promise<void>;
|
|
6129
|
+
requestPointerLock(options?: PointerLockOptions): Promise<void>;
|
|
6130
|
+
scroll(options?: ScrollToOptions): void;
|
|
6131
|
+
scroll(x: number, y: number): void;
|
|
6132
|
+
scrollBy(options?: ScrollToOptions): void;
|
|
6133
|
+
scrollBy(x: number, y: number): void;
|
|
6134
|
+
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
6135
|
+
scrollTo(options?: ScrollToOptions): void;
|
|
6136
|
+
scrollTo(x: number, y: number): void;
|
|
6137
|
+
setAttribute(qualifiedName: string, value: string): void;
|
|
6138
|
+
setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void;
|
|
6139
|
+
setAttributeNode(attr: Attr): Attr | null;
|
|
6140
|
+
setAttributeNodeNS(attr: Attr): Attr | null;
|
|
6141
|
+
setHTMLUnsafe(html: string): void;
|
|
6142
|
+
setPointerCapture(pointerId: number): void;
|
|
6143
|
+
toggleAttribute(qualifiedName: string, force?: boolean): boolean;
|
|
6144
|
+
webkitMatchesSelector(selectors: string): boolean;
|
|
6145
|
+
textContent: string;
|
|
6146
|
+
readonly baseURI: string;
|
|
6147
|
+
readonly childNodes: NodeListOf<ChildNode>;
|
|
6148
|
+
readonly firstChild: ChildNode | null;
|
|
6149
|
+
readonly isConnected: boolean;
|
|
6150
|
+
readonly lastChild: ChildNode | null;
|
|
6151
|
+
readonly nextSibling: ChildNode | null;
|
|
6152
|
+
readonly nodeName: string;
|
|
6153
|
+
readonly nodeType: number;
|
|
6154
|
+
nodeValue: string | null;
|
|
6155
|
+
readonly parentElement: HTMLElement | null;
|
|
6156
|
+
readonly parentNode: ParentNode | null;
|
|
6157
|
+
readonly previousSibling: ChildNode | null;
|
|
6158
|
+
appendChild<T_1 extends Node>(node: T_1): T_1;
|
|
6159
|
+
compareDocumentPosition(other: Node): number;
|
|
6160
|
+
contains(other: Node | null): boolean;
|
|
6161
|
+
getRootNode(options?: GetRootNodeOptions): Node;
|
|
6162
|
+
hasChildNodes(): boolean;
|
|
6163
|
+
insertBefore<T_1 extends Node>(node: T_1, child: Node | null): T_1;
|
|
6164
|
+
isDefaultNamespace(namespace: string | null): boolean;
|
|
6165
|
+
isEqualNode(otherNode: Node | null): boolean;
|
|
6166
|
+
isSameNode(otherNode: Node | null): boolean;
|
|
6167
|
+
lookupNamespaceURI(prefix: string | null): string | null;
|
|
6168
|
+
lookupPrefix(namespace: string | null): string | null;
|
|
6169
|
+
normalize(): void;
|
|
6170
|
+
removeChild<T_1 extends Node>(child: T_1): T_1;
|
|
6171
|
+
replaceChild<T_1 extends Node>(node: Node, child: T_1): T_1;
|
|
6172
|
+
readonly ELEMENT_NODE: 1;
|
|
6173
|
+
readonly ATTRIBUTE_NODE: 2;
|
|
6174
|
+
readonly TEXT_NODE: 3;
|
|
6175
|
+
readonly CDATA_SECTION_NODE: 4;
|
|
6176
|
+
readonly ENTITY_REFERENCE_NODE: 5;
|
|
6177
|
+
readonly ENTITY_NODE: 6;
|
|
6178
|
+
readonly PROCESSING_INSTRUCTION_NODE: 7;
|
|
6179
|
+
readonly COMMENT_NODE: 8;
|
|
6180
|
+
readonly DOCUMENT_NODE: 9;
|
|
6181
|
+
readonly DOCUMENT_TYPE_NODE: 10;
|
|
6182
|
+
readonly DOCUMENT_FRAGMENT_NODE: 11;
|
|
6183
|
+
readonly NOTATION_NODE: 12;
|
|
6184
|
+
readonly DOCUMENT_POSITION_DISCONNECTED: 1;
|
|
6185
|
+
readonly DOCUMENT_POSITION_PRECEDING: 2;
|
|
6186
|
+
readonly DOCUMENT_POSITION_FOLLOWING: 4;
|
|
6187
|
+
readonly DOCUMENT_POSITION_CONTAINS: 8;
|
|
6188
|
+
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
|
|
6189
|
+
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
|
|
6190
|
+
dispatchEvent(event: Event): boolean;
|
|
6191
|
+
ariaActiveDescendantElement: Element | null;
|
|
6192
|
+
ariaAtomic: string | null;
|
|
6193
|
+
ariaAutoComplete: string | null;
|
|
6194
|
+
ariaBrailleLabel: string | null;
|
|
6195
|
+
ariaBrailleRoleDescription: string | null;
|
|
6196
|
+
ariaBusy: string | null;
|
|
6197
|
+
ariaChecked: string | null;
|
|
6198
|
+
ariaColCount: string | null;
|
|
6199
|
+
ariaColIndex: string | null;
|
|
6200
|
+
ariaColIndexText: string | null;
|
|
6201
|
+
ariaColSpan: string | null;
|
|
6202
|
+
ariaControlsElements: ReadonlyArray<Element> | null;
|
|
6203
|
+
ariaCurrent: string | null;
|
|
6204
|
+
ariaDescribedByElements: ReadonlyArray<Element> | null;
|
|
6205
|
+
ariaDescription: string | null;
|
|
6206
|
+
ariaDetailsElements: ReadonlyArray<Element> | null;
|
|
6207
|
+
ariaDisabled: string | null;
|
|
6208
|
+
ariaErrorMessageElements: ReadonlyArray<Element> | null;
|
|
6209
|
+
ariaExpanded: string | null;
|
|
6210
|
+
ariaFlowToElements: ReadonlyArray<Element> | null;
|
|
6211
|
+
ariaHasPopup: string | null;
|
|
6212
|
+
ariaHidden: string | null;
|
|
6213
|
+
ariaInvalid: string | null;
|
|
6214
|
+
ariaKeyShortcuts: string | null;
|
|
6215
|
+
ariaLabel: string | null;
|
|
6216
|
+
ariaLabelledByElements: ReadonlyArray<Element> | null;
|
|
6217
|
+
ariaLevel: string | null;
|
|
6218
|
+
ariaLive: string | null;
|
|
6219
|
+
ariaModal: string | null;
|
|
6220
|
+
ariaMultiLine: string | null;
|
|
6221
|
+
ariaMultiSelectable: string | null;
|
|
6222
|
+
ariaOrientation: string | null;
|
|
6223
|
+
ariaOwnsElements: ReadonlyArray<Element> | null;
|
|
6224
|
+
ariaPlaceholder: string | null;
|
|
6225
|
+
ariaPosInSet: string | null;
|
|
6226
|
+
ariaPressed: string | null;
|
|
6227
|
+
ariaReadOnly: string | null;
|
|
6228
|
+
ariaRelevant: string | null;
|
|
6229
|
+
ariaRequired: string | null;
|
|
6230
|
+
ariaRoleDescription: string | null;
|
|
6231
|
+
ariaRowCount: string | null;
|
|
6232
|
+
ariaRowIndex: string | null;
|
|
6233
|
+
ariaRowIndexText: string | null;
|
|
6234
|
+
ariaRowSpan: string | null;
|
|
6235
|
+
ariaSelected: string | null;
|
|
6236
|
+
ariaSetSize: string | null;
|
|
6237
|
+
ariaSort: string | null;
|
|
6238
|
+
ariaValueMax: string | null;
|
|
6239
|
+
ariaValueMin: string | null;
|
|
6240
|
+
ariaValueNow: string | null;
|
|
6241
|
+
ariaValueText: string | null;
|
|
6242
|
+
role: string | null;
|
|
6243
|
+
animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation;
|
|
6244
|
+
getAnimations(options?: GetAnimationsOptions): Animation[];
|
|
6245
|
+
after(...nodes: (Node | string)[]): void;
|
|
6246
|
+
before(...nodes: (Node | string)[]): void;
|
|
6247
|
+
remove(): void;
|
|
6248
|
+
replaceWith(...nodes: (Node | string)[]): void;
|
|
6249
|
+
readonly nextElementSibling: Element | null;
|
|
6250
|
+
readonly previousElementSibling: Element | null;
|
|
6251
|
+
readonly childElementCount: number;
|
|
6252
|
+
readonly children: HTMLCollection;
|
|
6253
|
+
readonly firstElementChild: Element | null;
|
|
6254
|
+
readonly lastElementChild: Element | null;
|
|
6255
|
+
append(...nodes: (Node | string)[]): void;
|
|
6256
|
+
prepend(...nodes: (Node | string)[]): void;
|
|
6257
|
+
querySelector<K extends keyof HTMLElementTagNameMap>(selectors: K): HTMLElementTagNameMap[K] | null;
|
|
6258
|
+
querySelector<K extends keyof SVGElementTagNameMap>(selectors: K): SVGElementTagNameMap[K] | null;
|
|
6259
|
+
querySelector<K extends keyof MathMLElementTagNameMap>(selectors: K): MathMLElementTagNameMap[K] | null;
|
|
6260
|
+
querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): HTMLElementDeprecatedTagNameMap[K] | null;
|
|
6261
|
+
querySelector<E extends Element = Element>(selectors: string): E | null;
|
|
6262
|
+
querySelectorAll<K extends keyof HTMLElementTagNameMap>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>;
|
|
6263
|
+
querySelectorAll<K extends keyof SVGElementTagNameMap>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>;
|
|
6264
|
+
querySelectorAll<K extends keyof MathMLElementTagNameMap>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>;
|
|
6265
|
+
querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
|
|
6266
|
+
querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>;
|
|
6267
|
+
replaceChildren(...nodes: (Node | string)[]): void;
|
|
6268
|
+
readonly assignedSlot: HTMLSlotElement | null;
|
|
6269
|
+
readonly attributeStyleMap: StylePropertyMap;
|
|
6270
|
+
get style(): CSSStyleDeclaration;
|
|
6271
|
+
set style(cssText: string): any;
|
|
6272
|
+
contentEditable: string;
|
|
6273
|
+
enterKeyHint: string;
|
|
6274
|
+
inputMode: string;
|
|
6275
|
+
readonly isContentEditable: boolean;
|
|
6276
|
+
onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
|
|
6277
|
+
onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
|
|
6278
|
+
onanimationend: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
|
|
6279
|
+
onanimationiteration: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
|
|
6280
|
+
onanimationstart: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
|
|
6281
|
+
onauxclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6282
|
+
onbeforeinput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null;
|
|
6283
|
+
onbeforematch: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6284
|
+
onbeforetoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;
|
|
6285
|
+
onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
|
|
6286
|
+
oncancel: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6287
|
+
oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6288
|
+
oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6289
|
+
onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6290
|
+
onclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6291
|
+
onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6292
|
+
oncontextlost: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6293
|
+
oncontextmenu: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6294
|
+
oncontextrestored: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6295
|
+
oncopy: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
|
|
6296
|
+
oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6297
|
+
oncut: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
|
|
6298
|
+
ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6299
|
+
ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6300
|
+
ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6301
|
+
ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6302
|
+
ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6303
|
+
ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6304
|
+
ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6305
|
+
ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
|
|
6306
|
+
ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6307
|
+
onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6308
|
+
onended: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6309
|
+
onerror: OnErrorEventHandler;
|
|
6310
|
+
onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
|
|
6311
|
+
onformdata: ((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null;
|
|
6312
|
+
ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6313
|
+
oninput: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6314
|
+
oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6315
|
+
onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
|
|
6316
|
+
onkeypress: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
|
|
6317
|
+
onkeyup: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
|
|
6318
|
+
onload: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6319
|
+
onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6320
|
+
onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6321
|
+
onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6322
|
+
onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6323
|
+
onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6324
|
+
onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6325
|
+
onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6326
|
+
onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6327
|
+
onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6328
|
+
onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6329
|
+
onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
|
|
6330
|
+
onpaste: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
|
|
6331
|
+
onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6332
|
+
onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6333
|
+
onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6334
|
+
onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6335
|
+
onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6336
|
+
onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6337
|
+
onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6338
|
+
onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6339
|
+
onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6340
|
+
onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6341
|
+
onpointerrawupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6342
|
+
onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
|
|
6343
|
+
onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null;
|
|
6344
|
+
onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6345
|
+
onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6346
|
+
onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
|
|
6347
|
+
onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6348
|
+
onscrollend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6349
|
+
onsecuritypolicyviolation: ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null;
|
|
6350
|
+
onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6351
|
+
onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6352
|
+
onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6353
|
+
onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6354
|
+
onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6355
|
+
onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6356
|
+
onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6357
|
+
onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null;
|
|
6358
|
+
onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6359
|
+
ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6360
|
+
ontoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;
|
|
6361
|
+
ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
|
|
6362
|
+
ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
|
|
6363
|
+
ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
|
|
6364
|
+
ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
|
|
6365
|
+
ontransitioncancel: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
|
|
6366
|
+
ontransitionend: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
|
|
6367
|
+
ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
|
|
6368
|
+
ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
|
|
6369
|
+
onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6370
|
+
onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6371
|
+
onwebkitanimationend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6372
|
+
onwebkitanimationiteration: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6373
|
+
onwebkitanimationstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6374
|
+
onwebkittransitionend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
|
|
6375
|
+
onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null;
|
|
6376
|
+
autofocus: boolean;
|
|
6377
|
+
readonly dataset: DOMStringMap;
|
|
6378
|
+
nonce?: string;
|
|
6379
|
+
tabIndex: number;
|
|
6380
|
+
blur(): void;
|
|
6381
|
+
focus(options?: FocusOptions): void;
|
|
6382
|
+
}) & typeof FoundationElement;
|
|
6383
|
+
|
|
6384
|
+
/**
|
|
6385
|
+
* Chrome for {@link GridProSideBar}. Uses class selectors (no `:host`) because the
|
|
6386
|
+
* element has no shadow — styles land on Grid Pro's shadow root.
|
|
6387
|
+
* @public
|
|
6388
|
+
*/
|
|
6389
|
+
export declare const gridProSideBarChromeStyles: ElementStyles;
|
|
6390
|
+
|
|
6391
|
+
/**
|
|
6392
|
+
* Built-in Columns picker (Community, no AG SideBarModule).
|
|
6393
|
+
* @public
|
|
6394
|
+
*/
|
|
6395
|
+
export declare const gridProSideBarColumnsTool: GridProSideBarToolDef;
|
|
6396
|
+
|
|
6397
|
+
/**
|
|
6398
|
+
* Side bar configuration for {@link GridProBeta}.
|
|
6399
|
+
* Set on the grid to enable the Community side-bar shell; omit for no side bar.
|
|
6400
|
+
* @public
|
|
6401
|
+
*/
|
|
6402
|
+
export declare interface GridProSideBarConfig {
|
|
6403
|
+
/** Tool tabs (Columns, Filters, custom `IToolPanelComp`, etc.). */
|
|
6404
|
+
tools?: GridProSideBarToolDef[];
|
|
6405
|
+
}
|
|
6406
|
+
|
|
6407
|
+
/**
|
|
6408
|
+
* Built-in AG Filters tool (Enterprise `FiltersToolPanelModule` required at app register).
|
|
6409
|
+
* @public
|
|
6410
|
+
*/
|
|
6411
|
+
export declare const gridProSideBarFiltersTool: GridProSideBarToolDef;
|
|
6412
|
+
|
|
6413
|
+
/**
|
|
6414
|
+
* Layout on the Grid Pro host when `sideBarConfig` is set.
|
|
6415
|
+
* @public
|
|
6416
|
+
*/
|
|
6417
|
+
export declare const gridProSideBarHostStyles: ElementStyles;
|
|
6418
|
+
|
|
6419
|
+
/**
|
|
6420
|
+
* Host + chrome. Prefer {@link gridProSideBarHostStyles} on Grid Pro and
|
|
6421
|
+
* {@link gridProSideBarChromeStyles} on the side-bar element.
|
|
6422
|
+
* @public
|
|
6423
|
+
*/
|
|
6424
|
+
export declare const gridProSideBarStyles: ElementStyles;
|
|
6425
|
+
|
|
6426
|
+
/**
|
|
6427
|
+
* @public
|
|
6428
|
+
*/
|
|
6429
|
+
export declare const gridProSideBarTemplate: ViewTemplate<GridProSideBar, any>;
|
|
6430
|
+
|
|
6431
|
+
/**
|
|
6432
|
+
* Well-known Community side-bar tool ids.
|
|
6433
|
+
* @public
|
|
6434
|
+
*/
|
|
6435
|
+
export declare const GridProSideBarTool: {
|
|
6436
|
+
readonly columns: "columns";
|
|
6437
|
+
readonly filters: "filters";
|
|
6438
|
+
};
|
|
6439
|
+
|
|
6440
|
+
/**
|
|
6441
|
+
* Tool definition for the Community Grid Pro side bar shell.
|
|
6442
|
+
*
|
|
6443
|
+
* - `createPanel`: local `IToolPanelComp` (no AG SideBar chrome); preferred for custom / Genesis panels.
|
|
6444
|
+
* - `toolPanel`: AG registered name or component class (e.g. `'agFiltersToolPanel'` or a custom
|
|
6445
|
+
* class from https://www.ag-grid.com/javascript-data-grid/component-tool-panel/); mounted via
|
|
6446
|
+
* `api.openToolPanel(id, host)` with AG sideBar `hideButtons`.
|
|
6447
|
+
*
|
|
6448
|
+
* @public
|
|
6449
|
+
*/
|
|
6450
|
+
export declare interface GridProSideBarToolDef {
|
|
6451
|
+
id: GridProSideBarToolId;
|
|
6452
|
+
label: string;
|
|
6453
|
+
/** Localisation key for AG toolPanels; defaults to `id`. */
|
|
6454
|
+
labelKey?: string;
|
|
6455
|
+
/** AG icon key (`columns`, `filter`, …). Shown on the tab; also passed to AG `toolPanels`. */
|
|
6456
|
+
iconKey?: string;
|
|
6457
|
+
/**
|
|
6458
|
+
* AG tool panel component (`agFiltersToolPanel`, custom class, etc.).
|
|
6459
|
+
* Requires `SideBarModule` (pulled in by Filters / Enterprise modules).
|
|
6460
|
+
*/
|
|
6461
|
+
toolPanel?: any;
|
|
6462
|
+
/** Params passed to the AG / custom tool panel (e.g. `{ sort: 'ag-grid' }` for columns). */
|
|
6463
|
+
toolPanelParams?: any;
|
|
6464
|
+
/**
|
|
6465
|
+
* Factory for a locally mounted IToolPanelComp.
|
|
6466
|
+
* When set, the panel is created/mounted in our host (does not use `openToolPanel`).
|
|
6467
|
+
*/
|
|
6468
|
+
createPanel?: () => IToolPanelComp;
|
|
6469
|
+
}
|
|
6470
|
+
|
|
6471
|
+
/**
|
|
6472
|
+
* @public
|
|
6473
|
+
*/
|
|
6474
|
+
export declare type GridProSideBarToolId = (typeof GridProSideBarTool)[keyof typeof GridProSideBarTool] | (string & {});
|
|
6475
|
+
|
|
6476
|
+
/**
|
|
6477
|
+
* Configuration options for the grid status bar components
|
|
6478
|
+
* @public
|
|
6479
|
+
* @remarks
|
|
6480
|
+
* This requires AG Grid Enterprise module to be enabled.
|
|
6481
|
+
* Status bar components will only be displayed if the Enterprise module is available.
|
|
6482
|
+
* @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
|
|
6483
|
+
*/
|
|
6484
|
+
export declare interface GridProStatusBarConfig {
|
|
6485
|
+
/**
|
|
6486
|
+
* Enable row count status bar component.
|
|
6487
|
+
* @remarks Default is false.
|
|
6488
|
+
*/
|
|
6489
|
+
rows?: boolean;
|
|
6490
|
+
/**
|
|
6491
|
+
* Enable max rows status bar component.
|
|
6492
|
+
* @remarks Default is false.
|
|
6493
|
+
*/
|
|
6494
|
+
maxRows?: boolean;
|
|
6495
|
+
/**
|
|
6496
|
+
* Configure load more button status bar component.
|
|
6497
|
+
* @remarks Can be boolean for simple enable/disable or object for detailed configuration.
|
|
6498
|
+
*/
|
|
6499
|
+
loadMore?: boolean | GridProStatusBarLoadMoreConfig;
|
|
6500
|
+
/**
|
|
6501
|
+
* Configure reload button status bar component.
|
|
6502
|
+
* @remarks Can be boolean for simple enable/disable or object for detailed configuration.
|
|
6503
|
+
*/
|
|
6504
|
+
reload?: boolean | GridProStatusBarReloadConfig;
|
|
6505
|
+
/**
|
|
6506
|
+
* Enable aggregation status bar component.
|
|
6507
|
+
* @remarks Default is true. Shows aggregation values for selected columns.
|
|
6508
|
+
*/
|
|
6509
|
+
aggregation?: boolean;
|
|
6510
|
+
}
|
|
6511
|
+
|
|
6512
|
+
/**
|
|
6513
|
+
* Configuration for the label-value status bar component
|
|
6514
|
+
* @public
|
|
6515
|
+
*/
|
|
6516
|
+
export declare interface GridProStatusBarLabelConfig {
|
|
6517
|
+
/**
|
|
6518
|
+
* The label text to display
|
|
6519
|
+
*/
|
|
6520
|
+
label: string;
|
|
6521
|
+
/**
|
|
6522
|
+
* The value to display
|
|
6523
|
+
*/
|
|
6524
|
+
value: any;
|
|
6525
|
+
/**
|
|
6526
|
+
* Whether to hide the status bar component
|
|
6527
|
+
* @remarks Default is false.
|
|
6528
|
+
*/
|
|
6529
|
+
hide?: boolean;
|
|
6530
|
+
}
|
|
6531
|
+
|
|
6532
|
+
/**
|
|
6533
|
+
* Configuration options for load more status bar component
|
|
6534
|
+
* @public
|
|
6535
|
+
*/
|
|
6536
|
+
export declare interface GridProStatusBarLoadMoreConfig {
|
|
6537
|
+
/**
|
|
6538
|
+
* Custom callback function to execute when the action is triggered.
|
|
6539
|
+
* If not provided, the component will use the default datasource behavior.
|
|
6540
|
+
*/
|
|
6541
|
+
onLoadMore?: () => void;
|
|
6542
|
+
/**
|
|
6543
|
+
* Custom appearance for the button.
|
|
6544
|
+
* @remarks Options: 'accent', 'lightweight', 'neutral', 'outline', 'stealth'
|
|
6545
|
+
*/
|
|
6546
|
+
appearance?: string;
|
|
6547
|
+
/**
|
|
6548
|
+
* Custom tooltip text that appears on hover.
|
|
6549
|
+
* @remarks Default is 'Load More'.
|
|
6550
|
+
*/
|
|
6551
|
+
tooltip?: string;
|
|
6552
|
+
}
|
|
6553
|
+
|
|
6554
|
+
/**
|
|
6555
|
+
* Configuration options for reload status bar component
|
|
6556
|
+
* @public
|
|
6557
|
+
*/
|
|
6558
|
+
export declare interface GridProStatusBarReloadConfig {
|
|
6559
|
+
/**
|
|
6560
|
+
* Custom callback function to execute when the action is triggered.
|
|
6561
|
+
* If not provided, the component will use the default datasource behavior.
|
|
6562
|
+
*/
|
|
6563
|
+
onReload?: () => void;
|
|
6564
|
+
/**
|
|
6565
|
+
* Custom FontAwesome icon name (without 'fa-' prefix).
|
|
6566
|
+
* @remarks Default is 'refresh'.
|
|
6567
|
+
*/
|
|
6568
|
+
icon?: string;
|
|
6569
|
+
/**
|
|
6570
|
+
* Custom tooltip text that appears on hover.
|
|
6571
|
+
* @remarks Default is 'Reload'.
|
|
6572
|
+
*/
|
|
6573
|
+
tooltip?: string;
|
|
6574
|
+
}
|
|
6575
|
+
|
|
6576
|
+
/**
|
|
6577
|
+
* The available Grid Pro Status Bar Types
|
|
6578
|
+
* @public
|
|
6579
|
+
* @remarks
|
|
6580
|
+
* These status bar components require AG Grid Enterprise module to be enabled.
|
|
6581
|
+
* Status bar components will only be displayed if the Enterprise module is available.
|
|
6582
|
+
* @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
|
|
6583
|
+
*/
|
|
6584
|
+
export declare enum GridProStatusBarTypes {
|
|
6585
|
+
labelValue = "labelValue",
|
|
6586
|
+
loadMore = "loadMore",
|
|
6587
|
+
reload = "reload",
|
|
6588
|
+
rowCount = "rowCount"
|
|
6589
|
+
}
|
|
6590
|
+
|
|
6591
|
+
/**
|
|
6592
|
+
*
|
|
6593
|
+
* @public
|
|
6594
|
+
* @remarks
|
|
6595
|
+
* HTML Element: <foundation-grid-pro>
|
|
6596
|
+
*/
|
|
6597
|
+
export declare const gridProTemplate: ViewTemplate;
|
|
6598
|
+
|
|
6599
|
+
/**
|
|
6600
|
+
* Custom Grid Pro tool panel component names.
|
|
6601
|
+
* @public
|
|
6602
|
+
* @remarks
|
|
6603
|
+
* Registered for AG `sideBar` hosts (`SideBarModule` still required for that path).
|
|
6604
|
+
* Prefer `sideBarConfig` on {@link GridProBeta} for a Community-only columns UI.
|
|
6605
|
+
*/
|
|
6606
|
+
export declare enum GridProToolPanelTypes {
|
|
6607
|
+
columns = "gridProColumnsToolPanel"
|
|
6608
|
+
}
|
|
6609
|
+
|
|
6610
|
+
/**
|
|
6611
|
+
* Event detail for the `gridReady`/`onGridReady` signals.
|
|
6612
|
+
* @public
|
|
6613
|
+
* @remarks Only accurate for {@link @genesislcap/grid-pro#GridProBeta}, which is built on
|
|
6614
|
+
* `ag-grid-community` (v36). {@link @genesislcap/grid-pro#GridPro} fires the same event names
|
|
6615
|
+
* but its `event` field is a `@ag-grid-community/core` (v29) `GridReadyEvent`.
|
|
6616
|
+
*/
|
|
6617
|
+
export declare interface GridReadyEventDetail {
|
|
6618
|
+
event: GridReadyEvent;
|
|
6619
|
+
gridId: string;
|
|
6620
|
+
}
|
|
6621
|
+
|
|
6622
|
+
/**
|
|
6623
|
+
* The change size event grid pro genesis datasource.
|
|
6624
|
+
* @public
|
|
6625
|
+
*/
|
|
6626
|
+
export declare type GrigProGenesisDatasourceSizeChangedEvent = CustomEvent<GrigProGenesisDatasourceSizeChangedEventDetail>;
|
|
6627
|
+
|
|
6628
|
+
/**
|
|
6629
|
+
* The event detail for the grid pro genesis datasource `sizeChanged` event.
|
|
6630
|
+
* @public
|
|
6631
|
+
*/
|
|
6632
|
+
export declare type GrigProGenesisDatasourceSizeChangedEventDetail = {
|
|
5863
6633
|
value: number;
|
|
5864
6634
|
oldValue: number;
|
|
5865
6635
|
};
|
|
@@ -5960,6 +6730,11 @@ export declare interface InitializeEventDetail {
|
|
|
5960
6730
|
};
|
|
5961
6731
|
}
|
|
5962
6732
|
|
|
6733
|
+
/**
|
|
6734
|
+
* @internal
|
|
6735
|
+
*/
|
|
6736
|
+
export declare function initLocalSideBarPanel(panel: IToolPanelComp, params: IToolPanelParams): IToolPanelComp;
|
|
6737
|
+
|
|
5963
6738
|
/**
|
|
5964
6739
|
* Implementation for the KV Storage State Persistence interface.
|
|
5965
6740
|
* @public
|
|
@@ -6105,6 +6880,15 @@ export declare type MoreRowsDetail = {
|
|
|
6105
6880
|
sourceRef: string;
|
|
6106
6881
|
};
|
|
6107
6882
|
|
|
6883
|
+
/**
|
|
6884
|
+
* @internal
|
|
6885
|
+
*/
|
|
6886
|
+
export declare type MountedSideBarPanel = {
|
|
6887
|
+
defId: string;
|
|
6888
|
+
panel: IToolPanelComp;
|
|
6889
|
+
destroy?: () => void;
|
|
6890
|
+
};
|
|
6891
|
+
|
|
6108
6892
|
/**
|
|
6109
6893
|
* @beta
|
|
6110
6894
|
* A dropdown component that displays its options in a multi-column AG Grid.
|
|
@@ -6676,6 +7460,32 @@ export declare enum OperationType {
|
|
|
6676
7460
|
/** The CSS class to use for the options element's class in the dropdown */
|
|
6677
7461
|
export declare const optionsClass = "options";
|
|
6678
7462
|
|
|
7463
|
+
/**
|
|
7464
|
+
* Column order for the picker list.
|
|
7465
|
+
*
|
|
7466
|
+
* - `selected-first` (default): displayed columns first (current grid visual order), then
|
|
7467
|
+
* any non-displayed columns in `getColumns()` order (caller alphabetizes hidden via
|
|
7468
|
+
* {@link partitionPickerItems}).
|
|
7469
|
+
* - `ag-grid`: current column-state order (`getColumnState`), visible and hidden interleaved —
|
|
7470
|
+
* same live order AG's columns tool panel reflects after moves. Falls back to `getColumns()`
|
|
7471
|
+
* when state is empty.
|
|
7472
|
+
*/
|
|
7473
|
+
export declare function orderColumnsForPicker(displayed: Column[], all: Column[], sort?: GridProColumnsToolPanelSort, columnState?: ReadonlyArray<{
|
|
7474
|
+
colId?: string | null;
|
|
7475
|
+
}>): Column[];
|
|
7476
|
+
|
|
7477
|
+
/**
|
|
7478
|
+
* Splits / filters picker items for the template sections.
|
|
7479
|
+
*
|
|
7480
|
+
* - `selected-first`: visible rows in input order; hidden rows A–Z by header.
|
|
7481
|
+
* - `ag-grid`: one flat list in input order (AG column-model order) in `selected`;
|
|
7482
|
+
* `unselected` is empty so the template does not re-group.
|
|
7483
|
+
*/
|
|
7484
|
+
export declare function partitionPickerItems(items: ColumnPickerItem[], search: string, sort?: GridProColumnsToolPanelSort): {
|
|
7485
|
+
selected: ColumnPickerItem[];
|
|
7486
|
+
unselected: ColumnPickerItem[];
|
|
7487
|
+
};
|
|
7488
|
+
|
|
6679
7489
|
/**
|
|
6680
7490
|
* Event detail for requesting a server-side row model refresh.
|
|
6681
7491
|
*/
|
|
@@ -6719,6 +7529,30 @@ export declare type ReloadStatusBarParams = {
|
|
|
6719
7529
|
tooltip?: string;
|
|
6720
7530
|
};
|
|
6721
7531
|
|
|
7532
|
+
export declare function reorderVisibleIds(allVisibleIds: string[], shownIds: string[], fromId: string, toId: string): string[] | null;
|
|
7533
|
+
|
|
7534
|
+
/** @internal Clears shared preference stores between tests. */
|
|
7535
|
+
export declare function resetRowAlertPreferenceStoresForTesting(): void;
|
|
7536
|
+
|
|
7537
|
+
/**
|
|
7538
|
+
* @internal
|
|
7539
|
+
*/
|
|
7540
|
+
export declare function resolveAgSideBarToolPanels(tools: ReadonlyArray<GridProSideBarToolDef>): {
|
|
7541
|
+
toolPanelParams?: any;
|
|
7542
|
+
id: GridProSideBarToolId;
|
|
7543
|
+
labelKey: string;
|
|
7544
|
+
labelDefault: string;
|
|
7545
|
+
iconKey: string;
|
|
7546
|
+
toolPanel: any;
|
|
7547
|
+
}[];
|
|
7548
|
+
|
|
7549
|
+
export declare function resolveColumnsToolPanelSort(sort?: GridProColumnsToolPanelSort | null): GridProColumnsToolPanelSort;
|
|
7550
|
+
|
|
7551
|
+
/**
|
|
7552
|
+
* Rewrites `sideBar: ['columns']` / `agColumnsToolPanel` to the custom Grid Pro picker.
|
|
7553
|
+
*/
|
|
7554
|
+
export declare function resolveGridProSideBar(sideBar: GridOptions['sideBar']): GridOptions['sideBar'];
|
|
7555
|
+
|
|
6722
7556
|
/**
|
|
6723
7557
|
* Resolves the field names of the currently visible columns.
|
|
6724
7558
|
* @remarks Prefers the grid's displayed columns (`getAllDisplayedColumns()` — already excludes
|
|
@@ -7283,6 +8117,8 @@ export declare const textFieldRendererStyles: ElementStyles;
|
|
|
7283
8117
|
*/
|
|
7284
8118
|
export declare const textRendererStyles: ElementStyles;
|
|
7285
8119
|
|
|
8120
|
+
export declare function toPickerItem(col: Column): ColumnPickerItem | null;
|
|
8121
|
+
|
|
7286
8122
|
/**
|
|
7287
8123
|
* @public
|
|
7288
8124
|
*/
|