Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ICellRendererParams
    • ActionCell

Index

Properties

actions: MenuKebabAction<any>[]
api: GridApi

The grid api.

colDef?: ColDef

The cell's column definition.

column?: Column

The cell's column.

columnApi: ColumnApi

The column api.

context: any

Application context as set on gridOptions.context.

data: any

The row's data.

eGridCell: HTMLElement

The grid's cell, a DOM div element.

eParentOfValue: HTMLElement

The parent DOM item for the cell renderer, same as eGridCell unless using checkbox selection.

fullWidth?: boolean

True if this is a full width row.

node: RowNode

The row node.

pinned?: string

Pinned state of the cell.

rowIndex: number

The current index of the row (this changes after filter and sort).

value: any

Value to be rendered.

valueFormatted: any

Formatted value to be rendered.

Methods

  • formatValue(value: any): any
  • Convenience function to format a value using the column's formatter.

    Parameters

    • value: any

    Returns any

  • getValue(): any
  • Convenience function to get most recent up to date value.

    Returns any

  • refreshCell(): void
  • Convenience function to refresh the cell.

    Returns void

  • registerRowDragger(rowDraggerElement: HTMLElement, dragStartPixels?: number, value?: string, suppressVisibilityChange?: boolean): void
  • registerRowDragger:

    Parameters

    • rowDraggerElement: HTMLElement

      The HTMLElement to be used as Row Dragger

    • Optional dragStartPixels: number

      The amount of pixels required to start the drag (Default: 4)

    • Optional value: string

      The value to be displayed while dragging. Note: Only relevant with Full Width Rows.

    • Optional suppressVisibilityChange: boolean

      Set to true to prevent the Grid from hiding the Row Dragger when it is disabled.

    Returns void

  • setValue(value: any): void
  • Convenience function to set the value.

    Parameters

    • value: any

    Returns void

Generated using TypeDoc