Interface GridParamsApi

interface GridParamsApi {
    getCellElement: ((id: GridRowId, field: string) => null | HTMLDivElement);
    getCellParams: (<R, V, F, N>(id: GridRowId, field: string) => GridCellParams<R, V, F, N>);
    getCellValue: (<V>(id: GridRowId, field: string) => V);
    getColumnHeaderElement: ((field: string) => null | HTMLDivElement);
    getColumnHeaderParams: ((field: string) => GridColumnHeaderParams<GridValidRowModel, any, any>);
    getRowElement: ((id: GridRowId) => null | HTMLDivElement);
    getRowParams: ((id: GridRowId) => GridRowParams<any>);
}

Hierarchy (view full)

Properties

getCellElement getCellParams getCellValue getColumnHeaderElement getColumnHeaderParams getRowElement getRowParams

Properties

getCellElement

getCellElement: ((id: GridRowId, field: string) => null | HTMLDivElement)

Gets the [[GridCellParams]] object that is passed as argument in events.

Type declaration

    • (id, field): null | HTMLDivElement

    • Parameters

      • id: GridRowId

        The id of the row.

      • field: string

        The column field.

      Returns null | HTMLDivElement

      The cell params.

getCellParams

getCellParams: (<R, V, F, N>(id: GridRowId, field: string) => GridCellParams<R, V, F, N>)

Gets the [[GridCellParams]] object that is passed as argument in events.

Type declaration

getCellValue

getCellValue: (<V>(id: GridRowId, field: string) => V)

Gets the value of a cell at the given id and field.

Type declaration

    • <V>(id, field): V

    • Type Parameters

      • V extends unknown = any

      Parameters

      • id: GridRowId

        The id of the row.

      • field: string

        The column field.

      Returns V

      The cell value.

getColumnHeaderElement

getColumnHeaderElement: ((field: string) => null | HTMLDivElement)

Gets the underlying DOM element for the column header with the given field.

Type declaration

    • (field): null | HTMLDivElement

    • Parameters

      • field: string

        The column field.

      Returns null | HTMLDivElement

      The DOM element or null.

getColumnHeaderParams

getColumnHeaderParams: ((field: string) => GridColumnHeaderParams<GridValidRowModel, any, any>)

Gets the [[GridColumnHeaderParams]] object that is passed as argument in events.

Type declaration

getRowElement

getRowElement: ((id: GridRowId) => null | HTMLDivElement)

Gets the underlying DOM element for a row at the given id.

Type declaration

    • (id): null | HTMLDivElement

    • Parameters

      Returns null | HTMLDivElement

      The DOM element or null.

getRowParams

getRowParams: ((id: GridRowId) => GridRowParams<any>)

Gets the [[GridRowParams]] object that is passed as argument in events.

Type declaration

Settings

Member Visibility

On This Page

Properties