import type { ValueFormatterParams } from '@ag-grid-community/core'; import { FieldMetadata } from '@genesislcap/foundation-comms'; import { ColDef } from 'ag-grid-community'; /** * Returns the filter params for enum fields based on the detected filter type. * @param field - The field metadata * @returns the filter params for enum fields, or undefined if not applicable */ export declare function getEnumFilterParams(field: FieldMetadata, filterType: string): ColDef['filterParams'] | undefined; /** * Return a column type base on each field's metadata from the selected resource. * @param metadataType - The type of the field/column * @returns the column type * @remarks Currently only handles numeric columns * @alpha */ export declare function getColumnType(metadataType: string): string; /** * Returns a formatted date value from the Grid Pro cell value. * @param param - A ValueFormatterParams object. * @returns A formatted date value. * @public */ export declare function dateValueFormatter({ value }: ValueFormatterParams): any; /** * Returns a formatted date time value from the Grid Pro cell value. * @param param - A ValueFormatterParams object. * @returns A formatted date time value. * @public */ export declare function dateTimeValueFormatter({ value }: ValueFormatterParams): any; /** * Returns a formatted date value from an epoch number. * @param epoch - A number representing the number of milliseconds since the Unix epoch (1 January 1970 00:00:00 UTC). * @returns A formatted date value. * @alpha * @deprecated No longer used in the Grid Pro package. */ export declare function formatDateExtra(epoch: number): string; /** * The time between allowing the grids to automatically resize. * @internal */ export declare const DEBOUNCED_RESIZE_TIME = 5; /** * The event names for the Grid Pro component. * @public */ export declare const gridProEventNames: { datasourceErrorClose: string; }; /** * The error names for the Grid Pro component. * @public */ export declare const gridProErrorNames: { readonly datasource: "datasource"; readonly unknown: "unknown"; }; /** * @remarks List of AG properties without rowData * @privateRemarks This is was removed from ag-grid v35 but we need to support it for backwards compatibility. * @internal */ export declare const AG_PROPERTIES: string[]; /** * @remarks Copied from AG Grid `PropertyKeys.NUMBER_PROPERTIES` (v29.2.0) to support * attribute-to-gridOptions coercion without relying on `ComponentUtil.copyAttributesToGridOptions`. * @internal */ export declare const AG_NUMBER_PROPERTIES: readonly ["rowHeight", "detailRowHeight", "rowBuffer", "headerHeight", "groupHeaderHeight", "floatingFiltersHeight", "pivotHeaderHeight", "pivotGroupHeaderHeight", "groupDefaultExpanded", "viewportRowModelPageSize", "viewportRowModelBufferSize", "autoSizePadding", "maxBlocksInCache", "maxConcurrentDatasourceRequests", "tooltipShowDelay", "tooltipHideDelay", "cacheOverflowSize", "paginationPageSize", "cacheBlockSize", "infiniteInitialRowCount", "serverSideInitialRowCount", "scrollbarWidth", "asyncTransactionWaitMillis", "blockLoadDebounceMillis", "keepDetailRowsCount", "undoRedoCellEditingLimit", "cellFlashDelay", "cellFadeDelay", "tabIndex"]; /** * @remarks Copied from AG Grid `PropertyKeys.BOOLEAN_PROPERTIES` (v29.2.0) to support * attribute-to-gridOptions coercion without relying on `ComponentUtil.copyAttributesToGridOptions`. * @internal */ export declare const AG_BOOLEAN_PROPERTIES: readonly ["suppressMakeColumnVisibleAfterUnGroup", "suppressRowClickSelection", "suppressCellSelection", "suppressCellFocus", "suppressHorizontalScroll", "alwaysShowHorizontalScroll", "alwaysShowVerticalScroll", "debug", "enableBrowserTooltips", "enableCellExpressions", "groupSelectsChildren", "groupIncludeFooter", "groupIncludeTotalFooter", "groupSuppressBlankHeader", "suppressMenuHide", "suppressRowDeselection", "unSortIcon", "suppressMultiSort", "alwaysMultiSort", "singleClickEdit", "suppressLoadingOverlay", "suppressNoRowsOverlay", "suppressAutoSize", "skipHeaderOnAutoSize", "suppressParentsInRowNodes", "suppressColumnMoveAnimation", "suppressMovableColumns", "suppressFieldDotNotation", "enableRangeSelection", "enableRangeHandle", "enableFillHandle", "suppressClearOnFillReduction", "deltaSort", "suppressTouch", "suppressAsyncEvents", "allowContextMenuWithControlKey", "suppressContextMenu", "rememberGroupStateWhenNewData", "enableCellChangeFlash", "suppressDragLeaveHidesColumns", "suppressRowGroupHidesColumns", "suppressMiddleClickScrolls", "suppressPreventDefaultOnMouseWheel", "suppressCopyRowsToClipboard", "copyHeadersToClipboard", "copyGroupHeadersToClipboard", "pivotMode", "suppressAggFuncInHeader", "suppressColumnVirtualisation", "suppressAggAtRootLevel", "suppressFocusAfterRefresh", "functionsPassive", "functionsReadOnly", "animateRows", "groupSelectsFiltered", "groupRemoveSingleChildren", "groupRemoveLowestSingleChildren", "enableRtl", "suppressClickEdit", "rowDragEntireRow", "rowDragManaged", "suppressRowDrag", "suppressMoveWhenRowDragging", "rowDragMultiRow", "enableGroupEdit", "embedFullWidthRows", "suppressPaginationPanel", "groupHideOpenParents", "groupAllowUnbalanced", "pagination", "paginationAutoPageSize", "suppressScrollOnNewData", "suppressScrollWhenPopupsAreOpen", "purgeClosedRowNodes", "cacheQuickFilter", "excludeHiddenColumnsFromQuickFilter", "ensureDomOrder", "accentedSort", "suppressChangeDetection", "valueCache", "valueCacheNeverExpires", "aggregateOnlyChangedColumns", "suppressAnimationFrame", "suppressExcelExport", "suppressCsvExport", "treeData", "masterDetail", "suppressMultiRangeSelection", "enterMovesDownAfterEdit", "enterMovesDown", "suppressPropertyNamesCheck", "rowMultiSelectWithClick", "suppressRowHoverHighlight", "suppressRowTransform", "suppressClipboardPaste", "suppressLastEmptyLineOnPaste", "enableCharts", "enableChartToolPanelsButton", "suppressChartToolPanelsButton", "suppressMaintainUnsortedOrder", "enableCellTextSelection", "suppressBrowserResizeObserver", "suppressMaxRenderedRowRestriction", "excludeChildrenWhenTreeDataFiltering", "tooltipMouseTrack", "keepDetailRows", "paginateChildRows", "preventDefaultOnContextMenu", "undoRedoCellEditing", "allowDragFromColumnsToolPanel", "immutableData", "pivotSuppressAutoColumn", "suppressExpandablePivotGroups", "debounceVerticalScrollbar", "detailRowAutoHeight", "serverSideFilteringAlwaysResets", "serverSideSortingAlwaysResets", "serverSideSortAllLevels", "serverSideFilterAllLevels", "serverSideSortOnServer", "serverSideFilterOnServer", "suppressAggFilteredOnly", "showOpenedGroup", "suppressClipboardApi", "suppressModelUpdateAfterUpdateTransaction", "stopEditingWhenCellsLoseFocus", "maintainColumnOrder", "groupMaintainOrder", "columnHoverHighlight", "reactUi", "suppressReactUi", "readOnlyEdit", "suppressRowVirtualisation", "enableCellEditingOnBackspace", "resetRowDataOnUpdate", "removePivotHeaderRowWhenSingleValueColumn", "suppressCopySingleCellRanges", "groupRowsSticky", "suppressServerSideInfiniteScroll", "rowGroupPanelSuppressSort", "allowShowChangeAfterFilter", "suppressCutToClipboard"]; /** * @remarks Copied from AG Grid `ComponentUtil.copyAttributesToGridOptions` (v29.2.0). * This is used to coerce string/attribute values into the correct types for gridOptions. * @internal */ export declare function copyAttributesToGridOptions(gridOptions: any, component: Record): any; //# sourceMappingURL=grid-pro.definitions.d.ts.map