Skip to main content

GridCellRendererProxy

Defined in: js-api/src/grid.ts:1535

Proxy class for the Dart-based grid cell renderers.

Extends

Constructors

Constructor

new GridCellRendererProxy(dart): GridCellRendererProxy

Defined in: js-api/src/grid.ts:1538

Parameters

ParameterType
dartany

Returns

GridCellRendererProxy

Overrides

GridCellRenderer.constructor

Properties

PropertyTypeDefault valueInherited fromDefined in
clipbooleantrueGridCellRenderer.clipjs-api/src/grid.ts:1483
dartanyundefined-js-api/src/grid.ts:1536

Accessors

cellType

Get Signature

get cellType(): string

Defined in: js-api/src/grid.ts:1544

Returns

string

Overrides

GridCellRenderer.cellType


defaultHeight

Get Signature

get defaultHeight(): number | null

Defined in: js-api/src/grid.ts:1468

Returns

number | null

Inherited from

GridCellRenderer.defaultHeight


defaultWidth

Get Signature

get defaultWidth(): number | null

Defined in: js-api/src/grid.ts:1464

Returns

number | null

Inherited from

GridCellRenderer.defaultWidth


name

Get Signature

get name(): string

Defined in: js-api/src/grid.ts:1543

Returns

string

Overrides

GridCellRenderer.name

Methods

getContextValue()

getContextValue(gridCell): Promise<any>

Defined in: js-api/src/grid.ts:1520

Parameters

ParameterType
gridCellGridCell<any>

Returns

Promise<any>

Inherited from

GridCellRenderer.getContextValue


getDefaultSize()

getDefaultSize(gridColumn): object

Defined in: js-api/src/grid.ts:1472

Parameters

ParameterType
gridColumnGridColumn

Returns

object

NameTypeDefined in
height?number | nulljs-api/src/grid.ts:1472
width?number | nulljs-api/src/grid.ts:1472

Inherited from

GridCellRenderer.getDefaultSize


hasContextValue()

hasContextValue(gridCell): boolean

Defined in: js-api/src/grid.ts:1519

Parameters

ParameterType
gridCellGridCell<any>

Returns

boolean

Inherited from

GridCellRenderer.hasContextValue


onClick()

onClick(gridCell, e): void

Defined in: js-api/src/grid.ts:1530

Parameters

ParameterType
gridCellGridCell<any>
eMouseEvent

Returns

void

Inherited from

GridCellRenderer.onClick


onDoubleClick()

onDoubleClick(gridCell, e): void

Defined in: js-api/src/grid.ts:1531

Parameters

ParameterType
gridCellGridCell<any>
eMouseEvent

Returns

void

Inherited from

GridCellRenderer.onDoubleClick


onKeyDown()

onKeyDown(gridCell, e): void

Defined in: js-api/src/grid.ts:1522

Parameters

ParameterType
gridCellGridCell<any>
eKeyboardEvent

Returns

void

Inherited from

GridCellRenderer.onKeyDown


onKeyPress()

onKeyPress(gridCell, e): void

Defined in: js-api/src/grid.ts:1523

Parameters

ParameterType
gridCellGridCell<any>
eKeyboardEvent

Returns

void

Inherited from

GridCellRenderer.onKeyPress


onMouseDown()

onMouseDown(gridCell, e): void

Defined in: js-api/src/grid.ts:1527

Parameters

ParameterType
gridCellGridCell<any>
eMouseEvent

Returns

void

Inherited from

GridCellRenderer.onMouseDown


onMouseEnter()

onMouseEnter(gridCell, e): void

Defined in: js-api/src/grid.ts:1525

Parameters

ParameterType
gridCellGridCell<any>
eMouseEvent

Returns

void

Inherited from

GridCellRenderer.onMouseEnter


onMouseLeave()

onMouseLeave(gridCell, e): void

Defined in: js-api/src/grid.ts:1526

Parameters

ParameterType
gridCellGridCell<any>
eMouseEvent

Returns

void

Inherited from

GridCellRenderer.onMouseLeave


onMouseMove()

onMouseMove(gridCell, e): void

Defined in: js-api/src/grid.ts:1529

Parameters

ParameterType
gridCellGridCell<any>
eMouseEvent

Returns

void

Inherited from

GridCellRenderer.onMouseMove


onMouseUp()

onMouseUp(gridCell, e): void

Defined in: js-api/src/grid.ts:1528

Parameters

ParameterType
gridCellGridCell<any>
eMouseEvent

Returns

void

Inherited from

GridCellRenderer.onMouseUp


render()

render(g, x, y, w, h, value, context): void

Defined in: js-api/src/grid.ts:1546

Parameters

ParameterType
gCanvasRenderingContext2D
xnumber
ynumber
wnumber
hnumber
valueany
contextany

Returns

void

Overrides

GridCellRenderer.render


renderInternal()

renderInternal(g, x, y, w, h, gridCell, cellStyle): void

Defined in: js-api/src/grid.ts:1550

Parameters

ParameterType
gCanvasRenderingContext2D
xnumber
ynumber
wnumber
hnumber
gridCellGridCell
cellStyleGridCellStyle

Returns

void

Overrides

GridCellRenderer.renderInternal


renderSettings()

renderSettings(gridColumn): Element | null

Defined in: js-api/src/grid.ts:1493

Parameters

ParameterType
gridColumnGridColumn<any>

Returns

Element | null

Inherited from

GridCellRenderer.renderSettings


byName()

static byName(rendererName): GridCellRenderer<any> | null

Defined in: js-api/src/grid.ts:1515

Parameters

ParameterType
rendererNamestring

Returns

GridCellRenderer<any> | null

Inherited from

GridCellRenderer.byName


register()

static register(renderer): void

Defined in: js-api/src/grid.ts:1511

Parameters

ParameterType
rendererany

Returns

void

Inherited from

GridCellRenderer.register