Skip to content

Commit

Permalink
[docs] Improve JSDoc
Browse files Browse the repository at this point in the history
First seen in #68 (comment)
  • Loading branch information
oliviertassinari committed Jul 27, 2020
1 parent 8a3ba2f commit b546c46
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions packages/grid/x-grid-modules/src/models/params/cellParams.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,33 @@ import { CellValue, RowData, RowModel } from '../rows';
*/
export interface CellParams {
/**
* the cell value
* The cell value.
*/
value: CellValue;
/**
* A function that let you get data from other columns
* A function that let you get data from other columns.
*
* @param field
*/
getValue: (field: string) => CellValue;
/**
* The full set of data of the row that the current cell belongs to
* The full set of data of the row that the current cell belongs to.
*/
data: RowData;
/**
* The row model of the row that the current cell belongs to
* The row model of the row that the current cell belongs to.
*/
rowModel: RowModel;
/**
* The column of the row that the current cell belongs to
* The column of the row that the current cell belongs to.
*/
colDef: any;
/**
* The row index of the row that the current cell belongs to
* The row index of the row that the current cell belongs to.
*/
rowIndex: number;
/**
* ApiRef that let you manipulate the grid
* ApiRef that let you manipulate the grid.
*/
api: any;
}
Expand All @@ -39,6 +40,7 @@ export interface CellParams {
* Alias of CellParams.
*/
export type ValueGetterParams = CellParams;

/**
* Alias of CellParams.
*/
Expand Down

0 comments on commit b546c46

Please sign in to comment.