grid-pro.gridprobeta.mergeallcolumndefsandstates
Home > @genesislcap/grid-pro > GridProBeta > mergeAllColumnDefsAndStates
GridProBeta.mergeAllColumnDefsAndStates() method
Will merge templated column definitions with columnDefs plus localStorage's column state or deferredColumnStates.
Signature:
mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<import("@ag-grid-community/core").ColDef<any>[] | (ColDef<any, any> | {
colId?: string;
field?: string;
type?: string | string[];
valueGetter?: string | import("@ag-grid-community/core").ValueGetterFunc<any> | import("ag-grid-community").ValueGetterFunc<any, any, any>;
valueFormatter?: string | import("@ag-grid-community/core").ValueFormatterFunc<any> | import("ag-grid-community").ValueFormatterFunc<any, any, any>;
refData?: {
[key: string]: string;
};
keyCreator?: ((params: import("@ag-grid-community/core").KeyCreatorParams<any, any>) => string) | ((params: import("ag-grid-community").KeyCreatorParams<any, any, any>) => string);
equals?: (valueA: any, valueB: any) => boolean;
tooltipField?: string;
tooltipValueGetter?: ((params: import("@ag-grid-community/core").ITooltipParams<any, any, any>) => string | any) | ((params: import("ag-grid-community").ITooltipParams<any, any, any>) => string | any);
checkboxSelection?: boolean | import("@ag-grid-community/core").CheckboxSelectionCallback<any> | import("ag-grid-community").CheckboxSelectionCallback<any, any, any>;
showDisabledCheckboxes?: boolean;
icons?: {
[key: string]: string | Function;
};
suppressNavigable?: boolean | import("@ag-grid-community/core").SuppressNavigableCallback<any> | import("ag-grid-community").SuppressNavigableCallback<any, any, any>;
suppressKeyboardEvent?: ((params: import("@ag-grid-community/core").SuppressKeyboardEventParams<any>) => boolean) | ((params: import("ag-grid-community").SuppressKeyboardEventParams<any, any, any>) => boolean);
suppressPaste?: boolean | import("@ag-grid-community/core").SuppressPasteCallback<any> | import("ag-grid-community").SuppressPasteCallback<any, any, any>;
suppressFillHandle?: boolean;
hide?: boolean | null;
initialHide?: boolean;
lockVisible?: boolean;
lockPosition?: boolean | "left" | "right";
suppressMovable?: boolean;
editable?: boolean | import("@ag-grid-community/core").EditableCallback<any> | import("ag-grid-community").EditableCallback<any, any, any>;
valueSetter?: string | import("@ag-grid-community/core").ValueSetterFunc<any> | import("ag-grid-community").ValueSetterFunc<any, any, any>;
valueParser?: string | import("@ag-grid-community/core").ValueParserFunc<any, any> | import("ag-grid-community").ValueParserFunc<any, any, any>;
cellEditor?: any;
cellEditorFramework?: any;
cellEditorParams?: any;
cellEditorSelector?: import("@ag-grid-community/core").CellEditorSelectorFunc<any> | import("ag-grid-community").CellEditorSelectorFunc<any, any, any>;
singleClickEdit?: boolean;
cellEditorPopup?: boolean;
cellEditorPopupPosition?: "over" | "under";
onCellValueChanged?: ((event: import("@ag-grid-community/core").NewValueParams<any>) => void) | ((event: import("ag-grid-community").NewValueParams<any, any, any>) => void);
onCellClicked?: ((event: import("@ag-grid-community/core").CellClickedEvent<any, any>) => void) | ((event: import("ag-grid-community").CellClickedEvent<any, any, any>) => void);
onCellDoubleClicked?: ((event: import("@ag-grid-community/core").CellDoubleClickedEvent<any, any>) => void) | ((event: import("ag-grid-community").CellDoubleClickedEvent<any, any, any>) => void);
onCellContextMenu?: ((event: import("@ag-grid-community/core").CellContextMenuEvent<any, any>) => void) | ((event: import("ag-grid-community").CellContextMenuEvent<any, any, any>) => void);
getQuickFilterText?: ((params: import("@ag-grid-community/core").GetQuickFilterTextParams<any, any>) => string) | ((params: import("ag-grid-community").GetQuickFilterTextParams<any, any, any>) => string);
filterValueGetter?: string | import("@ag-grid-community/core").ValueGetterFunc<any> | import("ag-grid-community").ValueGetterFunc<any, any, any>;
floatingFilter?: boolean;
wrapHeaderText?: boolean;
autoHeaderHeight?: boolean;
headerComponent?: any;
headerComponentFramework?: any;
headerComponentParams?: any;
menuTabs?: import("@ag-grid-community/core").ColumnMenuTab[];
columnsMenuParams?: import("@ag-grid-community/core").ColumnsMenuParams;
suppressMenu?: boolean;
headerCheckboxSelection?: boolean | import("@ag-grid-community/core").HeaderCheckboxSelectionCallback<any> | import("ag-grid-community").HeaderCheckboxSelectionCallback<any, any, any>;
headerCheckboxSelectionFilteredOnly?: boolean;
headerCheckboxSelectionCurrentPageOnly?: boolean;
chartDataType?: "category" | "series" | "time" | "excluded";
pinned?: boolean | "left" | "right" | null;
initialPinned?: boolean | "left" | "right";
lockPinned?: boolean;
pivot?: boolean | null;
initialPivot?: boolean;
pivotIndex?: number | null;
initialPivotIndex?: number;
pivotComparator?: (valueA: string, valueB: string) => number;
enablePivot?: boolean;
cellStyle?: import("@ag-grid-community/core").CellStyle | import("@ag-grid-community/core").CellStyleFunc<any> | import("ag-grid-community").CellStyleFunc<any, any, any>;
cellClass?: string | string[] | import("@ag-grid-community/core").CellClassFunc<any> | import("ag-grid-community").CellClassFunc<any, any, any>;
cellClassRules?: import("@ag-grid-community/core").CellClassRules<any> | import("ag-grid-community").CellClassRules<any, any, any>;
cellRenderer?: any;
cellRendererFramework?: any;
cellRendererParams?: any;
cellRendererSelector?: import("@ag-grid-community/core").CellRendererSelectorFunc<any> | import("ag-grid-community").CellRendererSelectorFunc<any, any, any>;
autoHeight?: boolean;
wrapText?: boolean;
enableCellChangeFlash?: boolean;
suppressCellFlash?: boolean;
rowDrag?: boolean | import("@ag-grid-community/core").RowDragCallback<any> | import("ag-grid-community").RowDragCallback<any, any, any>;
rowDragText?: ((params: import("@ag-grid-community/core").IRowDragItem, dragItemCount: number) => string) | ((params: import("ag-grid-community").IRowDragItem, dragItemCount: number) => string);
dndSource?: boolean | import("@ag-grid-community/core").DndSourceCallback<any> | import("ag-grid-community").DndSourceCallback<any, any, any>;
dndSourceOnRowDrag?: ((params: import("@ag-grid-community/core").DndSourceOnRowDragParams<any>) => void) | ((params: import("ag-grid-community").DndSourceOnRowDragParams<any, any>) => void);
rowGroup?: boolean | null;
initialRowGroup?: boolean;
rowGroupIndex?: number | null;
initialRowGroupIndex?: number;
enableRowGroup?: boolean;
enableValue?: boolean;
aggFunc?: string | import("@ag-grid-community/core").IAggFunc<any, any> | import("ag-grid-community").IAggFunc<any, any, any>;
initialAggFunc?: string | import("@ag-grid-community/core").IAggFunc<any, any> | import("ag-grid-community").IAggFunc<any, any, any>;
defaultAggFunc?: string;
allowedAggFuncs?: string[];
showRowGroup?: string | boolean;
sortable?: boolean;
sort?: "asc" | "desc" | import("ag-grid-community").SortDef;
initialSort?: "asc" | "desc" | import("ag-grid-community").SortDef;
sortIndex?: number | null;
initialSortIndex?: number;
sortingOrder?: (import("ag-grid-community").SortDirection | import("ag-grid-community").SortDef)[];
comparator?: ((valueA: any, valueB: any, nodeA: import("@ag-grid-community/core").IRowNode<any>, nodeB: import("@ag-grid-community/core").IRowNode<any>, isDescending: boolean) => number) | import("ag-grid-community/dist/types/src/entities/colDef").SortComparatorFn<any, any> | Partial<Record<import("ag-grid-community").SortType, import("ag-grid-community/dist/types/src/entities/colDef").SortComparatorFn<any, any>>>;
unSortIcon?: boolean;
colSpan?: ((params: import("@ag-grid-community/core").ColSpanParams<any>) => number) | ((params: import("ag-grid-community").ColSpanParams<any, any, any>) => number);
rowSpan?: ((params: import("@ag-grid-community/core").RowSpanParams<any>) => number) | ((params: import("ag-grid-community").RowSpanParams<any, any, any>) => number);
width?: number;
initialWidth?: number;
minWidth?: number;
maxWidth?: number;
flex?: number | null;
initialFlex?: number;
resizable?: boolean;
suppressSizeToFit?: boolean;
suppressAutoSize?: boolean;
pivotValueColumn?: import("@ag-grid-community/core").Column | import("ag-grid-community").Column<any>;
pivotTotalColumnIds?: string[];
spanHeaderHeight?: boolean;
headerName?: string;
headerValueGetter?: string | import("@ag-grid-community/core").HeaderValueGetterFunc<any> | import("ag-grid-community").HeaderValueGetterFunc<any, any, any>;
headerTooltip?: string;
headerClass?: string | string[] | ((params: import("@ag-grid-community/core").HeaderClassParams<any>) => string | string[] | undefined) | ((params: import("ag-grid-community").HeaderClassParams<any, any, any>) => string | string[] | undefined);
suppressHeaderKeyboardEvent?: ((params: import("@ag-grid-community/core").SuppressHeaderKeyboardEventParams<any>) => boolean) | ((params: import("ag-grid-community").SuppressHeaderKeyboardEventParams<any, any, any>) => boolean);
columnGroupShow?: "open" | "closed";
toolPanelClass?: string | string[] | ((params: import("@ag-grid-community/core").ToolPanelClassParams<any>) => string | string[] | undefined) | ((params: import("ag-grid-community").ToolPanelClassParams<any, any, any>) => string | string[] | undefined);
suppressColumnsToolPanel?: boolean;
suppressFiltersToolPanel?: boolean;
tooltipComponent?: any;
tooltipComponentFramework?: any;
tooltipComponentParams?: any;
pivotKeys?: string[];
filter?: any;
filterFramework?: any;
filterParams?: any;
floatingFilterComponent?: any;
floatingFilterComponentFramework?: any;
floatingFilterComponentParams?: any;
cellDataType?: boolean | string;
allowFormula?: boolean;
tooltipComponentSelector?: import("ag-grid-community").CellEditorSelectorFunc | import("ag-grid-community").CellRendererSelectorFunc;
useValueFormatterForExport?: boolean;
useValueParserForImport?: boolean;
suppressFloatingFilterButton?: boolean;
dateComponent?: any;
dateComponentParams?: any;
getFindText?: import("ag-grid-community").GetFindTextFunc<any, any, any>;
columnChooserParams?: import("ag-grid-community").ColumnChooserParams;
suppressHeaderMenuButton?: boolean;
suppressHeaderFilterButton?: boolean;
mainMenuItems?: import("ag-grid-community").GetMainMenuItems<any, any> | (import("ag-grid-community").MenuItemDef<any, any> | import("ag-grid-community").DefaultMenuItem)[];
contextMenuItems?: import("ag-grid-community").GetContextMenuItems<any, any> | (import("ag-grid-community").MenuItemDef<any, any> | import("ag-grid-community").DefaultMenuItem)[];
loadingCellRenderer?: any;
loadingCellRendererParams?: any;
loadingCellRendererSelector?: import("ag-grid-community").ILoadingCellRendererSelectorFunc<any, any, any>;
rowGroupingHierarchy?: (string | ColDef<any, any>)[];
groupHierarchy?: (string | ColDef<any, any>)[];
spanRows?: boolean | ((params: import("ag-grid-community").SpanRowsParams<any, any, any>) => boolean);
suppressSpanHeaderHeight?: boolean;
headerTooltipValueGetter?: (params: import("ag-grid-community").ITooltipParams<any, any, any>) => string | any;
headerStyle?: import("ag-grid-community").HeaderStyle | import("ag-grid-community").HeaderStyleFunc<any, any, any>;
cellAriaRole?: string;
context?: any;
suppressHeaderContextMenu?: boolean;
})[]>;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
columnDefs |
ColDef[] |
The column definitions to apply to the grid. |
|
deferredColumnDefsOrState |
boolean |
(Optional) If true, will merge the column definitions with the saved column state or the |
Returns:
Promise<import("@ag-grid-community/core").ColDef<any>[] | (ColDef<any, any> | { colId?: string; field?: string; type?: string | string[]; valueGetter?: string | import("@ag-grid-community/core").ValueGetterFunc<any> | import("ag-grid-community").ValueGetterFunc<any, any, any>; valueFormatter?: string | import("@ag-grid-community/core").ValueFormatterFunc<any> | import("ag-grid-community").ValueFormatterFunc<any, any, any>; refData?: { [key: string]: string; }; keyCreator?: ((params: import("@ag-grid-community/core").KeyCreatorParams<any, any>) => string) | ((params: import("ag-grid-community").KeyCreatorParams<any, any, any>) => string); equals?: (valueA: any, valueB: any) => boolean; tooltipField?: string; tooltipValueGetter?: ((params: import("@ag-grid-community/core").ITooltipParams<any, any, any>) => string | any) | ((params: import("ag-grid-community").ITooltipParams<any, any, any>) => string | any); checkboxSelection?: boolean | import("@ag-grid-community/core").CheckboxSelectionCallback<any> | import("ag-grid-community").CheckboxSelectionCallback<any, any, any>; showDisabledCheckboxes?: boolean; icons?: { [key: string]: string | Function; }; suppressNavigable?: boolean | import("@ag-grid-community/core").SuppressNavigableCallback<any> | import("ag-grid-community").SuppressNavigableCallback<any, any, any>; suppressKeyboardEvent?: ((params: import("@ag-grid-community/core").SuppressKeyboardEventParams<any>) => boolean) | ((params: import("ag-grid-community").SuppressKeyboardEventParams<any, any, any>) => boolean); suppressPaste?: boolean | import("@ag-grid-community/core").SuppressPasteCallback<any> | import("ag-grid-community").SuppressPasteCallback<any, any, any>; suppressFillHandle?: boolean; hide?: boolean | null; initialHide?: boolean; lockVisible?: boolean; lockPosition?: boolean | "left" | "right"; suppressMovable?: boolean; editable?: boolean | import("@ag-grid-community/core").EditableCallback<any> | import("ag-grid-community").EditableCallback<any, any, any>; valueSetter?: string | import("@ag-grid-community/core").ValueSetterFunc<any> | import("ag-grid-community").ValueSetterFunc<any, any, any>; valueParser?: string | import("@ag-grid-community/core").ValueParserFunc<any, any> | import("ag-grid-community").ValueParserFunc<any, any, any>; cellEditor?: any; cellEditorFramework?: any; cellEditorParams?: any; cellEditorSelector?: import("@ag-grid-community/core").CellEditorSelectorFunc<any> | import("ag-grid-community").CellEditorSelectorFunc<any, any, any>; singleClickEdit?: boolean; cellEditorPopup?: boolean; cellEditorPopupPosition?: "over" | "under"; onCellValueChanged?: ((event: import("@ag-grid-community/core").NewValueParams<any>) => void) | ((event: import("ag-grid-community").NewValueParams<any, any, any>) => void); onCellClicked?: ((event: import("@ag-grid-community/core").CellClickedEvent<any, any>) => void) | ((event: import("ag-grid-community").CellClickedEvent<any, any, any>) => void); onCellDoubleClicked?: ((event: import("@ag-grid-community/core").CellDoubleClickedEvent<any, any>) => void) | ((event: import("ag-grid-community").CellDoubleClickedEvent<any, any, any>) => void); onCellContextMenu?: ((event: import("@ag-grid-community/core").CellContextMenuEvent<any, any>) => void) | ((event: import("ag-grid-community").CellContextMenuEvent<any, any, any>) => void); getQuickFilterText?: ((params: import("@ag-grid-community/core").GetQuickFilterTextParams<any, any>) => string) | ((params: import("ag-grid-community").GetQuickFilterTextParams<any, any, any>) => string); filterValueGetter?: string | import("@ag-grid-community/core").ValueGetterFunc<any> | import("ag-grid-community").ValueGetterFunc<any, any, any>; floatingFilter?: boolean; wrapHeaderText?: boolean; autoHeaderHeight?: boolean; headerComponent?: any; headerComponentFramework?: any; headerComponentParams?: any; menuTabs?: import("@ag-grid-community/core").ColumnMenuTab[]; columnsMenuParams?: import("@ag-grid-community/core").ColumnsMenuParams; suppressMenu?: boolean; headerCheckboxSelection?: boolean | import("@ag-grid-community/core").HeaderCheckboxSelectionCallback<any> | import("ag-grid-community").HeaderCheckboxSelectionCallback<any, any, any>; headerCheckboxSelectionFilteredOnly?: boolean; headerCheckboxSelectionCurrentPageOnly?: boolean; chartDataType?: "category" | "series" | "time" | "excluded"; pinned?: boolean | "left" | "right" | null; initialPinned?: boolean | "left" | "right"; lockPinned?: boolean; pivot?: boolean | null; initialPivot?: boolean; pivotIndex?: number | null; initialPivotIndex?: number; pivotComparator?: (valueA: string, valueB: string) => number; enablePivot?: boolean; cellStyle?: import("@ag-grid-community/core").CellStyle | import("@ag-grid-community/core").CellStyleFunc<any> | import("ag-grid-community").CellStyleFunc<any, any, any>; cellClass?: string | string[] | import("@ag-grid-community/core").CellClassFunc<any> | import("ag-grid-community").CellClassFunc<any, any, any>; cellClassRules?: import("@ag-grid-community/core").CellClassRules<any> | import("ag-grid-community").CellClassRules<any, any, any>; cellRenderer?: any; cellRendererFramework?: any; cellRendererParams?: any; cellRendererSelector?: import("@ag-grid-community/core").CellRendererSelectorFunc<any> | import("ag-grid-community").CellRendererSelectorFunc<any, any, any>; autoHeight?: boolean; wrapText?: boolean; enableCellChangeFlash?: boolean; suppressCellFlash?: boolean; rowDrag?: boolean | import("@ag-grid-community/core").RowDragCallback<any> | import("ag-grid-community").RowDragCallback<any, any, any>; rowDragText?: ((params: import("@ag-grid-community/core").IRowDragItem, dragItemCount: number) => string) | ((params: import("ag-grid-community").IRowDragItem, dragItemCount: number) => string); dndSource?: boolean | import("@ag-grid-community/core").DndSourceCallback<any> | import("ag-grid-community").DndSourceCallback<any, any, any>; dndSourceOnRowDrag?: ((params: import("@ag-grid-community/core").DndSourceOnRowDragParams<any>) => void) | ((params: import("ag-grid-community").DndSourceOnRowDragParams<any, any>) => void); rowGroup?: boolean | null; initialRowGroup?: boolean; rowGroupIndex?: number | null; initialRowGroupIndex?: number; enableRowGroup?: boolean; enableValue?: boolean; aggFunc?: string | import("@ag-grid-community/core").IAggFunc<any, any> | import("ag-grid-community").IAggFunc<any, any, any>; initialAggFunc?: string | import("@ag-grid-community/core").IAggFunc<any, any> | import("ag-grid-community").IAggFunc<any, any, any>; defaultAggFunc?: string; allowedAggFuncs?: string[]; showRowGroup?: string | boolean; sortable?: boolean; sort?: "asc" | "desc" | import("ag-grid-community").SortDef; initialSort?: "asc" | "desc" | import("ag-grid-community").SortDef; sortIndex?: number | null; initialSortIndex?: number; sortingOrder?: (import("ag-grid-community").SortDirection | import("ag-grid-community").SortDef)[]; comparator?: ((valueA: any, valueB: any, nodeA: import("@ag-grid-community/core").IRowNode<any>, nodeB: import("@ag-grid-community/core").IRowNode<any>, isDescending: boolean) => number) | import("ag-grid-community/dist/types/src/entities/colDef").SortComparatorFn<any, any> | Partial<Record<import("ag-grid-community").SortType, import("ag-grid-community/dist/types/src/entities/colDef").SortComparatorFn<any, any>>>; unSortIcon?: boolean; colSpan?: ((params: import("@ag-grid-community/core").ColSpanParams<any>) => number) | ((params: import("ag-grid-community").ColSpanParams<any, any, any>) => number); rowSpan?: ((params: import("@ag-grid-community/core").RowSpanParams<any>) => number) | ((params: import("ag-grid-community").RowSpanParams<any, any, any>) => number); width?: number; initialWidth?: number; minWidth?: number; maxWidth?: number; flex?: number | null; initialFlex?: number; resizable?: boolean; suppressSizeToFit?: boolean; suppressAutoSize?: boolean; pivotValueColumn?: import("@ag-grid-community/core").Column | import("ag-grid-community").Column<any>; pivotTotalColumnIds?: string[]; spanHeaderHeight?: boolean; headerName?: string; headerValueGetter?: string | import("@ag-grid-community/core").HeaderValueGetterFunc<any> | import("ag-grid-community").HeaderValueGetterFunc<any, any, any>; headerTooltip?: string; headerClass?: string | string[] | ((params: import("@ag-grid-community/core").HeaderClassParams<any>) => string | string[] | undefined) | ((params: import("ag-grid-community").HeaderClassParams<any, any, any>) => string | string[] | undefined); suppressHeaderKeyboardEvent?: ((params: import("@ag-grid-community/core").SuppressHeaderKeyboardEventParams<any>) => boolean) | ((params: import("ag-grid-community").SuppressHeaderKeyboardEventParams<any, any, any>) => boolean); columnGroupShow?: "open" | "closed"; toolPanelClass?: string | string[] | ((params: import("@ag-grid-community/core").ToolPanelClassParams<any>) => string | string[] | undefined) | ((params: import("ag-grid-community").ToolPanelClassParams<any, any, any>) => string | string[] | undefined); suppressColumnsToolPanel?: boolean; suppressFiltersToolPanel?: boolean; tooltipComponent?: any; tooltipComponentFramework?: any; tooltipComponentParams?: any; pivotKeys?: string[]; filter?: any; filterFramework?: any; filterParams?: any; floatingFilterComponent?: any; floatingFilterComponentFramework?: any; floatingFilterComponentParams?: any; cellDataType?: boolean | string; allowFormula?: boolean; tooltipComponentSelector?: import("ag-grid-community").CellEditorSelectorFunc | import("ag-grid-community").CellRendererSelectorFunc; useValueFormatterForExport?: boolean; useValueParserForImport?: boolean; suppressFloatingFilterButton?: boolean; dateComponent?: any; dateComponentParams?: any; getFindText?: import("ag-grid-community").GetFindTextFunc<any, any, any>; columnChooserParams?: import("ag-grid-community").ColumnChooserParams; suppressHeaderMenuButton?: boolean; suppressHeaderFilterButton?: boolean; mainMenuItems?: import("ag-grid-community").GetMainMenuItems<any, any> | (import("ag-grid-community").MenuItemDef<any, any> | import("ag-grid-community").DefaultMenuItem)[]; contextMenuItems?: import("ag-grid-community").GetContextMenuItems<any, any> | (import("ag-grid-community").MenuItemDef<any, any> | import("ag-grid-community").DefaultMenuItem)[]; loadingCellRenderer?: any; loadingCellRendererParams?: any; loadingCellRendererSelector?: import("ag-grid-community").ILoadingCellRendererSelectorFunc<any, any, any>; rowGroupingHierarchy?: (string | ColDef<any, any>)[]; groupHierarchy?: (string | ColDef<any, any>)[]; spanRows?: boolean | ((params: import("ag-grid-community").SpanRowsParams<any, any, any>) => boolean); suppressSpanHeaderHeight?: boolean; headerTooltipValueGetter?: (params: import("ag-grid-community").ITooltipParams<any, any, any>) => string | any; headerStyle?: import("ag-grid-community").HeaderStyle | import("ag-grid-community").HeaderStyleFunc<any, any, any>; cellAriaRole?: string; context?: any; suppressHeaderContextMenu?: boolean; })[]>
The merged column definitions.
Remarks
This will favor the column state from the browser's local storage over the deferredColumnStates property on the grid-pro-genesis-datasource element.