GridCellRenderer<TData>

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

Extends

• CanvasRenderer

Extended by

• GridCellRendererProxy

Type Parameters

Type Parameter	Default type
TData	any

Constructors

Constructor

new GridCellRenderer<TData>(): GridCellRenderer<TData>

Returns

GridCellRenderer<TData>

Inherited from

CanvasRenderer.constructor

Properties

Property	Type	Default value	Defined in
clip	boolean	true	js-api/src/grid.ts:1484

Accessors

cellType

Get Signature

get cellType(): string

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

Returns

string

---

defaultHeight

Get Signature

get defaultHeight(): number | null

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

Returns

number | null

Inherited from

CanvasRenderer.defaultHeight

---

defaultWidth

Get Signature

get defaultWidth(): number | null

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

Returns

number | null

Inherited from

CanvasRenderer.defaultWidth

---

name

Get Signature

get name(): string

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

Returns

string

Methods

getContextValue()

getContextValue(gridCell): Promise<any>

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

Parameters

Parameter	Type
gridCell	GridCell<TData>

Returns

Promise<any>

---

getDefaultSize()

getDefaultSize(gridColumn): object

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

Parameters

Parameter	Type
gridColumn	GridColumn

Returns

object

Name	Type	Defined in
height?	number | null	js-api/src/grid.ts:1473
width?	number | null	js-api/src/grid.ts:1473

Inherited from

CanvasRenderer.getDefaultSize

---

hasContextValue()

hasContextValue(gridCell): boolean

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

Parameters

Parameter	Type
gridCell	GridCell<TData>

Returns

boolean

---

onClick()

onClick(gridCell, e): void

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

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

---

onDoubleClick()

onDoubleClick(gridCell, e): void

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

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

---

onKeyDown()

onKeyDown(gridCell, e): void

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

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	KeyboardEvent

Returns

void

---

onKeyPress()

onKeyPress(gridCell, e): void

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

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	KeyboardEvent

Returns

void

---

onMouseDown()

onMouseDown(gridCell, e): void

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

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

---

onMouseEnter()

onMouseEnter(gridCell, e): void

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

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

---

onMouseLeave()

onMouseLeave(gridCell, e): void

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

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

---

onMouseMove()

onMouseMove(gridCell, e): void

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

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

---

onMouseUp()

onMouseUp(gridCell, e): void

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

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

---

render()

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

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

Parameters

Parameter	Type
g	CanvasRenderingContext2D
x	number
y	number
w	number
h	number
value	any
context	any

Returns

void

Inherited from

CanvasRenderer.render

---

renderInternal()

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

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

Parameters

Parameter	Type
g	CanvasRenderingContext2D
x	number
y	number
w	number
h	number
gridCell	GridCell<TData>
cellStyle	GridCellStyle

Returns

void

---

renderSettings()

renderSettings(gridColumn): Element | null

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

Parameters

Parameter	Type
gridColumn	GridColumn<TData>

Returns

Element | null

---

byName()

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

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

Parameters

Parameter	Type
rendererName	string

Returns

GridCellRenderer<any> | null

---

register()

static register(renderer): void

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

Parameters

Parameter	Type
renderer	any

Returns

void