ag-grid
Version:
Advanced Data Grid / Data Table supporting Javascript / React / AngularJS / Web Components
146 lines (145 loc) • 5.46 kB
TypeScript
// Type definitions for ag-grid v18.1.2
// Project: http://www.ag-grid.com/
// Definitions by: Niall Crosby <https://github.com/ag-grid/>
import { ColumnGroupChild } from "./columnGroupChild";
import { OriginalColumnGroupChild } from "./originalColumnGroupChild";
import { AbstractColDef, ColDef, IAggFunc } from "./colDef";
import { RowNode } from "./rowNode";
import { IEventEmitter } from "../interfaces/iEventEmitter";
import { ColumnEventType } from "../events";
import { ColumnGroup } from "./columnGroup";
export declare class Column implements ColumnGroupChild, OriginalColumnGroupChild, IEventEmitter {
static EVENT_MOVING_CHANGED: string;
static EVENT_LEFT_CHANGED: string;
static EVENT_WIDTH_CHANGED: string;
static EVENT_LAST_LEFT_PINNED_CHANGED: string;
static EVENT_FIRST_RIGHT_PINNED_CHANGED: string;
static EVENT_VISIBLE_CHANGED: string;
static EVENT_FILTER_CHANGED: string;
static EVENT_FILTER_ACTIVE_CHANGED: string;
static EVENT_SORT_CHANGED: string;
static EVENT_MENU_VISIBLE_CHANGED: string;
static EVENT_ROW_GROUP_CHANGED: string;
static EVENT_PIVOT_CHANGED: string;
static EVENT_VALUE_CHANGED: string;
static PINNED_RIGHT: string;
static PINNED_LEFT: string;
static SORT_ASC: string;
static SORT_DESC: string;
private gridOptionsWrapper;
private columnUtils;
private frameworkFactory;
private columnApi;
private gridApi;
private colDef;
private colId;
private actualWidth;
private visible;
private pinned;
private left;
private oldLeft;
private aggFunc;
private sort;
private sortedAt;
private moving;
private menuVisible;
private lockPosition;
private lockPinned;
private lockVisible;
private lastLeftPinned;
private firstRightPinned;
private minWidth;
private maxWidth;
private filterActive;
private eventService;
private fieldContainsDots;
private tooltipFieldContainsDots;
private rowGroupActive;
private pivotActive;
private aggregationActive;
private primary;
private parent;
constructor(colDef: ColDef, colId: String, primary: boolean);
isLockPosition(): boolean;
isLockVisible(): boolean;
isLockPinned(): boolean;
setParent(parent: ColumnGroup): void;
getParent(): ColumnGroup;
initialise(): void;
isEmptyGroup(): boolean;
isRowGroupDisplayed(colId: string): boolean;
getUniqueId(): string;
isPrimary(): boolean;
isFilterAllowed(): boolean;
isFieldContainsDots(): boolean;
isTooltipFieldContainsDots(): boolean;
private validate();
addEventListener(eventType: string, listener: Function): void;
removeEventListener(eventType: string, listener: Function): void;
private createIsColumnFuncParams(rowNode);
isSuppressNavigable(rowNode: RowNode): boolean;
isCellEditable(rowNode: RowNode): boolean;
isRowDrag(rowNode: RowNode): boolean;
isCellCheckboxSelection(rowNode: RowNode): boolean;
isSuppressPaste(rowNode: RowNode): boolean;
isResizable(): boolean;
private isColumnFunc(rowNode, value);
setMoving(moving: boolean, source?: ColumnEventType): void;
private createColumnEvent(type, source);
isMoving(): boolean;
getSort(): string;
setSort(sort: string, source?: ColumnEventType): void;
setMenuVisible(visible: boolean, source?: ColumnEventType): void;
isMenuVisible(): boolean;
isSortAscending(): boolean;
isSortDescending(): boolean;
isSortNone(): boolean;
isSorting(): boolean;
getSortedAt(): number;
setSortedAt(sortedAt: number): void;
setAggFunc(aggFunc: string | IAggFunc): void;
getAggFunc(): string | IAggFunc;
getLeft(): number;
getOldLeft(): number;
getRight(): number;
setLeft(left: number, source?: ColumnEventType): void;
isFilterActive(): boolean;
setFilterActive(active: boolean, source?: ColumnEventType): void;
setPinned(pinned: string | boolean): void;
setFirstRightPinned(firstRightPinned: boolean, source?: ColumnEventType): void;
setLastLeftPinned(lastLeftPinned: boolean, source?: ColumnEventType): void;
isFirstRightPinned(): boolean;
isLastLeftPinned(): boolean;
isPinned(): boolean;
isPinnedLeft(): boolean;
isPinnedRight(): boolean;
getPinned(): string;
setVisible(visible: boolean, source?: ColumnEventType): void;
isVisible(): boolean;
getColDef(): ColDef;
getColumnGroupShow(): string;
getColId(): string;
getId(): string;
getDefinition(): AbstractColDef;
getActualWidth(): number;
private createBaseColDefParams(rowNode);
getColSpan(rowNode: RowNode): number;
getRowSpan(rowNode: RowNode): number;
setActualWidth(actualWidth: number, source?: ColumnEventType): void;
isGreaterThanMax(width: number): boolean;
getMinWidth(): number;
getMaxWidth(): number;
setMinimum(source?: ColumnEventType): void;
setRowGroupActive(rowGroup: boolean, source?: ColumnEventType): void;
isRowGroupActive(): boolean;
setPivotActive(pivot: boolean, source?: ColumnEventType): void;
isPivotActive(): boolean;
isAnyFunctionActive(): boolean;
isAnyFunctionAllowed(): boolean;
setValueActive(value: boolean, source?: ColumnEventType): void;
isValueActive(): boolean;
isAllowPivot(): boolean;
isAllowValue(): boolean;
isAllowRowGroup(): boolean;
getMenuTabs(defaultValues: string[]): string[];
}