@genesislcap/grid-pro 14.200.1-alpha-e974201.0 → 14.202.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +117 -111
- package/dist/custom-elements.json +2750 -840
- package/dist/dts/cell-renderers/boolean.renderer.d.ts.map +1 -1
- package/dist/dts/datasource/base.datasource.d.ts +22 -6
- package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
- package/dist/dts/datasource/base.types.d.ts +22 -0
- package/dist/dts/datasource/base.types.d.ts.map +1 -0
- package/dist/dts/datasource/server-side.datasource.d.ts +27 -83
- package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
- package/dist/dts/datasource/server-side.grid-definitions.d.ts.map +1 -1
- package/dist/dts/datasource/server-side.resource-base.d.ts +55 -0
- package/dist/dts/datasource/server-side.resource-base.d.ts.map +1 -0
- package/dist/dts/datasource/server-side.resource-dataserver.d.ts +20 -0
- package/dist/dts/datasource/server-side.resource-dataserver.d.ts.map +1 -0
- package/dist/dts/datasource/server-side.resource-reqrep.d.ts +17 -0
- package/dist/dts/datasource/server-side.resource-reqrep.d.ts.map +1 -0
- package/dist/dts/external/index.d.ts +0 -1
- package/dist/dts/external/index.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +13 -13
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +33 -33
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/grid-pro.template.d.ts.map +1 -1
- package/dist/esm/cell-renderers/boolean.renderer.js +7 -6
- package/dist/esm/datasource/base.datasource.js +79 -10
- package/dist/esm/datasource/base.types.js +1 -0
- package/dist/esm/datasource/client-side.grid-definitions.js +1 -1
- package/dist/esm/datasource/server-side.datasource.js +224 -400
- package/dist/esm/datasource/server-side.grid-definitions.js +42 -7
- package/dist/esm/datasource/server-side.resource-base.js +285 -0
- package/dist/esm/datasource/server-side.resource-dataserver.js +132 -0
- package/dist/esm/datasource/server-side.resource-reqrep.js +131 -0
- package/dist/esm/external/index.js +0 -5
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +65 -69
- package/dist/esm/grid-pro.js +30 -44
- package/dist/esm/grid-pro.template.js +2 -1
- package/dist/grid-pro.api.json +90 -149
- package/dist/grid-pro.d.ts +94 -142
- package/docs/api/grid-pro.gridpro.addeventlistener.md +2 -2
- package/docs/api/grid-pro.gridpro.aggrid.md +11 -0
- package/docs/api/grid-pro.gridpro.applytemplatedefinitions.md +2 -2
- package/docs/api/grid-pro.gridpro.columnapi.md +11 -0
- package/docs/api/grid-pro.gridpro.gridapi.md +1 -1
- package/docs/api/grid-pro.gridpro.md +5 -3
- package/docs/api/grid-pro.gridpro.mergeallcolumndefsandstates.md +2 -2
- package/docs/api/grid-pro.gridpro.themechanged.md +2 -2
- package/docs/api/grid-pro.gridprogenesisdatasource.deinit.md +5 -0
- package/docs/api/{grid-pro.gridprogenesisdatasource.auth.md → grid-pro.gridprogenesisdatasource.destroy.md} +9 -3
- package/docs/api/grid-pro.gridprogenesisdatasource.handleerrors.md +2 -2
- package/docs/api/grid-pro.gridprogenesisdatasource.md +2 -6
- package/docs/api/grid-pro.gridprogenesisdatasource.reset.md +1 -1
- package/docs/api-report.md +30 -73
- package/package.json +16 -16
- package/docs/api/grid-pro.gridprogenesisdatasource.datasource.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.disablepolling.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.pollinginterval.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.request.md +0 -11
package/dist/grid-pro.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { ActionMenuItem } from '@genesislcap/foundation-ui';
|
|
2
|
-
import {
|
|
2
|
+
import { BehaviorSubject } from 'rxjs';
|
|
3
3
|
import { Binding } from '@microsoft/fast-element';
|
|
4
4
|
import { CaptureType } from '@microsoft/fast-element';
|
|
5
5
|
import { ColDef } from '@ag-grid-community/core';
|
|
6
|
+
import type { ColumnApi } from '@ag-grid-community/core';
|
|
6
7
|
import { ColumnState } from '@ag-grid-community/core';
|
|
7
8
|
import { Connect } from '@genesislcap/foundation-comms';
|
|
8
9
|
import type { Container } from '@microsoft/fast-foundation';
|
|
@@ -17,10 +18,10 @@ import { DatasourceStatusChangedEvent } from '@genesislcap/foundation-comms';
|
|
|
17
18
|
import { DOMContainer } from '@genesislcap/foundation-utils';
|
|
18
19
|
import { ElementStyles } from '@microsoft/fast-element';
|
|
19
20
|
import { FieldMetadata } from '@genesislcap/foundation-comms';
|
|
20
|
-
import { FilteredDataServerResult } from '@genesislcap/foundation-comms';
|
|
21
21
|
import { FoundationElement } from '@microsoft/fast-foundation';
|
|
22
22
|
import { FoundationElementRegistry } from '@microsoft/fast-foundation';
|
|
23
23
|
import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
|
|
24
|
+
import { Grid } from '@ag-grid-community/core';
|
|
24
25
|
import type { GridApi } from '@ag-grid-community/core';
|
|
25
26
|
import { GridOptions } from '@ag-grid-community/core';
|
|
26
27
|
import type { GridParams } from '@ag-grid-community/core';
|
|
@@ -30,23 +31,19 @@ import { ICellRendererComp } from '@ag-grid-community/core';
|
|
|
30
31
|
import { ICellRendererFunc } from '@ag-grid-community/core';
|
|
31
32
|
import { ICellRendererParams } from '@ag-grid-community/core';
|
|
32
33
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
33
|
-
import
|
|
34
|
-
import type { IServerSideGetRowsParams } from '@ag-grid-community/core';
|
|
35
|
-
import type { IServerSideRowModel } from '@ag-grid-community/core';
|
|
34
|
+
import { IServerSideRowModel } from '@ag-grid-community/core';
|
|
36
35
|
import { ITooltipComp } from '@ag-grid-community/core';
|
|
37
36
|
import { ITooltipParams } from '@ag-grid-community/core';
|
|
38
37
|
import { KVStorage } from '@genesislcap/foundation-comms';
|
|
39
38
|
import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
|
|
40
39
|
import { Logger } from '@genesislcap/foundation-logger';
|
|
41
|
-
import { MetadataDetail } from '@genesislcap/foundation-comms';
|
|
42
40
|
import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
|
|
43
|
-
import
|
|
44
|
-
import
|
|
41
|
+
import { PaginationChangedEvent } from '@ag-grid-community/core';
|
|
42
|
+
import { RowDataTransaction } from '@ag-grid-community/core';
|
|
43
|
+
import { RowNodeTransaction } from '@ag-grid-community/core';
|
|
45
44
|
import type { ServerSideTransaction } from '@ag-grid-community/core';
|
|
46
|
-
import
|
|
45
|
+
import { ServerSideTransactionResult } from '@ag-grid-community/core';
|
|
47
46
|
import { Session } from '@genesislcap/foundation-comms';
|
|
48
|
-
import { SocketObservable } from '@genesislcap/foundation-comms';
|
|
49
|
-
import { SocketSubscription } from '@genesislcap/foundation-comms';
|
|
50
47
|
import { Swatch } from '@microsoft/fast-components';
|
|
51
48
|
import { SwatchRGB } from '@microsoft/fast-components';
|
|
52
49
|
import { TextField } from '@genesislcap/foundation-ui';
|
|
@@ -134,7 +131,7 @@ export declare class ActionsMenuRenderer extends FoundationElement implements IC
|
|
|
134
131
|
* @privateRemarks We're excluding rowData as it's a special case that we handle separately
|
|
135
132
|
* @internal
|
|
136
133
|
*/
|
|
137
|
-
export declare const AG_PROPERTIES: (
|
|
134
|
+
export declare const AG_PROPERTIES: ("datasource" | "onGridReady" | "tabIndex" | "api" | "columnApi" | "context" | "columnDefs" | "pagination" | "rowData" | "headerHeight" | "rowHeight" | "icons" | "singleClickEdit" | "onCellValueChanged" | "onCellClicked" | "onCellDoubleClicked" | "onCellContextMenu" | "enableCellChangeFlash" | "rowDragText" | "sortingOrder" | "unSortIcon" | "suppressAutoSize" | "statusBar" | "sideBar" | "suppressContextMenu" | "preventDefaultOnContextMenu" | "allowContextMenuWithControlKey" | "suppressMenuHide" | "enableBrowserTooltips" | "tooltipShowDelay" | "tooltipHideDelay" | "tooltipMouseTrack" | "popupParent" | "copyHeadersToClipboard" | "copyGroupHeadersToClipboard" | "clipboardDeliminator" | "clipboardDelimiter" | "suppressCopyRowsToClipboard" | "suppressCopySingleCellRanges" | "suppressLastEmptyLineOnPaste" | "suppressClipboardPaste" | "suppressClipboardApi" | "suppressCutToClipboard" | "defaultColDef" | "defaultColGroupDef" | "columnTypes" | "maintainColumnOrder" | "suppressFieldDotNotation" | "groupHeaderHeight" | "floatingFiltersHeight" | "pivotHeaderHeight" | "pivotGroupHeaderHeight" | "allowDragFromColumnsToolPanel" | "suppressMovableColumns" | "suppressColumnMoveAnimation" | "suppressDragLeaveHidesColumns" | "suppressRowGroupHidesColumns" | "colResizeDefault" | "autoSizePadding" | "skipHeaderOnAutoSize" | "components" | "frameworkComponents" | "reactUi" | "suppressReactUi" | "editType" | "suppressClickEdit" | "readOnlyEdit" | "stopEditingWhenCellsLoseFocus" | "enterMovesDown" | "enterMovesDownAfterEdit" | "enableCellEditingOnBackspace" | "undoRedoCellEditing" | "undoRedoCellEditingLimit" | "defaultCsvExportParams" | "suppressCsvExport" | "defaultExcelExportParams" | "suppressExcelExport" | "excelStyles" | "quickFilterText" | "cacheQuickFilter" | "excludeHiddenColumnsFromQuickFilter" | "excludeChildrenWhenTreeDataFiltering" | "enableCharts" | "chartThemes" | "customChartThemes" | "chartThemeOverrides" | "enableChartToolPanelsButton" | "suppressChartToolPanelsButton" | "chartToolPanelsDef" | "loadingCellRenderer" | "loadingCellRendererFramework" | "loadingCellRendererParams" | "loadingCellRendererSelector" | "localeText" | "masterDetail" | "keepDetailRows" | "keepDetailRowsCount" | "detailCellRenderer" | "detailCellRendererFramework" | "detailCellRendererParams" | "detailRowHeight" | "detailRowAutoHeight" | "alignedGrids" | "rowBuffer" | "valueCache" | "valueCacheNeverExpires" | "enableCellExpressions" | "suppressParentsInRowNodes" | "suppressTouch" | "suppressFocusAfterRefresh" | "suppressAsyncEvents" | "suppressBrowserResizeObserver" | "suppressPropertyNamesCheck" | "suppressChangeDetection" | "debug" | "overlayLoadingTemplate" | "loadingOverlayComponent" | "loadingOverlayComponentFramework" | "loadingOverlayComponentParams" | "suppressLoadingOverlay" | "overlayNoRowsTemplate" | "noRowsOverlayComponent" | "noRowsOverlayComponentFramework" | "noRowsOverlayComponentParams" | "suppressNoRowsOverlay" | "paginationPageSize" | "paginationAutoPageSize" | "paginateChildRows" | "suppressPaginationPanel" | "pivotMode" | "pivotPanelShow" | "pivotColumnGroupTotals" | "pivotRowTotals" | "pivotSuppressAutoColumn" | "suppressExpandablePivotGroups" | "functionsReadOnly" | "aggFuncs" | "suppressAggFuncInHeader" | "suppressAggAtRootLevel" | "aggregateOnlyChangedColumns" | "suppressAggFilteredOnly" | "removePivotHeaderRowWhenSingleValueColumn" | "animateRows" | "cellFlashDelay" | "cellFadeDelay" | "allowShowChangeAfterFilter" | "domLayout" | "ensureDomOrder" | "enableRtl" | "suppressColumnVirtualisation" | "suppressMaxRenderedRowRestriction" | "suppressRowVirtualisation" | "rowDragManaged" | "suppressRowDrag" | "suppressMoveWhenRowDragging" | "rowDragEntireRow" | "rowDragMultiRow" | "fullWidthCellRenderer" | "fullWidthCellRendererFramework" | "fullWidthCellRendererParams" | "embedFullWidthRows" | "groupDisplayType" | "groupDefaultExpanded" | "autoGroupColumnDef" | "groupMaintainOrder" | "groupSelectsChildren" | "groupAggFiltering" | "groupIncludeFooter" | "groupIncludeTotalFooter" | "groupSuppressBlankHeader" | "groupSelectsFiltered" | "showOpenedGroup" | "groupRemoveSingleChildren" | "groupRemoveLowestSingleChildren" | "groupHideOpenParents" | "groupAllowUnbalanced" | "rowGroupPanelShow" | "groupRowRenderer" | "groupRowRendererFramework" | "groupRowRendererParams" | "suppressMakeColumnVisibleAfterUnGroup" | "treeData" | "rowGroupPanelSuppressSort" | "groupRowsSticky" | "rememberGroupStateWhenNewData" | "pinnedTopRowData" | "pinnedBottomRowData" | "rowModelType" | "immutableData" | "asyncTransactionWaitMillis" | "suppressModelUpdateAfterUpdateTransaction" | "cacheOverflowSize" | "infiniteInitialRowCount" | "serverSideInitialRowCount" | "serverSideStoreType" | "suppressServerSideInfiniteScroll" | "cacheBlockSize" | "maxBlocksInCache" | "maxConcurrentDatasourceRequests" | "blockLoadDebounceMillis" | "purgeClosedRowNodes" | "serverSideDatasource" | "serverSideSortAllLevels" | "serverSideFilterAllLevels" | "serverSideSortOnServer" | "serverSideFilterOnServer" | "serverSideSortingAlwaysResets" | "serverSideFilteringAlwaysResets" | "viewportDatasource" | "viewportRowModelPageSize" | "viewportRowModelBufferSize" | "alwaysShowHorizontalScroll" | "alwaysShowVerticalScroll" | "debounceVerticalScrollbar" | "suppressHorizontalScroll" | "suppressScrollOnNewData" | "suppressScrollWhenPopupsAreOpen" | "suppressAnimationFrame" | "suppressMiddleClickScrolls" | "suppressPreventDefaultOnMouseWheel" | "scrollbarWidth" | "rowSelection" | "rowMultiSelectWithClick" | "suppressRowDeselection" | "suppressRowClickSelection" | "suppressCellSelection" | "suppressCellFocus" | "suppressMultiRangeSelection" | "enableCellTextSelection" | "enableRangeSelection" | "enableRangeHandle" | "enableFillHandle" | "fillHandleDirection" | "suppressClearOnFillReduction" | "accentedSort" | "suppressMultiSort" | "alwaysMultiSort" | "multiSortKey" | "suppressMaintainUnsortedOrder" | "rowStyle" | "rowClass" | "rowClassRules" | "suppressRowHoverHighlight" | "suppressRowTransform" | "columnHoverHighlight" | "deltaSort" | "treeDataDisplayType" | "functionsPassive" | "enableGroupEdit" | "getContextMenuItems" | "getMainMenuItems" | "postProcessPopup" | "processCellForClipboard" | "processHeaderForClipboard" | "processGroupHeaderForClipboard" | "processCellFromClipboard" | "sendToClipboard" | "processDataFromClipboard" | "isExternalFilterPresent" | "doesExternalFilterPass" | "getChartToolbarItems" | "createChartContainer" | "navigateToNextHeader" | "tabToNextHeader" | "navigateToNextCell" | "tabToNextCell" | "localeTextFunc" | "getLocaleText" | "getDocument" | "paginationNumberFormatter" | "groupRowAggNodes" | "getGroupRowAgg" | "isGroupOpenByDefault" | "initialGroupOrderComparator" | "defaultGroupOrderComparator" | "processSecondaryColDef" | "processSecondaryColGroupDef" | "processPivotResultColDef" | "processPivotResultColGroupDef" | "getDataPath" | "getChildCount" | "getServerSideGroupLevelParams" | "getServerSideStoreParams" | "isServerSideGroupOpenByDefault" | "isApplyServerSideTransaction" | "isServerSideGroup" | "getServerSideGroupKey" | "getBusinessKeyForNode" | "getRowNodeId" | "getRowId" | "resetRowDataOnUpdate" | "processRowPostCreate" | "isRowSelectable" | "isRowMaster" | "fillOperation" | "postSort" | "postSortRows" | "getRowStyle" | "getRowClass" | "getRowHeight" | "isFullWidthCell" | "isFullWidthRow" | "onToolPanelVisibleChanged" | "onToolPanelSizeChanged" | "onPasteStart" | "onPasteEnd" | "onColumnVisible" | "onColumnPinned" | "onColumnResized" | "onColumnMoved" | "onColumnValueChanged" | "onColumnPivotModeChanged" | "onColumnPivotChanged" | "onColumnGroupOpened" | "onNewColumnsLoaded" | "onGridColumnsChanged" | "onDisplayedColumnsChanged" | "onVirtualColumnsChanged" | "onColumnEverythingChanged" | "onComponentStateChanged" | "onCellEditRequest" | "onRowValueChanged" | "onCellEditingStarted" | "onCellEditingStopped" | "onRowEditingStarted" | "onRowEditingStopped" | "onUndoStarted" | "onUndoEnded" | "onRedoStarted" | "onRedoEnded" | "onFilterOpened" | "onFilterChanged" | "onFilterModified" | "onChartCreated" | "onChartRangeSelectionChanged" | "onChartOptionsChanged" | "onChartDestroyed" | "onCellKeyDown" | "onCellKeyPress" | "onFirstDataRendered" | "onGridSizeChanged" | "onModelUpdated" | "onVirtualRowRemoved" | "onViewportChanged" | "onBodyScroll" | "onBodyScrollEnd" | "onDragStarted" | "onDragStopped" | "onPaginationChanged" | "onRowDragEnter" | "onRowDragMove" | "onRowDragLeave" | "onRowDragEnd" | "onColumnRowGroupChanged" | "onRowGroupOpened" | "onExpandOrCollapseAll" | "onPinnedRowDataChanged" | "onRowDataChanged" | "onRowDataUpdated" | "onAsyncTransactionsFlushed" | "onCellFocused" | "onCellMouseOver" | "onCellMouseOut" | "onCellMouseDown" | "onRowClicked" | "onRowDoubleClicked" | "onRowSelected" | "onSelectionChanged" | "onRangeSelectionChanged" | "onSortChanged" | "onColumnRowGroupChangeRequest" | "onColumnPivotChangeRequest" | "onColumnValueChangeRequest" | "onColumnAggFuncChangeRequest")[];
|
|
138
135
|
|
|
139
136
|
/**
|
|
140
137
|
* The AG Action Renderer Styles.
|
|
@@ -163,7 +160,6 @@ export declare const agEditableRendererStyles: ElementStyles;
|
|
|
163
160
|
/**
|
|
164
161
|
* All External AG Grid Stock in one CSS.
|
|
165
162
|
* @remarks This is a collection of multiple AG themes, only needed if the target element needs more than one stock theme.
|
|
166
|
-
* @privateRemarks See https://github.com/ag-grid/ag-grid/issues/7324 about the viewport scrollbar.
|
|
167
163
|
* @public
|
|
168
164
|
*/
|
|
169
165
|
export declare const agExternalStockStyles: ElementStyles;
|
|
@@ -977,6 +973,7 @@ declare interface FuiCellRendererParams extends ICellRendererParams {
|
|
|
977
973
|
|
|
978
974
|
declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base {
|
|
979
975
|
connect: Connect;
|
|
976
|
+
datasource: Datasource;
|
|
980
977
|
deferredGridOptions: GridOptions;
|
|
981
978
|
deferredColumnStates: ColumnState[];
|
|
982
979
|
/**
|
|
@@ -992,6 +989,16 @@ declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_
|
|
|
992
989
|
orderBy: string;
|
|
993
990
|
resourceName: string;
|
|
994
991
|
reverse: boolean;
|
|
992
|
+
viewNumber: number;
|
|
993
|
+
pollingInterval: number;
|
|
994
|
+
disablePolling: boolean;
|
|
995
|
+
request: any;
|
|
996
|
+
/**
|
|
997
|
+
* Attribute to set whether the REQUEST object should be automatically set up.
|
|
998
|
+
* @remarks Defaults to `true`. Only applies to REQUEST_SERVER (REQ-REP) resources.
|
|
999
|
+
* @privateRemarks To avoid breaking changes for now, once V15 is out this will be removed and the default behavior will be the same as `false` here.
|
|
1000
|
+
*/
|
|
1001
|
+
requestAutoSetup: boolean;
|
|
995
1002
|
/**
|
|
996
1003
|
* Attribute to set an unique identifier for the row.
|
|
997
1004
|
*
|
|
@@ -1006,7 +1013,13 @@ declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_
|
|
|
1006
1013
|
*/
|
|
1007
1014
|
protected get hasDefaultRowId(): boolean;
|
|
1008
1015
|
protected get defaultRowIdByResourceType(): string;
|
|
1009
|
-
protected
|
|
1016
|
+
protected criteriaFromFilters: Map<string, string>;
|
|
1017
|
+
protected update: BehaviorSubject<Map<string, string>>;
|
|
1018
|
+
protected datasourceOptions(): DatasourceOptions;
|
|
1019
|
+
private buildCriteria;
|
|
1020
|
+
setFilter(fieldName: string, newFilter: string): void;
|
|
1021
|
+
removeFilter(fieldName: string): void;
|
|
1022
|
+
get isRequestServer(): boolean;
|
|
1010
1023
|
datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
|
|
1011
1024
|
protected get agGrid(): GridPro | null;
|
|
1012
1025
|
}
|
|
@@ -1522,10 +1535,10 @@ export declare const GridOptionsConfig: InterfaceSymbol<GridOptionsConfig>;
|
|
|
1522
1535
|
* @tagname %%prefix%%-grid-pro
|
|
1523
1536
|
*/
|
|
1524
1537
|
export declare class GridPro extends GridPro_base {
|
|
1538
|
+
columnApi: ColumnApi;
|
|
1539
|
+
gridApi: GridApi;
|
|
1525
1540
|
gridErrorItems: GridProErrorItem<GridProErrorEvent['detail']>[];
|
|
1526
1541
|
statePersistence: StatePersistence;
|
|
1527
|
-
private _gridApi;
|
|
1528
|
-
get gridApi(): GridApi;
|
|
1529
1542
|
/**
|
|
1530
1543
|
* Timeout function used to debounce resize calls
|
|
1531
1544
|
* @internal
|
|
@@ -1598,8 +1611,9 @@ export declare class GridPro extends GridPro_base {
|
|
|
1598
1611
|
headerHeight: number;
|
|
1599
1612
|
rowHeight: number;
|
|
1600
1613
|
theme: string;
|
|
1601
|
-
themeChanged(
|
|
1614
|
+
themeChanged(oldValue: string, newValue: string): void;
|
|
1602
1615
|
classNames: string;
|
|
1616
|
+
agGrid: Grid;
|
|
1603
1617
|
gridSlot: HTMLSlotElement;
|
|
1604
1618
|
gridComponents: {
|
|
1605
1619
|
[componentName: string]: any;
|
|
@@ -1635,7 +1649,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
1635
1649
|
*/
|
|
1636
1650
|
gridOptionsConfig: GridOptionsConfig;
|
|
1637
1651
|
constructor();
|
|
1638
|
-
addEventListener(
|
|
1652
|
+
addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
|
|
1639
1653
|
private addGridEventListener;
|
|
1640
1654
|
private handleError;
|
|
1641
1655
|
hideDatasourceError(): void;
|
|
@@ -1658,7 +1672,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
1658
1672
|
/**
|
|
1659
1673
|
* Gets the saved grid ColumnState[] from storage
|
|
1660
1674
|
* @remarks This is used to restore the grid state when the grid is rehydrated
|
|
1661
|
-
* @privateRemarks Not using `
|
|
1675
|
+
* @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
|
|
1662
1676
|
* @public
|
|
1663
1677
|
*/
|
|
1664
1678
|
getSavedColumnState(): Promise<ColumnState[]>;
|
|
@@ -1689,7 +1703,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
1689
1703
|
* @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
|
|
1690
1704
|
* @returns The merged column definitions.
|
|
1691
1705
|
*/
|
|
1692
|
-
applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any
|
|
1706
|
+
applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
|
|
1693
1707
|
/**
|
|
1694
1708
|
* Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
|
|
1695
1709
|
* @public
|
|
@@ -1699,7 +1713,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
1699
1713
|
* on the `grid-pro-genesis-datasource` element. Defaults to false but `grid-pro-genesis-datasource` will set this to true.
|
|
1700
1714
|
* @returns The merged column definitions.
|
|
1701
1715
|
*/
|
|
1702
|
-
mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any
|
|
1716
|
+
mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
|
|
1703
1717
|
get observedAttributes(): string[];
|
|
1704
1718
|
agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
|
|
1705
1719
|
globalEventListener(eventType: any, event: any): void;
|
|
@@ -1716,6 +1730,11 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1716
1730
|
"__#1@#_shouldForceLifecycle": boolean;
|
|
1717
1731
|
cloneNode(deep?: boolean): Node;
|
|
1718
1732
|
deepClone(): Node;
|
|
1733
|
+
/**
|
|
1734
|
+
* Boolean attribute to control whether the grid autosizes the columns upon interaction.
|
|
1735
|
+
* This will disable the column widths from being manually set, and doesn't save the widths
|
|
1736
|
+
* in local storage if you are using `persist-column-state-key`.
|
|
1737
|
+
*/
|
|
1719
1738
|
readonly shouldRunDisconnect: boolean;
|
|
1720
1739
|
readonly shouldRunConnect: boolean;
|
|
1721
1740
|
"__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
|
|
@@ -1762,11 +1781,6 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1762
1781
|
onfullscreenchange: (this: Element, ev: Event) => any;
|
|
1763
1782
|
onfullscreenerror: (this: Element, ev: Event) => any;
|
|
1764
1783
|
outerHTML: string;
|
|
1765
|
-
/**
|
|
1766
|
-
* The row data to display in the grid.
|
|
1767
|
-
* @remarks For scenarios where you want to set data manually, without relying on `<grid-pro-client-side-datasource>`.
|
|
1768
|
-
* @public
|
|
1769
|
-
*/
|
|
1770
1784
|
readonly ownerDocument: Document;
|
|
1771
1785
|
readonly part: DOMTokenList;
|
|
1772
1786
|
readonly prefix: string;
|
|
@@ -1797,20 +1811,7 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1797
1811
|
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
|
1798
1812
|
hasAttribute(qualifiedName: string): boolean;
|
|
1799
1813
|
hasAttributeNS(namespace: string, localName: string): boolean;
|
|
1800
|
-
hasAttributes(): boolean;
|
|
1801
|
-
* Injectable config that allows to change grid options on an app level basis
|
|
1802
|
-
* To modify options, register instance of the config in DOM container that is
|
|
1803
|
-
* above the grid or on the top level of the application, so it applies to all grids.
|
|
1804
|
-
*
|
|
1805
|
-
* @example
|
|
1806
|
-
* ```
|
|
1807
|
-
* DI.getOrCreateDOMContainer().register([
|
|
1808
|
-
* Registration.instance<GridOptionsConfig>(GridOptionsConfig, {
|
|
1809
|
-
* headerHeight: 50,
|
|
1810
|
-
* }),
|
|
1811
|
-
* ]);
|
|
1812
|
-
* ```
|
|
1813
|
-
*/
|
|
1814
|
+
hasAttributes(): boolean;
|
|
1814
1815
|
hasPointerCapture(pointerId: number): boolean;
|
|
1815
1816
|
insertAdjacentElement(where: InsertPosition, element: Element): Element;
|
|
1816
1817
|
insertAdjacentHTML(position: InsertPosition, text: string): void;
|
|
@@ -1922,7 +1923,12 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1922
1923
|
ariaValueNow: string;
|
|
1923
1924
|
ariaValueText: string;
|
|
1924
1925
|
role: string;
|
|
1925
|
-
animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
|
|
1926
|
+
animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation; /**
|
|
1927
|
+
* Gets the saved grid ColumnState[] from storage
|
|
1928
|
+
* @remarks This is used to restore the grid state when the grid is rehydrated
|
|
1929
|
+
* @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
|
|
1930
|
+
* @public
|
|
1931
|
+
*/
|
|
1926
1932
|
getAnimations(options?: GetAnimationsOptions): Animation[];
|
|
1927
1933
|
after(...nodes: (string | Node)[]): void;
|
|
1928
1934
|
before(...nodes: (string | Node)[]): void;
|
|
@@ -1952,9 +1958,7 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1952
1958
|
contentEditable: string;
|
|
1953
1959
|
enterKeyHint: string;
|
|
1954
1960
|
inputMode: string;
|
|
1955
|
-
readonly isContentEditable: boolean;
|
|
1956
|
-
* @public
|
|
1957
|
-
*/
|
|
1961
|
+
readonly isContentEditable: boolean;
|
|
1958
1962
|
onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
1959
1963
|
onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
1960
1964
|
onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
@@ -2017,6 +2021,15 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
2017
2021
|
onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
|
|
2018
2022
|
onratechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
2019
2023
|
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
|
2024
|
+
/**
|
|
2025
|
+
* Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
|
|
2026
|
+
* @public
|
|
2027
|
+
* @remarks This will favor the column state from the browser's local storage over the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
|
|
2028
|
+
* @param columnDefs - The column definitions to apply to the grid.
|
|
2029
|
+
* @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property
|
|
2030
|
+
* on the `grid-pro-genesis-datasource` element. Defaults to false but `grid-pro-genesis-datasource` will set this to true.
|
|
2031
|
+
* @returns The merged column definitions.
|
|
2032
|
+
*/
|
|
2020
2033
|
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
2021
2034
|
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
|
2022
2035
|
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
|
@@ -2527,14 +2540,9 @@ export declare type GridProEventsListeners = {
|
|
|
2527
2540
|
* @public
|
|
2528
2541
|
*/
|
|
2529
2542
|
export declare class GridProGenesisDatasource extends GridProGenesisDatasource_base {
|
|
2530
|
-
auth: Auth;
|
|
2531
|
-
datasource: Datasource;
|
|
2532
2543
|
applyFuncName: string;
|
|
2533
2544
|
applyAsyncFuncName: string;
|
|
2534
2545
|
criteriaChanged(oldCriteria: string, newCriteria: string): void;
|
|
2535
|
-
pollingInterval: number;
|
|
2536
|
-
disablePolling: boolean;
|
|
2537
|
-
request: any;
|
|
2538
2546
|
requestChanged(oldRequest: string, newRequest: string): void;
|
|
2539
2547
|
resourceNameChanged(oldValue: string, newValue: string): void;
|
|
2540
2548
|
restartOnReconnection: boolean;
|
|
@@ -2543,8 +2551,6 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
2543
2551
|
private updateSub;
|
|
2544
2552
|
private connectionSub;
|
|
2545
2553
|
private requiresFullRowDataAndColDefs;
|
|
2546
|
-
private criteriaFromFilters;
|
|
2547
|
-
private update;
|
|
2548
2554
|
connectedCallback(): void;
|
|
2549
2555
|
disconnectedCallback(): void;
|
|
2550
2556
|
deepClone(): Node;
|
|
@@ -2557,15 +2563,21 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
2557
2563
|
* @remarks This method is called automatically when the element is connected to the DOM.
|
|
2558
2564
|
*/
|
|
2559
2565
|
init(columnDefinitions?: ColDef[], columnStates?: ColumnState[]): Promise<void>;
|
|
2566
|
+
/**
|
|
2567
|
+
* Destroys the datasource, resetting it to its initial state.
|
|
2568
|
+
* @public
|
|
2569
|
+
*/
|
|
2570
|
+
destroy(): void;
|
|
2560
2571
|
/**
|
|
2561
2572
|
* Deinitialises the datasource, resetting it to its initial state.
|
|
2573
|
+
* @deprecated Use `destroy` instead
|
|
2562
2574
|
* @public
|
|
2563
2575
|
*/
|
|
2564
2576
|
deinit(): void;
|
|
2565
2577
|
/**
|
|
2566
2578
|
* Resets the datasource to its initial state.
|
|
2567
2579
|
* @public
|
|
2568
|
-
* @deprecated Use `
|
|
2580
|
+
* @deprecated Use `destroy` instead
|
|
2569
2581
|
*/
|
|
2570
2582
|
reset(): void;
|
|
2571
2583
|
/**
|
|
@@ -2606,13 +2618,11 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
2606
2618
|
*/
|
|
2607
2619
|
private loadResourceData;
|
|
2608
2620
|
private handleSnapshot;
|
|
2609
|
-
handleErrors(
|
|
2610
|
-
private datasourceOptions;
|
|
2621
|
+
handleErrors(errors: string | any[]): void;
|
|
2611
2622
|
private handleStreamResult;
|
|
2612
2623
|
private applyRequestServerData;
|
|
2613
2624
|
private applyDataserverData;
|
|
2614
2625
|
private getAgColumnDefs;
|
|
2615
|
-
private buildCriteria;
|
|
2616
2626
|
setFilter(fieldName: string, newFilter: string): void;
|
|
2617
2627
|
removeFilter(fieldName: string): void;
|
|
2618
2628
|
applyTransaction(agTransaction: RowDataTransaction): RowNodeTransaction | null | undefined;
|
|
@@ -2665,6 +2675,10 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
2665
2675
|
readonly classList: DOMTokenList;
|
|
2666
2676
|
className: string;
|
|
2667
2677
|
readonly clientHeight: number;
|
|
2678
|
+
/**
|
|
2679
|
+
* Destroys the datasource, resetting it to its initial state.
|
|
2680
|
+
* @public
|
|
2681
|
+
*/
|
|
2668
2682
|
readonly clientLeft: number;
|
|
2669
2683
|
readonly clientTop: number;
|
|
2670
2684
|
readonly clientWidth: number;
|
|
@@ -2996,30 +3010,42 @@ export declare enum GridProRendererTypes {
|
|
|
2996
3010
|
export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base {
|
|
2997
3011
|
applyFuncName: string;
|
|
2998
3012
|
applyAsyncFuncName: string;
|
|
2999
|
-
|
|
3013
|
+
pagination: boolean;
|
|
3000
3014
|
/**
|
|
3001
|
-
*
|
|
3002
|
-
* @remarks
|
|
3003
|
-
* @internal
|
|
3015
|
+
* The starting VIEW_NUMBER of the data to be fetched.
|
|
3016
|
+
* @remarks The VIEW_NUMBER isincremented by the grid as the user scrolls or changes pages.
|
|
3004
3017
|
*/
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
|
|
3018
|
+
zeroBasedViewNumber: boolean;
|
|
3019
|
+
/**
|
|
3020
|
+
* Enable live updates for the grid.
|
|
3021
|
+
* @remarks Only works with DATASERVER resources (StreamDatasource) right now.
|
|
3022
|
+
*/
|
|
3023
|
+
liveUpdates: boolean;
|
|
3024
|
+
request: any;
|
|
3008
3025
|
private indexes;
|
|
3009
3026
|
private ssrmDatasource;
|
|
3010
|
-
private
|
|
3027
|
+
private liveUpdatesStream;
|
|
3028
|
+
resourceNameChanged(oldValue: string, newValue: string): void;
|
|
3029
|
+
criteriaChanged(oldCriteria: string, newCriteria: string): void;
|
|
3011
3030
|
connectedCallback(): void;
|
|
3012
3031
|
disconnectedCallback(): void;
|
|
3013
3032
|
deepClone(): Node;
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3033
|
+
/**
|
|
3034
|
+
* Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
|
|
3035
|
+
* @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
|
|
3036
|
+
* @internal
|
|
3037
|
+
*/
|
|
3038
|
+
private reloadResourceData;
|
|
3039
|
+
init(): Promise<void>;
|
|
3040
|
+
onPaginationChanged(event: PaginationChangedEvent): void;
|
|
3041
|
+
destroy(): Promise<void>;
|
|
3042
|
+
restart(): Promise<void>;
|
|
3017
3043
|
private clearRowData;
|
|
3018
3044
|
private getResourceIndexes;
|
|
3019
3045
|
get params(): any;
|
|
3020
3046
|
get rowModel(): IServerSideRowModel;
|
|
3047
|
+
private createReqRepRequest;
|
|
3021
3048
|
private createDataserverStream;
|
|
3022
|
-
private handleStreamDeletesTemp;
|
|
3023
3049
|
private getAgColumnDefs;
|
|
3024
3050
|
applyTransaction(agTransaction: RowDataTransaction): ServerSideTransactionResult;
|
|
3025
3051
|
applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: ServerSideTransactionResult) => void): void;
|
|
@@ -3234,11 +3260,7 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
|
3234
3260
|
readonly children: HTMLCollection;
|
|
3235
3261
|
readonly firstElementChild: Element;
|
|
3236
3262
|
readonly lastElementChild: Element;
|
|
3237
|
-
append(...nodes: (string | Node)[]): void;
|
|
3238
|
-
* Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
|
|
3239
|
-
* @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
|
|
3240
|
-
* @internal
|
|
3241
|
-
*/
|
|
3263
|
+
append(...nodes: (string | Node)[]): void;
|
|
3242
3264
|
prepend(...nodes: (string | Node)[]): void;
|
|
3243
3265
|
querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
|
|
3244
3266
|
querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
|
|
@@ -3597,76 +3619,6 @@ export declare interface StatePersistence {
|
|
|
3597
3619
|
*/
|
|
3598
3620
|
export declare const StatePersistence: InterfaceSymbol<StatePersistence>;
|
|
3599
3621
|
|
|
3600
|
-
declare class StreamBaseDatasource {
|
|
3601
|
-
protected rowId: string;
|
|
3602
|
-
rowData: Map<string, any>;
|
|
3603
|
-
}
|
|
3604
|
-
|
|
3605
|
-
/**
|
|
3606
|
-
* The IServerSideDatasource implementation, used for SSRM (Server-Side Row Model) in the grid.
|
|
3607
|
-
* @alpha
|
|
3608
|
-
*/
|
|
3609
|
-
export declare class StreamDatasource extends StreamBaseDatasource implements IServerSideDatasource {
|
|
3610
|
-
auth: Auth;
|
|
3611
|
-
connect: Connect;
|
|
3612
|
-
dataserverStream: SocketObservable<FilteredDataServerResult>;
|
|
3613
|
-
dataserverStreamSubscription: SocketSubscription;
|
|
3614
|
-
createDataserverStreamFunc: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
|
|
3615
|
-
private resourceName;
|
|
3616
|
-
resourceParams: any;
|
|
3617
|
-
private resourceIndexes;
|
|
3618
|
-
private resourceColDefs;
|
|
3619
|
-
private maxRows;
|
|
3620
|
-
private maxView;
|
|
3621
|
-
private pagination;
|
|
3622
|
-
streamSourceRef: string;
|
|
3623
|
-
/**
|
|
3624
|
-
* The number of rows in the grid. THIS DO NOT CONSIDER CRITERIA_MATCH scenarios.
|
|
3625
|
-
* @internal
|
|
3626
|
-
*/
|
|
3627
|
-
server_ROWS_COUNT: number;
|
|
3628
|
-
/**
|
|
3629
|
-
* The number of rows in the grid. THIS IS A LOCAL COUNT CONSIDERING CONSIDER CRITERIA_MATCH scenarios.
|
|
3630
|
-
* @internal
|
|
3631
|
-
*/
|
|
3632
|
-
client_ROWS_COUNT: number;
|
|
3633
|
-
private moreRows;
|
|
3634
|
-
private calculatedRowsCount;
|
|
3635
|
-
private lastSequenceId;
|
|
3636
|
-
private currentFilterModel;
|
|
3637
|
-
private originalCriteriaMatch;
|
|
3638
|
-
private currentSortModel;
|
|
3639
|
-
constructor(options: StreamDatasourceOptions);
|
|
3640
|
-
getRows(params: IServerSideGetRowsParams): Promise<void>;
|
|
3641
|
-
private applyServerSideData;
|
|
3642
|
-
private sortMapByNumericKey;
|
|
3643
|
-
deinit(): Promise<void>;
|
|
3644
|
-
private refreshDatasource;
|
|
3645
|
-
private getOrderByAndToBeSortedColIds;
|
|
3646
|
-
private handleCurrentStreamLoad;
|
|
3647
|
-
private buildCriteriaMatchFromFilters;
|
|
3648
|
-
private criteriaFromFilters;
|
|
3649
|
-
private getFiltersByType;
|
|
3650
|
-
}
|
|
3651
|
-
|
|
3652
|
-
/**
|
|
3653
|
-
* Type definition for configuration options used for streams.
|
|
3654
|
-
* @remarks
|
|
3655
|
-
* Used by {@link @genesislcap/grid-pro#StreamDatasource} constructor to configure options for the stream.
|
|
3656
|
-
* @alpha
|
|
3657
|
-
*/
|
|
3658
|
-
export declare type StreamDatasourceOptions = {
|
|
3659
|
-
createDataserverStreamFunc: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
|
|
3660
|
-
resourceName: string;
|
|
3661
|
-
resourceParams?: any;
|
|
3662
|
-
resourceIndexes?: Map<string, [string]>;
|
|
3663
|
-
resourceColDefs?: MetadataDetail[];
|
|
3664
|
-
maxRows?: number;
|
|
3665
|
-
maxView?: number;
|
|
3666
|
-
rowId?: string;
|
|
3667
|
-
pagination?: boolean;
|
|
3668
|
-
};
|
|
3669
|
-
|
|
3670
3622
|
/**
|
|
3671
3623
|
* The AG String Editor element.
|
|
3672
3624
|
* @public
|
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
addEventListener(
|
|
10
|
+
addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
15
|
| Parameter | Type | Description |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
|
|
|
17
|
+
| eventType | string | |
|
|
18
18
|
| listener | any | |
|
|
19
19
|
| options | boolean \| AddEventListenerOptions | _(Optional)_ |
|
|
20
20
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [GridPro](./grid-pro.gridpro.md) > [agGrid](./grid-pro.gridpro.aggrid.md)
|
|
4
|
+
|
|
5
|
+
## GridPro.agGrid property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
agGrid: Grid;
|
|
11
|
+
```
|
|
@@ -14,7 +14,7 @@ Will merge templated column definitions with `columnDefs` plus localStorage's co
|
|
|
14
14
|
**Signature:**
|
|
15
15
|
|
|
16
16
|
```typescript
|
|
17
|
-
applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any
|
|
17
|
+
applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
## Parameters
|
|
@@ -26,7 +26,7 @@ applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boole
|
|
|
26
26
|
|
|
27
27
|
**Returns:**
|
|
28
28
|
|
|
29
|
-
Promise<ColDef<any
|
|
29
|
+
Promise<ColDef<any>\[\]>
|
|
30
30
|
|
|
31
31
|
The merged column definitions.
|
|
32
32
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [GridPro](./grid-pro.gridpro.md) > [columnApi](./grid-pro.gridpro.columnapi.md)
|
|
4
|
+
|
|
5
|
+
## GridPro.columnApi property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
columnApi: ColumnApi;
|
|
11
|
+
```
|
|
@@ -29,6 +29,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
29
29
|
| --- | --- | --- | --- |
|
|
30
30
|
| [addIndex](./grid-pro.gridpro.addindex.md) | | number | The index to add new rows to when using <code>applyTransaction</code> or <code>applyTransactionAsync</code> |
|
|
31
31
|
| [agAttributes](./grid-pro.gridpro.agattributes.md) | <code>protected</code> | Record<string, string> | |
|
|
32
|
+
| [agGrid](./grid-pro.gridpro.aggrid.md) | | Grid | |
|
|
32
33
|
| [agGridOptions](./grid-pro.gridpro.aggridoptions.md) | <code>protected</code> | GridOptions | |
|
|
33
34
|
| [agPropertiesMap](./grid-pro.gridpro.agpropertiesmap.md) | <code>protected</code> | Record<string, string> | |
|
|
34
35
|
| [asyncAdd](./grid-pro.gridpro.asyncadd.md) | | boolean | Whether to use the <code>applyTransactionAsync</code> function for \*add\* transactions |
|
|
@@ -36,12 +37,13 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
36
37
|
| [asyncUpdate](./grid-pro.gridpro.asyncupdate.md) | | boolean | Whether to use the <code>applyTransactionAsync</code> function for \*update\* transactions |
|
|
37
38
|
| [autoCellRendererByType](./grid-pro.gridpro.autocellrendererbytype.md) | | boolean | |
|
|
38
39
|
| [classNames](./grid-pro.gridpro.classnames.md) | | string | |
|
|
40
|
+
| [columnApi](./grid-pro.gridpro.columnapi.md) | | ColumnApi | |
|
|
39
41
|
| [columnComponentName](./grid-pro.gridpro.columncomponentname.md) | | string | |
|
|
40
42
|
| [enableCellFlashing](./grid-pro.gridpro.enablecellflashing.md) | | boolean | If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef |
|
|
41
43
|
| [enabledRowFlashing](./grid-pro.gridpro.enabledrowflashing.md) | | boolean | |
|
|
42
44
|
| [enableRowFlashing](./grid-pro.gridpro.enablerowflashing.md) | | boolean | If true, will enable row flashing for all rows for <code>add</code> async transactions |
|
|
43
45
|
| [eventsAndCallbacks](./grid-pro.gridpro.eventsandcallbacks.md) | | [GridProEventsAndCallbacks](./grid-pro.gridproeventsandcallbacks.md) | |
|
|
44
|
-
| [gridApi](./grid-pro.gridpro.gridapi.md) |
|
|
46
|
+
| [gridApi](./grid-pro.gridpro.gridapi.md) | | GridApi | |
|
|
45
47
|
| [gridAutosizingEnabled](./grid-pro.gridpro.gridautosizingenabled.md) | | boolean | Boolean attribute to control whether the grid autosizes the columns upon interaction. This will disable the column widths from being manually set, and doesn't save the widths in local storage if you are using <code>persist-column-state-key</code>. |
|
|
46
48
|
| [gridComponents](./grid-pro.gridpro.gridcomponents.md) | | { \[componentName: string\]: any; } | |
|
|
47
49
|
| [gridErrorItems](./grid-pro.gridpro.griderroritems.md) | | [GridProErrorItem](./grid-pro.gridproerroritem.md)<!-- --><[GridProErrorEvent](./grid-pro.gridproerrorevent.md)<!-- -->\['detail'\]>\[\] | |
|
|
@@ -67,7 +69,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
67
69
|
|
|
68
70
|
| Method | Modifiers | Description |
|
|
69
71
|
| --- | --- | --- |
|
|
70
|
-
| [addEventListener(
|
|
72
|
+
| [addEventListener(eventType, listener, options)](./grid-pro.gridpro.addeventlistener.md) | | |
|
|
71
73
|
| [agAttributeChangedCallback(attName, oldValue, newValue)](./grid-pro.gridpro.agattributechangedcallback.md) | | |
|
|
72
74
|
| [applyTemplateDefinitions(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridpro.applytemplatedefinitions.md) | | Will merge templated column definitions with <code>columnDefs</code> plus localStorage's column state or <code>deferredColumnStates</code>. |
|
|
73
75
|
| [combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridpro.combineallgridcomponents.md) | | |
|
|
@@ -82,5 +84,5 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
82
84
|
| [rowDataChanged(\_, rowData)](./grid-pro.gridpro.rowdatachanged.md) | | |
|
|
83
85
|
| [setFilterModel(value)](./grid-pro.gridpro.setfiltermodel.md) | | |
|
|
84
86
|
| [statePersistanceEnabled()](./grid-pro.gridpro.statepersistanceenabled.md) | | |
|
|
85
|
-
| [themeChanged(
|
|
87
|
+
| [themeChanged(oldValue, newValue)](./grid-pro.gridpro.themechanged.md) | | |
|
|
86
88
|
|
|
@@ -9,7 +9,7 @@ Will merge templated column definitions with `columnDefs` plus localStorage's co
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any
|
|
12
|
+
mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -21,7 +21,7 @@ mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: bo
|
|
|
21
21
|
|
|
22
22
|
**Returns:**
|
|
23
23
|
|
|
24
|
-
Promise<ColDef<any
|
|
24
|
+
Promise<ColDef<any>\[\]>
|
|
25
25
|
|
|
26
26
|
The merged column definitions.
|
|
27
27
|
|
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
themeChanged(
|
|
10
|
+
themeChanged(oldValue: string, newValue: string): void;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
15
|
| Parameter | Type | Description |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
|
|
|
17
|
+
| oldValue | string | |
|
|
18
18
|
| newValue | string | |
|
|
19
19
|
|
|
20
20
|
**Returns:**
|