@genesislcap/grid-pro 14.275.3 → 14.276.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 +428 -15
- package/dist/custom-elements.json +1306 -141
- package/dist/dts/datasource/base.datasource.d.ts +38 -1
- package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
- package/dist/dts/datasource/index.d.ts +1 -0
- package/dist/dts/datasource/index.d.ts.map +1 -1
- package/dist/dts/datasource/server-side.datasource.d.ts +6 -5
- package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +34 -12
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +65 -16
- 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.types.d.ts +91 -0
- package/dist/dts/grid-pro.types.d.ts.map +1 -1
- package/dist/dts/index.d.ts +1 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/status-bar-components/index.d.ts +5 -0
- package/dist/dts/status-bar-components/index.d.ts.map +1 -0
- package/dist/dts/status-bar-components/label-value.status-bar.d.ts +21 -0
- package/dist/dts/status-bar-components/label-value.status-bar.d.ts.map +1 -0
- package/dist/dts/status-bar-components/load-more.status-bar.d.ts +43 -0
- package/dist/dts/status-bar-components/load-more.status-bar.d.ts.map +1 -0
- package/dist/dts/status-bar-components/pagination.status-bar.d.ts +32 -0
- package/dist/dts/status-bar-components/pagination.status-bar.d.ts.map +1 -0
- package/dist/dts/status-bar-components/reload.status-bar.d.ts +36 -0
- package/dist/dts/status-bar-components/reload.status-bar.d.ts.map +1 -0
- package/dist/esm/datasource/base.datasource.js +124 -7
- package/dist/esm/datasource/index.js +1 -0
- package/dist/esm/datasource/server-side.datasource.js +9 -9
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +111 -34
- package/dist/esm/grid-pro.js +116 -2
- package/dist/esm/grid-pro.styles.js +10 -0
- package/dist/esm/grid-pro.types.js +28 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/status-bar-components/index.js +4 -0
- package/dist/esm/status-bar-components/label-value.status-bar.js +33 -0
- package/dist/esm/status-bar-components/load-more.status-bar.js +209 -0
- package/dist/esm/status-bar-components/pagination.status-bar.js +206 -0
- package/dist/esm/status-bar-components/reload.status-bar.js +162 -0
- package/dist/grid-pro.api.json +6872 -3339
- package/dist/grid-pro.d.ts +384 -32
- package/docs/api/grid-pro.criteriadelimiter.md +13 -0
- package/docs/api/grid-pro.criteriajoin.md +13 -0
- package/docs/api/grid-pro.default_status_bar_config.md +13 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.aggrid.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.connect.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.criteria.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.criteriafromfilters.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.datasource.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.datasourceoptions.md +15 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.datasourcestatuschanged.md +23 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.defaultrowidbyresourcetype.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.deferredcolumnstates.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.deferredgridoptions.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.disablepolling.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.fields.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.isrequestserver.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.issnapshot.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.maxrows.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.maxview.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.md +55 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.movingview.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.orderby.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.pollinginterval.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.removefilter.md +22 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.request.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.requestautosetup.md +18 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.resourcename.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.reverse.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.rowdatamapper.md +13 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.rowid.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.rowidattr.md +15 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.setfilter.md +23 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.update.md +11 -0
- package/docs/api/grid-pro.genesisgriddatasourceelement.viewnumber.md +11 -0
- package/docs/api/grid-pro.gridpro.clearlocalgridoptions.md +17 -0
- package/docs/api/grid-pro.gridpro.gridprodatasource.md +2 -2
- package/docs/api/grid-pro.gridpro.md +8 -2
- package/docs/api/grid-pro.gridpro.pagination.md +18 -0
- package/docs/api/grid-pro.gridpro.paginationpagesize.md +18 -0
- package/docs/api/grid-pro.gridpro.persistcolumnstatekey.md +1 -1
- package/docs/api/grid-pro.gridpro.setuppaginationandstatusbar.md +22 -0
- package/docs/api/grid-pro.gridpro.statusbarconfig.md +18 -0
- package/docs/api/grid-pro.gridpro.withstatusbar.md +18 -0
- package/docs/api/grid-pro.gridprobasedatasource.agtransaction.md +11 -0
- package/docs/api/grid-pro.gridprobasedatasource.applyallagtransactions.md +15 -0
- package/docs/api/grid-pro.gridprobasedatasource.applyasyncfuncname.md +11 -0
- package/docs/api/grid-pro.gridprobasedatasource.applyfuncname.md +11 -0
- package/docs/api/grid-pro.gridprobasedatasource.applytransaction.md +22 -0
- package/docs/api/grid-pro.gridprobasedatasource.applytransactionasync.md +23 -0
- package/docs/api/grid-pro.gridprobasedatasource.datasubwasloggedoff.md +11 -0
- package/docs/api/grid-pro.gridprobasedatasource.destroy.md +15 -0
- package/docs/api/grid-pro.gridprobasedatasource.generatecolumndefsfrommetadata.md +23 -0
- package/docs/api/grid-pro.gridprobasedatasource.getdatasourcestatusbarpanels.md +24 -0
- package/docs/api/grid-pro.gridprobasedatasource.handlestreamdeletes.md +22 -0
- package/docs/api/grid-pro.gridprobasedatasource.handlestreaminserts.md +23 -0
- package/docs/api/grid-pro.gridprobasedatasource.handlestreamupdates.md +22 -0
- package/docs/api/grid-pro.gridprobasedatasource.loadmore.md +15 -0
- package/docs/api/grid-pro.gridprobasedatasource.md +42 -0
- package/docs/api/grid-pro.gridprobasedatasource.pagination.md +11 -0
- package/docs/api/grid-pro.gridprobasedatasource.reloadresourcedata.md +15 -0
- package/docs/api/grid-pro.gridprobasedatasource.restart.md +15 -0
- package/docs/api/grid-pro.gridprobasedatasource.rowdata.md +11 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.handlestreamdeletes.md +24 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.handlestreaminserts.md +22 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.handlestreamupdates.md +22 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.loadmore.md +15 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.md +6 -1
- package/docs/api/grid-pro.gridprogenesisdatasource.reloadresourcedata.md +21 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.restart.md +3 -3
- package/docs/api/grid-pro.gridprostatusbarconfig.loadmore.md +18 -0
- package/docs/api/grid-pro.gridprostatusbarconfig.maxrows.md +18 -0
- package/docs/api/grid-pro.gridprostatusbarconfig.md +27 -0
- package/docs/api/grid-pro.gridprostatusbarconfig.reload.md +18 -0
- package/docs/api/grid-pro.gridprostatusbarconfig.rows.md +18 -0
- package/docs/api/grid-pro.gridprostatusbarloadmoreconfig.appearance.md +18 -0
- package/docs/api/grid-pro.gridprostatusbarloadmoreconfig.md +22 -0
- package/docs/api/grid-pro.gridprostatusbarloadmoreconfig.onloadmore.md +13 -0
- package/docs/api/grid-pro.gridprostatusbarloadmoreconfig.tooltip.md +18 -0
- package/docs/api/grid-pro.gridprostatusbarreloadconfig.icon.md +18 -0
- package/docs/api/grid-pro.gridprostatusbarreloadconfig.md +22 -0
- package/docs/api/grid-pro.gridprostatusbarreloadconfig.onreload.md +13 -0
- package/docs/api/grid-pro.gridprostatusbarreloadconfig.tooltip.md +18 -0
- package/docs/api/grid-pro.gridprostatusbartypes.md +27 -0
- package/docs/api/grid-pro.labelvaluestatusbarcomponent.destroy.md +15 -0
- package/docs/api/grid-pro.labelvaluestatusbarcomponent.getgui.md +15 -0
- package/docs/api/grid-pro.labelvaluestatusbarcomponent.init.md +22 -0
- package/docs/api/grid-pro.labelvaluestatusbarcomponent.md +23 -0
- package/docs/api/grid-pro.labelvaluestatusbarparams.md +17 -0
- package/docs/api/grid-pro.loadmorestatusbarcomponent.destroy.md +15 -0
- package/docs/api/grid-pro.loadmorestatusbarcomponent.getgui.md +15 -0
- package/docs/api/grid-pro.loadmorestatusbarcomponent.init.md +22 -0
- package/docs/api/grid-pro.loadmorestatusbarcomponent.md +25 -0
- package/docs/api/grid-pro.loadmorestatusbarcomponent.updatebuttonvisibility.md +15 -0
- package/docs/api/grid-pro.loadmorestatusbarcomponent.updateparams.md +22 -0
- package/docs/api/grid-pro.loadmorestatusbarparams.md +18 -0
- package/docs/api/grid-pro.md +16 -0
- package/docs/api/grid-pro.paginationstatusbarcomponent.destroy.md +15 -0
- package/docs/api/grid-pro.paginationstatusbarcomponent.getgui.md +15 -0
- package/docs/api/grid-pro.paginationstatusbarcomponent.init.md +22 -0
- package/docs/api/grid-pro.paginationstatusbarcomponent.md +23 -0
- package/docs/api/grid-pro.reloadstatusbarcomponent.destroy.md +15 -0
- package/docs/api/grid-pro.reloadstatusbarcomponent.getgui.md +15 -0
- package/docs/api/grid-pro.reloadstatusbarcomponent.init.md +22 -0
- package/docs/api/grid-pro.reloadstatusbarcomponent.md +24 -0
- package/docs/api/grid-pro.reloadstatusbarcomponent.updateparams.md +22 -0
- package/docs/api/grid-pro.reloadstatusbarparams.md +17 -0
- package/docs/api-report.md +256 -6
- package/package.json +13 -13
package/dist/grid-pro.d.ts
CHANGED
|
@@ -32,6 +32,8 @@ import { ICellRendererFunc } from '@ag-grid-community/core';
|
|
|
32
32
|
import { ICellRendererParams } from '@ag-grid-community/core';
|
|
33
33
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
34
34
|
import { IServerSideRowModel } from '@ag-grid-community/core';
|
|
35
|
+
import { IStatusPanelComp } from '@ag-grid-community/core';
|
|
36
|
+
import { IStatusPanelParams } from '@ag-grid-community/core';
|
|
35
37
|
import { ITooltipComp } from '@ag-grid-community/core';
|
|
36
38
|
import { ITooltipParams } from '@ag-grid-community/core';
|
|
37
39
|
import { KVStorage } from '@genesislcap/foundation-comms';
|
|
@@ -136,7 +138,7 @@ export declare class ActionsMenuRenderer extends FoundationElement implements IC
|
|
|
136
138
|
* @privateRemarks We're excluding rowData as it's a special case that we handle separately
|
|
137
139
|
* @internal
|
|
138
140
|
*/
|
|
139
|
-
export declare const AG_PROPERTIES: ("datasource" | "onGridReady" | "tabIndex" | "api" | "columnApi" | "context" | "columnDefs" | "
|
|
141
|
+
export declare const AG_PROPERTIES: ("datasource" | "onGridReady" | "tabIndex" | "api" | "columnApi" | "context" | "columnDefs" | "rowData" | "headerHeight" | "rowHeight" | "pagination" | "paginationPageSize" | "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" | "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")[];
|
|
140
142
|
|
|
141
143
|
/**
|
|
142
144
|
* The AG Action Renderer Styles.
|
|
@@ -475,6 +477,18 @@ export declare const ColumnTemplate: ViewTemplate<GridProColumn, any>;
|
|
|
475
477
|
*/
|
|
476
478
|
export declare const convertToKebabCase: (value: string) => string;
|
|
477
479
|
|
|
480
|
+
/**
|
|
481
|
+
* The delimiter for the criteria string.
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
export declare const criteriaDelimiter = ";";
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* The join for the criteria string.
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
export declare const criteriaJoin = " && ";
|
|
491
|
+
|
|
478
492
|
/**
|
|
479
493
|
* Allows secure export of CSV https://owasp.org/www-community/attacks/CSV_Injection
|
|
480
494
|
* @public
|
|
@@ -541,6 +555,12 @@ export declare function dateValueFormatter({ value }: ValueFormatterParams): any
|
|
|
541
555
|
*/
|
|
542
556
|
export declare const DEBOUNCED_RESIZE_TIME = 5;
|
|
543
557
|
|
|
558
|
+
/**
|
|
559
|
+
* Default status bar configuration
|
|
560
|
+
* @public
|
|
561
|
+
*/
|
|
562
|
+
export declare const DEFAULT_STATUS_BAR_CONFIG: GridProStatusBarConfig;
|
|
563
|
+
|
|
544
564
|
/**
|
|
545
565
|
* The default font face for Grid Pro (agGridAlpine).
|
|
546
566
|
* @remarks this will change to Roboto.
|
|
@@ -977,7 +997,11 @@ declare interface FuiCellRendererParams extends ICellRendererParams {
|
|
|
977
997
|
isDisabled?: (rowData: any) => boolean;
|
|
978
998
|
}
|
|
979
999
|
|
|
980
|
-
|
|
1000
|
+
/**
|
|
1001
|
+
* The base datasource element for the grid-pro element.
|
|
1002
|
+
* @public
|
|
1003
|
+
*/
|
|
1004
|
+
export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base {
|
|
981
1005
|
connect: Connect;
|
|
982
1006
|
datasource: Datasource;
|
|
983
1007
|
deferredGridOptions: GridOptions;
|
|
@@ -1107,6 +1131,9 @@ declare const GenesisGridDatasourceElement_base: new () => {
|
|
|
1107
1131
|
hasAttributes(): boolean;
|
|
1108
1132
|
hasPointerCapture(pointerId: number): boolean;
|
|
1109
1133
|
insertAdjacentElement(where: InsertPosition, element: Element): Element;
|
|
1134
|
+
/**
|
|
1135
|
+
* @public
|
|
1136
|
+
*/
|
|
1110
1137
|
insertAdjacentHTML(position: InsertPosition, text: string): void;
|
|
1111
1138
|
insertAdjacentText(where: InsertPosition, data: string): void;
|
|
1112
1139
|
matches(selectors: string): boolean;
|
|
@@ -1594,7 +1621,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
1594
1621
|
*/
|
|
1595
1622
|
enableRowFlashing: boolean;
|
|
1596
1623
|
/**
|
|
1597
|
-
* The key to use for persisting the column state in local
|
|
1624
|
+
* The key to use for persisting the column state in local browser or KV storage.
|
|
1598
1625
|
*/
|
|
1599
1626
|
persistColumnStateKey: string;
|
|
1600
1627
|
/**
|
|
@@ -1627,6 +1654,41 @@ export declare class GridPro extends GridPro_base {
|
|
|
1627
1654
|
gridComponents: {
|
|
1628
1655
|
[componentName: string]: any;
|
|
1629
1656
|
};
|
|
1657
|
+
/**
|
|
1658
|
+
* Enable pagination for the grid.
|
|
1659
|
+
* @remarks
|
|
1660
|
+
* When enabled, the grid will automatically configure pagination settings.
|
|
1661
|
+
* Note that AG Grid's full pagination functionality requires the Enterprise module.
|
|
1662
|
+
* While basic pagination will work in Community edition, advanced features like
|
|
1663
|
+
* custom pagination components require Enterprise.
|
|
1664
|
+
* @see https://www.ag-grid.com/javascript-data-grid/row-pagination/
|
|
1665
|
+
* @see https://www.ag-grid.com/javascript-data-grid/server-side-model-pagination/
|
|
1666
|
+
*/
|
|
1667
|
+
pagination: boolean;
|
|
1668
|
+
/**
|
|
1669
|
+
* Number of rows per page when pagination is enabled.
|
|
1670
|
+
* @remarks
|
|
1671
|
+
* **Default Value:** `DatasourceDefaults.DEFAULT_PAGINATION_PAGE_SIZE (25)` (default MAX_ROWS divided by 10)
|
|
1672
|
+
* Only used when pagination is enabled.
|
|
1673
|
+
* Note that AG Grid's full pagination functionality requires the Enterprise module.
|
|
1674
|
+
*/
|
|
1675
|
+
paginationPageSize: number;
|
|
1676
|
+
/**
|
|
1677
|
+
* Configuration for the grid status bar components.
|
|
1678
|
+
* @remarks
|
|
1679
|
+
* This requires AG Grid Enterprise module to be enabled.
|
|
1680
|
+
* The status bar will only be displayed if the Enterprise module is available.
|
|
1681
|
+
* @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
|
|
1682
|
+
*/
|
|
1683
|
+
statusBarConfig: GridProStatusBarConfig;
|
|
1684
|
+
/**
|
|
1685
|
+
* Enables or disables the grid status bar.
|
|
1686
|
+
* @remarks
|
|
1687
|
+
* Default is false.
|
|
1688
|
+
* When disabled, no status bar will be displayed regardless of statusBarConfig.
|
|
1689
|
+
* This requires AG Grid Enterprise module to be available for the status bar to be displayed when enabled.
|
|
1690
|
+
*/
|
|
1691
|
+
withStatusBar: boolean;
|
|
1630
1692
|
private columnState;
|
|
1631
1693
|
protected agAttributes: Record<string, string>;
|
|
1632
1694
|
protected agPropertiesMap: Record<string, string>;
|
|
@@ -1706,12 +1768,17 @@ export declare class GridPro extends GridPro_base {
|
|
|
1706
1768
|
get gridParams(): GridParams;
|
|
1707
1769
|
/**
|
|
1708
1770
|
* Get the datasource element.
|
|
1709
|
-
* @remarks This will return the first datasource element found in the light DOM
|
|
1771
|
+
* @remarks This will return the first datasource element found in the light DOM, wrapping all concrete datasource implementations.
|
|
1710
1772
|
* @public
|
|
1711
1773
|
*/
|
|
1712
|
-
get gridProDatasource():
|
|
1774
|
+
get gridProDatasource(): GridProBaseDatasource;
|
|
1713
1775
|
set gridOptions(options: GridOptions);
|
|
1714
1776
|
private setLocalGridOptions;
|
|
1777
|
+
/**
|
|
1778
|
+
* Clears the local grid options, this is used to clear the grid options when the grid is restarted.
|
|
1779
|
+
* @public
|
|
1780
|
+
*/
|
|
1781
|
+
clearLocalGridOptions(): void;
|
|
1715
1782
|
private initGrid;
|
|
1716
1783
|
/**
|
|
1717
1784
|
* Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
|
|
@@ -1731,6 +1798,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
1731
1798
|
* @returns The merged column definitions.
|
|
1732
1799
|
*/
|
|
1733
1800
|
mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
|
|
1801
|
+
protected setupPaginationAndStatusBar(gridOptions: GridOptions): void;
|
|
1734
1802
|
get observedAttributes(): string[];
|
|
1735
1803
|
agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
|
|
1736
1804
|
globalEventListener(eventType: any, event: any): void;
|
|
@@ -1749,10 +1817,7 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1749
1817
|
deepClone(): Node;
|
|
1750
1818
|
readonly shouldRunDisconnect: boolean;
|
|
1751
1819
|
readonly shouldRunConnect: boolean;
|
|
1752
|
-
"__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
|
|
1753
|
-
* Whether to use the `applyTransactionAsync` function for *add* transactions
|
|
1754
|
-
* @remarks Defaults to false
|
|
1755
|
-
*/
|
|
1820
|
+
"__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
|
|
1756
1821
|
"__#1@#_tryFindContainingLayout"(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
|
|
1757
1822
|
connectedCallback(): void;
|
|
1758
1823
|
readonly $fastController: Controller;
|
|
@@ -1762,7 +1827,10 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1762
1827
|
accessKey: string;
|
|
1763
1828
|
readonly accessKeyLabel: string;
|
|
1764
1829
|
autocapitalize: string;
|
|
1765
|
-
dir: string;
|
|
1830
|
+
dir: string; /**
|
|
1831
|
+
* If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
|
|
1832
|
+
* @remarks Defaults to true
|
|
1833
|
+
*/
|
|
1766
1834
|
draggable: boolean;
|
|
1767
1835
|
hidden: boolean;
|
|
1768
1836
|
inert: boolean;
|
|
@@ -1770,9 +1838,6 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1770
1838
|
lang: string;
|
|
1771
1839
|
readonly offsetHeight: number;
|
|
1772
1840
|
readonly offsetLeft: number;
|
|
1773
|
-
/**
|
|
1774
|
-
* The key to use for persisting the column state in local broswer or KV storage.
|
|
1775
|
-
*/
|
|
1776
1841
|
readonly offsetParent: Element;
|
|
1777
1842
|
readonly offsetTop: number;
|
|
1778
1843
|
readonly offsetWidth: number;
|
|
@@ -1790,6 +1855,11 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1790
1855
|
readonly classList: DOMTokenList;
|
|
1791
1856
|
className: string;
|
|
1792
1857
|
readonly clientHeight: number;
|
|
1858
|
+
/**
|
|
1859
|
+
* The row data to display in the grid.
|
|
1860
|
+
* @remarks For scenarios where you want to set data manually, without relying on `<grid-pro-client-side-datasource>`.
|
|
1861
|
+
* @public
|
|
1862
|
+
*/
|
|
1793
1863
|
readonly clientLeft: number;
|
|
1794
1864
|
readonly clientTop: number;
|
|
1795
1865
|
readonly clientWidth: number;
|
|
@@ -1881,7 +1951,14 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1881
1951
|
lookupPrefix(namespace: string): string;
|
|
1882
1952
|
normalize(): void;
|
|
1883
1953
|
removeChild<T_3 extends Node>(child: T_3): T_3;
|
|
1884
|
-
replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4;
|
|
1954
|
+
replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4; /**
|
|
1955
|
+
* Adds an event listener to the grid element.
|
|
1956
|
+
* @param eventType - The event type to listen for. Recommened to use the `Events` from AG Grid.
|
|
1957
|
+
* @param listener - The event listener to call when the event is fired.
|
|
1958
|
+
* @param options - An options object that specifies characteristics about the event listener.
|
|
1959
|
+
* @privateRemarks
|
|
1960
|
+
* This will change once we do the AG Upgrade and `eventType` will be correctly typed.
|
|
1961
|
+
*/
|
|
1885
1962
|
readonly ATTRIBUTE_NODE: number;
|
|
1886
1963
|
readonly CDATA_SECTION_NODE: number;
|
|
1887
1964
|
readonly COMMENT_NODE: number;
|
|
@@ -2071,14 +2148,17 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
2071
2148
|
focus(options?: FocusOptions): void;
|
|
2072
2149
|
}) & typeof FoundationElement;
|
|
2073
2150
|
|
|
2074
|
-
|
|
2151
|
+
/**
|
|
2152
|
+
* @public
|
|
2153
|
+
*/
|
|
2154
|
+
export declare class GridProBaseDatasource extends GenesisGridDatasourceElement {
|
|
2075
2155
|
protected dataSubWasLoggedOff: boolean;
|
|
2076
2156
|
rowData: Map<string, any>;
|
|
2077
2157
|
protected agTransaction: RowDataTransaction | ServerSideTransaction;
|
|
2078
2158
|
protected applyFuncName: string;
|
|
2079
2159
|
protected applyAsyncFuncName: string;
|
|
2080
2160
|
protected generateColumnDefsFromMetadata(fieldsMetadata: FieldMetadata[], getFilterParamsByFieldType: Function): ColDef[];
|
|
2081
|
-
protected handleStreamInserts(insertedRows: any[]): void;
|
|
2161
|
+
protected handleStreamInserts(insertedRows: any[], addIndex?: number): void;
|
|
2082
2162
|
protected handleStreamDeletes(deletedRows: any[]): void;
|
|
2083
2163
|
protected handleStreamUpdates(updatedRows: any[]): void;
|
|
2084
2164
|
protected applyAllAgTransactions(): void;
|
|
@@ -2093,6 +2173,25 @@ declare class GridProBaseDatasource extends GenesisGridDatasourceElement {
|
|
|
2093
2173
|
* @returns The mapped transaction (if the row data mapper function exists), or the original transaction.
|
|
2094
2174
|
*/
|
|
2095
2175
|
private mapTransaction;
|
|
2176
|
+
protected get pagination(): boolean;
|
|
2177
|
+
loadMore(): void;
|
|
2178
|
+
restart(): void;
|
|
2179
|
+
reloadResourceData(): void;
|
|
2180
|
+
destroy(): void;
|
|
2181
|
+
/**
|
|
2182
|
+
* Helper function to extract configuration for status bar actions
|
|
2183
|
+
* @internal
|
|
2184
|
+
*/
|
|
2185
|
+
protected getStatusBarActionConfig<T>(configValue: boolean | T | undefined, defaultEnabled: boolean): {
|
|
2186
|
+
enabled: boolean;
|
|
2187
|
+
config?: T;
|
|
2188
|
+
};
|
|
2189
|
+
/**
|
|
2190
|
+
* Gets datasource-specific status bar component configurations.
|
|
2191
|
+
* This method should be called by the grid to get status bar panels specific to this datasource.
|
|
2192
|
+
* @public
|
|
2193
|
+
*/
|
|
2194
|
+
getDatasourceStatusBarPanels(isServerSide: boolean): any[];
|
|
2096
2195
|
}
|
|
2097
2196
|
|
|
2098
2197
|
/**
|
|
@@ -2546,6 +2645,7 @@ export declare type GridProEventsListeners = {
|
|
|
2546
2645
|
export declare class GridProGenesisDatasource extends GridProGenesisDatasource_base {
|
|
2547
2646
|
applyFuncName: string;
|
|
2548
2647
|
applyAsyncFuncName: string;
|
|
2648
|
+
private cachedRowArray;
|
|
2549
2649
|
criteriaChanged(oldCriteria: string, newCriteria: string): Promise<void>;
|
|
2550
2650
|
requestChanged(oldRequest: string, newRequest: string): void;
|
|
2551
2651
|
resourceNameChanged(oldValue: string, newValue: string): void;
|
|
@@ -2556,6 +2656,8 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
2556
2656
|
private connectionSub;
|
|
2557
2657
|
private requiresFullRowDataAndColDefs;
|
|
2558
2658
|
private _lastMoreRows;
|
|
2659
|
+
private _isMoreRowsResult;
|
|
2660
|
+
private _sourceRef;
|
|
2559
2661
|
connectedCallback(): void;
|
|
2560
2662
|
disconnectedCallback(): void;
|
|
2561
2663
|
deepClone(): Node;
|
|
@@ -2586,10 +2688,10 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
2586
2688
|
*/
|
|
2587
2689
|
reset(): void;
|
|
2588
2690
|
/**
|
|
2589
|
-
* Restarts the datasource, uses `
|
|
2691
|
+
* Restarts the datasource, uses `destroy` and `init` in sequence.
|
|
2590
2692
|
* @public
|
|
2591
2693
|
*/
|
|
2592
|
-
restart(): void
|
|
2694
|
+
restart(): Promise<void>;
|
|
2593
2695
|
/**
|
|
2594
2696
|
* Force the grid to redispatch the current rows
|
|
2595
2697
|
*/
|
|
@@ -2607,24 +2709,41 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
2607
2709
|
* @internal
|
|
2608
2710
|
*/
|
|
2609
2711
|
private setRowData;
|
|
2712
|
+
/**
|
|
2713
|
+
* Updates the cached row array from the rowData Map
|
|
2714
|
+
* @internal
|
|
2715
|
+
*/
|
|
2716
|
+
private updateCachedRowArray;
|
|
2610
2717
|
/**
|
|
2611
2718
|
* Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
|
|
2612
|
-
*
|
|
2719
|
+
* Loads resource data without full initialization (no metadata fetch).
|
|
2613
2720
|
* @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
|
|
2614
|
-
* @
|
|
2721
|
+
* @see loadResourceData
|
|
2722
|
+
* @public
|
|
2615
2723
|
*/
|
|
2616
|
-
|
|
2724
|
+
reloadResourceData(): Promise<void>;
|
|
2617
2725
|
/**
|
|
2618
2726
|
* Initializes the datasource and loads the data for the grid.
|
|
2619
2727
|
* Handles both snapshot and stream data (for both REQUEST_SERVER and DATASERVER resource types).
|
|
2620
2728
|
*
|
|
2621
2729
|
* @param withFullInit - if true, will call datasource.init() with requiresMetadataFetch = true, fetching fresh metadata
|
|
2730
|
+
* @see reloadResourceData
|
|
2622
2731
|
* @internal
|
|
2623
2732
|
*/
|
|
2624
2733
|
private loadResourceData;
|
|
2625
2734
|
private handleSnapshot;
|
|
2626
2735
|
handleErrors(errors: string | any[]): void;
|
|
2627
2736
|
private handleStreamResult;
|
|
2737
|
+
/**
|
|
2738
|
+
* Updates the status bar based on more rows status
|
|
2739
|
+
* @param moreRows - Whether more rows are available
|
|
2740
|
+
* @param sourceRef - The source reference
|
|
2741
|
+
* @param rowsCount - The total number of rows
|
|
2742
|
+
* @remarks
|
|
2743
|
+
* This method requires AG Grid Enterprise module to work properly.
|
|
2744
|
+
* It will silently fail if the Enterprise module is not available.
|
|
2745
|
+
*/
|
|
2746
|
+
private updateLoadMoreStatus;
|
|
2628
2747
|
private applyRequestServerData;
|
|
2629
2748
|
private applyDataserverData;
|
|
2630
2749
|
private getAgColumnDefs;
|
|
@@ -2633,6 +2752,14 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
2633
2752
|
applyTransaction(agTransaction: RowDataTransaction): RowNodeTransaction | null | undefined;
|
|
2634
2753
|
applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: RowNodeTransaction) => void): void;
|
|
2635
2754
|
private handleSizeChanged;
|
|
2755
|
+
handleStreamInserts(inserts?: any[]): void;
|
|
2756
|
+
handleStreamUpdates(updates?: any[]): void;
|
|
2757
|
+
/**
|
|
2758
|
+
* Handles stream deletes by removing records from the grid.
|
|
2759
|
+
* @param deletes - List of records to remove from the grid stream
|
|
2760
|
+
*/
|
|
2761
|
+
handleStreamDeletes(deletes?: any[]): void;
|
|
2762
|
+
loadMore(): void;
|
|
2636
2763
|
}
|
|
2637
2764
|
|
|
2638
2765
|
declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
@@ -2769,13 +2896,7 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
2769
2896
|
isSameNode(otherNode: Node): boolean;
|
|
2770
2897
|
lookupNamespaceURI(prefix: string): string;
|
|
2771
2898
|
lookupPrefix(namespace: string): string;
|
|
2772
|
-
normalize(): void;
|
|
2773
|
-
* Initializes the datasource and loads the data for the grid.
|
|
2774
|
-
* Handles both snapshot and stream data (for both REQUEST_SERVER and DATASERVER resource types).
|
|
2775
|
-
*
|
|
2776
|
-
* @param withFullInit - if true, will call datasource.init() with requiresMetadataFetch = true, fetching fresh metadata
|
|
2777
|
-
* @internal
|
|
2778
|
-
*/
|
|
2899
|
+
normalize(): void;
|
|
2779
2900
|
removeChild<T_3 extends Node>(child: T_3): T_3;
|
|
2780
2901
|
replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4;
|
|
2781
2902
|
readonly ATTRIBUTE_NODE: number;
|
|
@@ -3018,7 +3139,6 @@ export declare enum GridProRendererTypes {
|
|
|
3018
3139
|
export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base {
|
|
3019
3140
|
applyFuncName: string;
|
|
3020
3141
|
applyAsyncFuncName: string;
|
|
3021
|
-
pagination: boolean;
|
|
3022
3142
|
/**
|
|
3023
3143
|
* The starting VIEW_NUMBER of the data to be fetched.
|
|
3024
3144
|
* @remarks The VIEW_NUMBER isincremented by the grid as the user scrolls or changes pages.
|
|
@@ -3039,11 +3159,11 @@ export declare class GridProServerSideDatasource extends GridProServerSideDataso
|
|
|
3039
3159
|
disconnectedCallback(): void;
|
|
3040
3160
|
deepClone(): Node;
|
|
3041
3161
|
/**
|
|
3042
|
-
* Resets the grid data while keeping columnDefs and
|
|
3162
|
+
* Resets the grid data while keeping columnDefs and reloads data.
|
|
3043
3163
|
* @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
|
|
3044
|
-
* @
|
|
3164
|
+
* @public
|
|
3045
3165
|
*/
|
|
3046
|
-
|
|
3166
|
+
reloadResourceData(params?: any): Promise<void>;
|
|
3047
3167
|
init(): Promise<void>;
|
|
3048
3168
|
onPaginationChanged(event: PaginationChangedEvent): void;
|
|
3049
3169
|
destroy(): Promise<void>;
|
|
@@ -3057,6 +3177,7 @@ export declare class GridProServerSideDatasource extends GridProServerSideDataso
|
|
|
3057
3177
|
private getAgColumnDefs;
|
|
3058
3178
|
applyTransaction(agTransaction: RowDataTransaction): ServerSideTransactionResult;
|
|
3059
3179
|
applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: ServerSideTransactionResult) => void): void;
|
|
3180
|
+
loadMore(): void;
|
|
3060
3181
|
}
|
|
3061
3182
|
|
|
3062
3183
|
declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
@@ -3385,6 +3506,96 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
|
3385
3506
|
focus(options?: FocusOptions): void;
|
|
3386
3507
|
}) & typeof GridProBaseDatasource;
|
|
3387
3508
|
|
|
3509
|
+
/**
|
|
3510
|
+
* Configuration options for the grid status bar components
|
|
3511
|
+
* @public
|
|
3512
|
+
* @remarks
|
|
3513
|
+
* This requires AG Grid Enterprise module to be enabled.
|
|
3514
|
+
* Status bar components will only be displayed if the Enterprise module is available.
|
|
3515
|
+
* @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
|
|
3516
|
+
*/
|
|
3517
|
+
export declare interface GridProStatusBarConfig {
|
|
3518
|
+
/**
|
|
3519
|
+
* Enable row count status bar component.
|
|
3520
|
+
* @remarks Default is false.
|
|
3521
|
+
*/
|
|
3522
|
+
rows?: boolean;
|
|
3523
|
+
/**
|
|
3524
|
+
* Enable max rows status bar component.
|
|
3525
|
+
* @remarks Default is false.
|
|
3526
|
+
*/
|
|
3527
|
+
maxRows?: boolean;
|
|
3528
|
+
/**
|
|
3529
|
+
* Configure load more button status bar component.
|
|
3530
|
+
* @remarks Can be boolean for simple enable/disable or object for detailed configuration.
|
|
3531
|
+
*/
|
|
3532
|
+
loadMore?: boolean | GridProStatusBarLoadMoreConfig;
|
|
3533
|
+
/**
|
|
3534
|
+
* Configure reload button status bar component.
|
|
3535
|
+
* @remarks Can be boolean for simple enable/disable or object for detailed configuration.
|
|
3536
|
+
*/
|
|
3537
|
+
reload?: boolean | GridProStatusBarReloadConfig;
|
|
3538
|
+
}
|
|
3539
|
+
|
|
3540
|
+
/**
|
|
3541
|
+
* Configuration options for load more status bar component
|
|
3542
|
+
* @public
|
|
3543
|
+
*/
|
|
3544
|
+
export declare interface GridProStatusBarLoadMoreConfig {
|
|
3545
|
+
/**
|
|
3546
|
+
* Custom callback function to execute when the action is triggered.
|
|
3547
|
+
* If not provided, the component will use the default datasource behavior.
|
|
3548
|
+
*/
|
|
3549
|
+
onLoadMore?: () => void;
|
|
3550
|
+
/**
|
|
3551
|
+
* Custom appearance for the button.
|
|
3552
|
+
* @remarks Options: 'accent', 'lightweight', 'neutral', 'outline', 'stealth'
|
|
3553
|
+
*/
|
|
3554
|
+
appearance?: string;
|
|
3555
|
+
/**
|
|
3556
|
+
* Custom tooltip text that appears on hover.
|
|
3557
|
+
* @remarks Default is 'Load More'.
|
|
3558
|
+
*/
|
|
3559
|
+
tooltip?: string;
|
|
3560
|
+
}
|
|
3561
|
+
|
|
3562
|
+
/**
|
|
3563
|
+
* Configuration options for reload status bar component
|
|
3564
|
+
* @public
|
|
3565
|
+
*/
|
|
3566
|
+
export declare interface GridProStatusBarReloadConfig {
|
|
3567
|
+
/**
|
|
3568
|
+
* Custom callback function to execute when the action is triggered.
|
|
3569
|
+
* If not provided, the component will use the default datasource behavior.
|
|
3570
|
+
*/
|
|
3571
|
+
onReload?: () => void;
|
|
3572
|
+
/**
|
|
3573
|
+
* Custom FontAwesome icon name (without 'fa-' prefix).
|
|
3574
|
+
* @remarks Default is 'refresh'.
|
|
3575
|
+
*/
|
|
3576
|
+
icon?: string;
|
|
3577
|
+
/**
|
|
3578
|
+
* Custom tooltip text that appears on hover.
|
|
3579
|
+
* @remarks Default is 'Reload'.
|
|
3580
|
+
*/
|
|
3581
|
+
tooltip?: string;
|
|
3582
|
+
}
|
|
3583
|
+
|
|
3584
|
+
/**
|
|
3585
|
+
* The available Grid Pro Status Bar Types
|
|
3586
|
+
* @public
|
|
3587
|
+
* @remarks
|
|
3588
|
+
* These status bar components require AG Grid Enterprise module to be enabled.
|
|
3589
|
+
* Status bar components will only be displayed if the Enterprise module is available.
|
|
3590
|
+
* @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/
|
|
3591
|
+
*/
|
|
3592
|
+
export declare enum GridProStatusBarTypes {
|
|
3593
|
+
labelValue = "labelValue",
|
|
3594
|
+
pagination = "pagination",
|
|
3595
|
+
loadMore = "loadMore",
|
|
3596
|
+
reload = "reload"
|
|
3597
|
+
}
|
|
3598
|
+
|
|
3388
3599
|
/**
|
|
3389
3600
|
*
|
|
3390
3601
|
* @public
|
|
@@ -3426,6 +3637,70 @@ export declare class KVStorageStatePersistence implements StatePersistence {
|
|
|
3426
3637
|
}): Promise<void>;
|
|
3427
3638
|
}
|
|
3428
3639
|
|
|
3640
|
+
/**
|
|
3641
|
+
* Label Value Status Bar Component
|
|
3642
|
+
* @public
|
|
3643
|
+
*/
|
|
3644
|
+
export declare class LabelValueStatusBarComponent implements IStatusPanelComp {
|
|
3645
|
+
private element;
|
|
3646
|
+
init(params: IStatusPanelParams): void;
|
|
3647
|
+
getGui(): HTMLElement;
|
|
3648
|
+
destroy(): void;
|
|
3649
|
+
}
|
|
3650
|
+
|
|
3651
|
+
/**
|
|
3652
|
+
* Label Value Status Bar Component
|
|
3653
|
+
* @public
|
|
3654
|
+
*/
|
|
3655
|
+
export declare type LabelValueStatusBarParams = {
|
|
3656
|
+
label: string;
|
|
3657
|
+
value: any;
|
|
3658
|
+
hide: boolean;
|
|
3659
|
+
};
|
|
3660
|
+
|
|
3661
|
+
/**
|
|
3662
|
+
* A status bar component that shows a "Load More" button when more rows are available
|
|
3663
|
+
* @public
|
|
3664
|
+
*/
|
|
3665
|
+
export declare class LoadMoreStatusBarComponent implements IStatusPanelComp {
|
|
3666
|
+
private element;
|
|
3667
|
+
private loadMoreButton;
|
|
3668
|
+
private progressRing;
|
|
3669
|
+
private buttonLabel;
|
|
3670
|
+
private params;
|
|
3671
|
+
private designSystemPrefix;
|
|
3672
|
+
private isLoading;
|
|
3673
|
+
private isLeftAligned;
|
|
3674
|
+
private gridApi;
|
|
3675
|
+
private clickHandler;
|
|
3676
|
+
init(params: IStatusPanelParams): void;
|
|
3677
|
+
private createProgressRing;
|
|
3678
|
+
private createLoadMoreButton;
|
|
3679
|
+
/**
|
|
3680
|
+
* Update the aria-label based on current state and tooltip
|
|
3681
|
+
*/
|
|
3682
|
+
private updateAriaLabel;
|
|
3683
|
+
/**
|
|
3684
|
+
* Show or hide the loading state
|
|
3685
|
+
*/
|
|
3686
|
+
private showLoading;
|
|
3687
|
+
updateButtonVisibility(): void;
|
|
3688
|
+
updateParams(params: LoadMoreStatusBarParams): void;
|
|
3689
|
+
getGui(): HTMLElement;
|
|
3690
|
+
destroy(): void;
|
|
3691
|
+
}
|
|
3692
|
+
|
|
3693
|
+
/**
|
|
3694
|
+
* The parameters for the load more status bar component.
|
|
3695
|
+
* @public
|
|
3696
|
+
*/
|
|
3697
|
+
export declare type LoadMoreStatusBarParams = {
|
|
3698
|
+
moreRows?: boolean;
|
|
3699
|
+
onLoadMore?: () => void;
|
|
3700
|
+
appearance?: string;
|
|
3701
|
+
tooltip?: string;
|
|
3702
|
+
};
|
|
3703
|
+
|
|
3429
3704
|
/**
|
|
3430
3705
|
* Implementation for the Local Storage State Persistence interface.
|
|
3431
3706
|
* @public
|
|
@@ -3537,6 +3812,83 @@ declare type OnlyFunctions<T> = {
|
|
|
3537
3812
|
[K in keyof T as T[K] extends never ? never : K]: T[K];
|
|
3538
3813
|
};
|
|
3539
3814
|
|
|
3815
|
+
/**
|
|
3816
|
+
* The operation type for the {@link @genesislcap/grid-pro#GridProBaseDatasource.mapTransaction} method.
|
|
3817
|
+
* @internal
|
|
3818
|
+
*/
|
|
3819
|
+
export declare enum OperationType {
|
|
3820
|
+
Add = "add",
|
|
3821
|
+
Update = "update",
|
|
3822
|
+
Remove = "remove"
|
|
3823
|
+
}
|
|
3824
|
+
|
|
3825
|
+
/**
|
|
3826
|
+
* Pagination Status Bar Component for AG Grid
|
|
3827
|
+
* Displays pagination controls and information about current page and total rows
|
|
3828
|
+
* @public
|
|
3829
|
+
*/
|
|
3830
|
+
export declare class PaginationStatusBarComponent implements IStatusPanelComp {
|
|
3831
|
+
private eGui;
|
|
3832
|
+
private api;
|
|
3833
|
+
private paginationPanel;
|
|
3834
|
+
private paginationSummaryPanel;
|
|
3835
|
+
private firstPageButton;
|
|
3836
|
+
private prevPageButton;
|
|
3837
|
+
private descriptionPanel;
|
|
3838
|
+
private pageStartDisplay;
|
|
3839
|
+
private pageNumberDisplay;
|
|
3840
|
+
private pageOfDisplay;
|
|
3841
|
+
private pageNumberTotalDisplay;
|
|
3842
|
+
private nextPageButton;
|
|
3843
|
+
private lastPageButton;
|
|
3844
|
+
private paginationChangedHandler;
|
|
3845
|
+
init(params: IStatusPanelParams): void;
|
|
3846
|
+
getGui(): HTMLElement;
|
|
3847
|
+
private createPaginationPanel;
|
|
3848
|
+
private addPaginationEventListeners;
|
|
3849
|
+
private createPaginationButton;
|
|
3850
|
+
private goToPage;
|
|
3851
|
+
private updateDisplay;
|
|
3852
|
+
private updateButtonState;
|
|
3853
|
+
destroy(): void;
|
|
3854
|
+
}
|
|
3855
|
+
|
|
3856
|
+
/**
|
|
3857
|
+
* A status bar component that shows a refresh icon to reload the grid data
|
|
3858
|
+
* @public
|
|
3859
|
+
*/
|
|
3860
|
+
export declare class ReloadStatusBarComponent implements IStatusPanelComp {
|
|
3861
|
+
private element;
|
|
3862
|
+
private refreshIcon;
|
|
3863
|
+
private progressRing;
|
|
3864
|
+
private params;
|
|
3865
|
+
private designSystemPrefix;
|
|
3866
|
+
private isReloading;
|
|
3867
|
+
private mouseoverHandler;
|
|
3868
|
+
private mouseoutHandler;
|
|
3869
|
+
private clickHandler;
|
|
3870
|
+
init(params: IStatusPanelParams): void;
|
|
3871
|
+
private createProgressRing;
|
|
3872
|
+
private createRefreshIcon;
|
|
3873
|
+
/**
|
|
3874
|
+
* Show or hide the reloading state
|
|
3875
|
+
*/
|
|
3876
|
+
private showReloading;
|
|
3877
|
+
updateParams(params: ReloadStatusBarParams): void;
|
|
3878
|
+
getGui(): HTMLElement;
|
|
3879
|
+
destroy(): void;
|
|
3880
|
+
}
|
|
3881
|
+
|
|
3882
|
+
/**
|
|
3883
|
+
* The parameters for the reload status bar component.
|
|
3884
|
+
* @public
|
|
3885
|
+
*/
|
|
3886
|
+
export declare type ReloadStatusBarParams = {
|
|
3887
|
+
onReload?: () => void;
|
|
3888
|
+
icon?: string;
|
|
3889
|
+
tooltip?: string;
|
|
3890
|
+
};
|
|
3891
|
+
|
|
3540
3892
|
/**
|
|
3541
3893
|
* The interface for the select renderer parameters
|
|
3542
3894
|
* @public
|