ag-grid

module ag.grid { export interface ColDef { /** If sorting by default, set it here. Set to 'asc' or 'desc' */ sort?: string; /** If sorting more than one column by default, the milliseconds when this column was sorted, so we know what order to sort the columns in. */ sortedAt?: number; /** The sort order, provide an array with any of the following in any order ['asc','desc',null] */ sortingOrder?: string[]; /** The name to render in the column header */ headerName: string; /** The field of the row to get the cells data from */ field: string; /** Expression or function to get the cells value. */ headerValueGetter?: string | Function; /** The unique ID to give the column. This is optional. If missing, the ID will default to the field. If both field and colId are missing, a unique ID will be generated. * This ID is used to identify the column in the API for sorting, filtering etc. */ colId?: string; /** Set to true for this column to be hidden. Naturally you might think, it would make more sense to call this field 'visible' and mark it false to hide, * however we want all default values to be false and we want columns to be visible by default. */ hide?: boolean; /** Tooltip for the column header */ headerTooltip?: string; /** Expression or function to get the cells value. */ valueGetter?: string | Function; /** To provide custom rendering to the header. */ headerCellRenderer?: Function | Object; /** CSS class for the header */ headerClass?: string | string[] | ((params: any) => string | string[]); /** Initial width, in pixels, of the cell */ width?: number; /** Min width, in pixels, of the cell */ minWidth?: number; /** Max width, in pixels, of the cell */ maxWidth?: number; /** Class to use for the cell. Can be string, array of strings, or function. */ cellClass?: string | string[]| ((cellClassParams:any) => string | string[]); /** An object of css values. Or a function returning an object of css values. */ cellStyle?: {} | ((params:any) => {}); /** A function for rendering a cell. */ cellRenderer?: Function | {}; /** A function for rendering a floating cell. */ floatingCellRenderer?: Function | {}; /** Name of function to use for aggregation. One of [sum,min,max]. */ aggFunc?: string; /** Comparator function for custom sorting. */ comparator?: Function; /** Set to true to render a selection checkbox in the column. */ checkboxSelection?: boolean; /** Set to true if no menu should be shown for this column header. */ suppressMenu?: boolean; /** Set to true if no sorting should be done for this column. */ suppressSorting?: boolean; /** Set to true if you want the unsorted icon to be shown when no sort is applied to this column. */ unSortIcon?: boolean; /** Set to true if you want this columns width to be fixed during 'size to fit' operation. */ suppressSizeToFit?: boolean; /** Set to true if you do not want this column to be resizable by dragging it's edge. */ suppressResize?: boolean; /** If grouping columns, the group this column belongs to. */ headerGroup?: string; /** Whether to show the column when the group is open / closed. */ headerGroupShow?: string; /** Set to true if this col is editable, otherwise false. Can also be a function to have different rows editable. */ editable?: boolean | (Function); /** Callbacks for editing.See editing section for further details. */ newValueHandler?: Function; /** If true, this cell gets refreshed when api.softRefreshView() gets called. */ volatile?: boolean; /** Cell template to use for cell. Useful for AngularJS cells. */ template?: string; /** Cell template URL to load template from to use for cell. Useful for AngularJS cells. */ templateUrl?: string; /** one of the built in filter names: [set, number, text], or a filter function*/ filter?: string | Function; /** The filter params are specific to each filter! */ filterParams?: SetFilterParameters | TextAndNumberFilterParameters; /** Rules for applying css classes */ cellClassRules?: { [cssClassName: string]: (Function | string) }; /** Callbacks for editing.See editing section for further details. */ onCellValueChanged?: Function; /** Function callback, gets called when a cell is clicked. */ onCellClicked?: Function; /** Function callback, gets called when a cell is double clicked. */ onCellDoubleClicked?: Function; /** Function callback, gets called when a cell is right clicked. */ onCellContextMenu?: Function; } }