column.d.ts 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. import { ColumnGroupChild } from "./columnGroupChild";
  2. import { OriginalColumnGroupChild } from "./originalColumnGroupChild";
  3. import { AbstractColDef, ColDef, IAggFunc } from "./colDef";
  4. import { RowNode } from "./rowNode";
  5. import { IEventEmitter } from "../interfaces/iEventEmitter";
  6. import { ColumnEventType } from "../events";
  7. import { ColumnGroup } from "./columnGroup";
  8. import { OriginalColumnGroup } from "./originalColumnGroup";
  9. export declare class Column implements ColumnGroupChild, OriginalColumnGroupChild, IEventEmitter {
  10. static EVENT_MOVING_CHANGED: string;
  11. static EVENT_LEFT_CHANGED: string;
  12. static EVENT_WIDTH_CHANGED: string;
  13. static EVENT_LAST_LEFT_PINNED_CHANGED: string;
  14. static EVENT_FIRST_RIGHT_PINNED_CHANGED: string;
  15. static EVENT_VISIBLE_CHANGED: string;
  16. static EVENT_FILTER_CHANGED: string;
  17. static EVENT_FILTER_ACTIVE_CHANGED: string;
  18. static EVENT_SORT_CHANGED: string;
  19. static EVENT_MENU_VISIBLE_CHANGED: string;
  20. static EVENT_ROW_GROUP_CHANGED: string;
  21. static EVENT_PIVOT_CHANGED: string;
  22. static EVENT_VALUE_CHANGED: string;
  23. private gridOptionsWrapper;
  24. private columnUtils;
  25. private columnApi;
  26. private gridApi;
  27. private context;
  28. private readonly colId;
  29. private colDef;
  30. private userProvidedColDef;
  31. private actualWidth;
  32. private visible;
  33. private pinned;
  34. private left;
  35. private oldLeft;
  36. private aggFunc;
  37. private sort;
  38. private sortedAt;
  39. private moving;
  40. private menuVisible;
  41. private lastLeftPinned;
  42. private firstRightPinned;
  43. private minWidth;
  44. private maxWidth;
  45. private filterActive;
  46. private eventService;
  47. private fieldContainsDots;
  48. private tooltipFieldContainsDots;
  49. private rowGroupActive;
  50. private pivotActive;
  51. private aggregationActive;
  52. private flex;
  53. private readonly primary;
  54. private parent;
  55. private originalParent;
  56. constructor(colDef: ColDef, userProvidedColDef: ColDef | null, colId: String, primary: boolean);
  57. setColDef(colDef: ColDef, userProvidedColDef: ColDef | null): void;
  58. getUserProvidedColDef(): ColDef;
  59. setParent(parent: ColumnGroup): void;
  60. getParent(): ColumnGroup;
  61. setOriginalParent(originalParent: OriginalColumnGroup | null): void;
  62. getOriginalParent(): OriginalColumnGroup | null;
  63. initialise(): void;
  64. resetActualWidth(): void;
  65. isEmptyGroup(): boolean;
  66. isRowGroupDisplayed(colId: string): boolean;
  67. getUniqueId(): string;
  68. isPrimary(): boolean;
  69. isFilterAllowed(): boolean;
  70. isFieldContainsDots(): boolean;
  71. isTooltipFieldContainsDots(): boolean;
  72. private validate;
  73. addEventListener(eventType: string, listener: Function): void;
  74. removeEventListener(eventType: string, listener: Function): void;
  75. private createIsColumnFuncParams;
  76. isSuppressNavigable(rowNode: RowNode): boolean;
  77. isCellEditable(rowNode: RowNode): boolean;
  78. isRowDrag(rowNode: RowNode): boolean;
  79. isDndSource(rowNode: RowNode): boolean;
  80. isCellCheckboxSelection(rowNode: RowNode): boolean;
  81. isSuppressPaste(rowNode: RowNode): boolean;
  82. isResizable(): boolean;
  83. private isColumnFunc;
  84. setMoving(moving: boolean, source?: ColumnEventType): void;
  85. private createColumnEvent;
  86. isMoving(): boolean;
  87. getSort(): string;
  88. setSort(sort: string | null | undefined, source?: ColumnEventType): void;
  89. setMenuVisible(visible: boolean, source?: ColumnEventType): void;
  90. isMenuVisible(): boolean;
  91. isSortAscending(): boolean;
  92. isSortDescending(): boolean;
  93. isSortNone(): boolean;
  94. isSorting(): boolean;
  95. getSortedAt(): number;
  96. setSortedAt(sortedAt: number | null): void;
  97. setAggFunc(aggFunc: string | IAggFunc | null | undefined): void;
  98. getAggFunc(): string | IAggFunc;
  99. getLeft(): number;
  100. getOldLeft(): number;
  101. getRight(): number;
  102. setLeft(left: number | null, source?: ColumnEventType): void;
  103. isFilterActive(): boolean;
  104. setFilterActive(active: boolean, source?: ColumnEventType, additionalEventAttributes?: any): void;
  105. setPinned(pinned: string | boolean | null | undefined): void;
  106. setFirstRightPinned(firstRightPinned: boolean, source?: ColumnEventType): void;
  107. setLastLeftPinned(lastLeftPinned: boolean, source?: ColumnEventType): void;
  108. isFirstRightPinned(): boolean;
  109. isLastLeftPinned(): boolean;
  110. isPinned(): boolean;
  111. isPinnedLeft(): boolean;
  112. isPinnedRight(): boolean;
  113. getPinned(): 'left' | 'right';
  114. setVisible(visible: boolean, source?: ColumnEventType): void;
  115. isVisible(): boolean;
  116. getColDef(): ColDef;
  117. getColumnGroupShow(): string | undefined;
  118. getColId(): string;
  119. getId(): string;
  120. getDefinition(): AbstractColDef;
  121. getActualWidth(): number;
  122. private createBaseColDefParams;
  123. getColSpan(rowNode: RowNode): number;
  124. getRowSpan(rowNode: RowNode): number;
  125. setActualWidth(actualWidth: number, source?: ColumnEventType): void;
  126. isGreaterThanMax(width: number): boolean;
  127. getMinWidth(): number;
  128. getMaxWidth(): number;
  129. getFlex(): number;
  130. setFlex(flex: number): void;
  131. setMinimum(source?: ColumnEventType): void;
  132. setRowGroupActive(rowGroup: boolean, source?: ColumnEventType): void;
  133. isRowGroupActive(): boolean;
  134. setPivotActive(pivot: boolean, source?: ColumnEventType): void;
  135. isPivotActive(): boolean;
  136. isAnyFunctionActive(): boolean;
  137. isAnyFunctionAllowed(): boolean;
  138. setValueActive(value: boolean, source?: ColumnEventType): void;
  139. isValueActive(): boolean;
  140. isAllowPivot(): boolean;
  141. isAllowValue(): boolean;
  142. isAllowRowGroup(): boolean;
  143. getMenuTabs(defaultValues: string[]): string[];
  144. isLockPosition(): boolean;
  145. isLockVisible(): boolean;
  146. isLockPinned(): boolean;
  147. }