columnApi.d.ts 4.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. import { ColDef, ColGroupDef } from "../entities/colDef";
  2. import { ColumnGroupChild } from "../entities/columnGroupChild";
  3. import { ColumnState } from "./columnController";
  4. import { OriginalColumnGroup } from "../entities/originalColumnGroup";
  5. import { ColumnGroup } from "../entities/columnGroup";
  6. import { Column } from "../entities/column";
  7. export declare class ColumnApi {
  8. private columnController;
  9. sizeColumnsToFit(gridWidth: any): void;
  10. setColumnGroupOpened(group: OriginalColumnGroup | string, newValue: boolean): void;
  11. getColumnGroup(name: string, instanceId?: number): ColumnGroup;
  12. getOriginalColumnGroup(name: string): OriginalColumnGroup;
  13. getDisplayNameForColumn(column: Column, location: string | null): string;
  14. getDisplayNameForColumnGroup(columnGroup: ColumnGroup, location: string): string;
  15. getColumn(key: any): Column;
  16. setColumnState(columnState: ColumnState[]): boolean;
  17. getColumnState(): ColumnState[];
  18. resetColumnState(): void;
  19. getColumnGroupState(): {
  20. groupId: string;
  21. open: boolean;
  22. }[];
  23. setColumnGroupState(stateItems: ({
  24. groupId: string;
  25. open: boolean;
  26. })[]): void;
  27. resetColumnGroupState(): void;
  28. isPinning(): boolean;
  29. isPinningLeft(): boolean;
  30. isPinningRight(): boolean;
  31. getDisplayedColAfter(col: Column): Column;
  32. getDisplayedColBefore(col: Column): Column;
  33. setColumnVisible(key: string | Column, visible: boolean): void;
  34. setColumnsVisible(keys: (string | Column)[], visible: boolean): void;
  35. setColumnPinned(key: string | Column, pinned: string): void;
  36. setColumnsPinned(keys: (string | Column)[], pinned: string): void;
  37. getAllColumns(): Column[];
  38. getAllGridColumns(): Column[];
  39. getDisplayedLeftColumns(): Column[];
  40. getDisplayedCenterColumns(): Column[];
  41. getDisplayedRightColumns(): Column[];
  42. getAllDisplayedColumns(): Column[];
  43. getAllDisplayedVirtualColumns(): Column[];
  44. moveColumn(key: string | Column, toIndex: number): void;
  45. moveColumnByIndex(fromIndex: number, toIndex: number): void;
  46. moveColumns(columnsToMoveKeys: (string | Column)[], toIndex: number): void;
  47. moveRowGroupColumn(fromIndex: number, toIndex: number): void;
  48. setColumnAggFunc(column: Column, aggFunc: string): void;
  49. setColumnWidth(key: string | Column, newWidth: number, finished?: boolean): void;
  50. setColumnWidths(columnWidths: {
  51. key: string | Column;
  52. newWidth: number;
  53. }[], finished?: boolean): void;
  54. setPivotMode(pivotMode: boolean): void;
  55. isPivotMode(): boolean;
  56. getSecondaryPivotColumn(pivotKeys: string[], valueColKey: string | Column): Column;
  57. setValueColumns(colKeys: (string | Column)[]): void;
  58. getValueColumns(): Column[];
  59. removeValueColumn(colKey: (string | Column)): void;
  60. removeValueColumns(colKeys: (string | Column)[]): void;
  61. addValueColumn(colKey: (string | Column)): void;
  62. addValueColumns(colKeys: (string | Column)[]): void;
  63. setRowGroupColumns(colKeys: (string | Column)[]): void;
  64. removeRowGroupColumn(colKey: string | Column): void;
  65. removeRowGroupColumns(colKeys: (string | Column)[]): void;
  66. addRowGroupColumn(colKey: string | Column): void;
  67. addRowGroupColumns(colKeys: (string | Column)[]): void;
  68. getRowGroupColumns(): Column[];
  69. setPivotColumns(colKeys: (string | Column)[]): void;
  70. removePivotColumn(colKey: string | Column): void;
  71. removePivotColumns(colKeys: (string | Column)[]): void;
  72. addPivotColumn(colKey: string | Column): void;
  73. addPivotColumns(colKeys: (string | Column)[]): void;
  74. getPivotColumns(): Column[];
  75. getLeftDisplayedColumnGroups(): ColumnGroupChild[];
  76. getCenterDisplayedColumnGroups(): ColumnGroupChild[];
  77. getRightDisplayedColumnGroups(): ColumnGroupChild[];
  78. getAllDisplayedColumnGroups(): ColumnGroupChild[];
  79. autoSizeColumn(key: string | Column, skipHeader?: boolean): void;
  80. autoSizeColumns(keys: (string | Column)[], skipHeader?: boolean): void;
  81. autoSizeAllColumns(skipHeader?: boolean): void;
  82. setSecondaryColumns(colDefs: (ColDef | ColGroupDef)[]): void;
  83. getSecondaryColumns(): Column[];
  84. getPrimaryColumns(): Column[];
  85. columnGroupOpened(group: OriginalColumnGroup | string, newValue: boolean): void;
  86. hideColumns(colIds: any, hide: any): void;
  87. hideColumn(colId: any, hide: any): void;
  88. setState(columnState: ColumnState[]): boolean;
  89. getState(): ColumnState[];
  90. resetState(): void;
  91. getAggregationColumns(): Column[];
  92. removeAggregationColumn(colKey: (string | Column)): void;
  93. removeAggregationColumns(colKeys: (string | Column)[]): void;
  94. addAggregationColumn(colKey: (string | Column)): void;
  95. addAggregationColumns(colKeys: (string | Column)[]): void;
  96. setColumnAggFunction(column: Column, aggFunc: string): void;
  97. getDisplayNameForCol(column: any): string;
  98. }