Skip to Content
APIAG GridChildGridToggleCellRendererParams

ChildGridToggleCellRendererParams type

Tip

This API reference is automatically generated from the source code  of the @jsoc/vue-grid-ag  package.

View Declaration

export type ChildGridToggleCellRendererParams = ICellRendererParams<GridRow> &
  ChildGridToggleCellRendererCustomParams;

Fields

NameTypeDefault
valueany

Value to be rendered.

valueFormattedstring | null | undefined

Formatted value to be rendered.

fullWidthboolean

True if this is a full width row.

pinned"left" | "right" | null

Pinned state of the cell.

dataUJSONObject | undefined

The row’s data. Data property can be undefined when row grouping or loading infinite row models.

nodeIRowNode<UJSONObject>

The row node.

colDefColDef<UJSONObject, any>

The cell’s column definition.

columnColumn<any>

The cell’s column.

eGridCellHTMLElement

The grid’s cell, a DOM div element.

eParentOfValueHTMLElement

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

getValue() => any

Convenience function to get most recent up to data value.

setValue(value: any) => void

Convenience function to set the value.

formatValue(value: any) => string

Convenience function to format a value using the column’s formatter.

refreshCell() => void

Convenience function to refresh the cell.

registerRowDragger(rowDraggerElement: HTMLElement, dragStartPixels?: number | undefined, value?: string | undefined, suppressVisibilityChange?: boolean | undefined) => void

registerRowDragger:

setTooltip(value: string, shouldDisplayTooltip?: (() => boolean) | undefined) => void

Sets a tooltip to the main element of this component.

apiGridApi<UJSONObject>

The grid api.

contextany

Application context as set on gridOptions.context.

columnParamsColumnGeneratorParams<PluginConfigAg, "ujsonObject" | "ujsonObjectArray">
ChildGridToggleCellRendererCustomParamsPluginConfigAg