GridCellRenderer<TData>

Extends

• CanvasRenderer

Extended by

• GridCellRendererProxy

Type parameters

Type parameter	Value
TData	any

Constructors

new GridCellRenderer()

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

Returns

GridCellRenderer<TData>

Inherited from

CanvasRenderer . constructor

Properties

Property	Type	Default value
clip	boolean	true

Accessors

cellType

get cellType(): string

Returns

string

Source

src/grid.ts:1260

---

defaultHeight

get defaultHeight(): null | number

Returns

null | number

Source

src/grid.ts:1239

---

defaultWidth

get defaultWidth(): null | number

Returns

null | number

Source

src/grid.ts:1235

---

name

get name(): string

Returns

string

Source

src/grid.ts:1256

Methods

getContextValue()

getContextValue(gridCell): Promise<any>

Parameters

Parameter	Type
gridCell	GridCell<TData>

Returns

Promise<any>

Source

src/grid.ts:1290

---

getDefaultSize()

getDefaultSize(gridColumn): object

Parameters

Parameter	Type
gridColumn	GridColumn<any>

Returns

object

Member	Type
height	null | number
width	null | number

Inherited from

CanvasRenderer . getDefaultSize

Source

src/grid.ts:1243

---

hasContextValue()

hasContextValue(gridCell): boolean

Parameters

Parameter	Type
gridCell	GridCell<TData>

Returns

boolean

Source

src/grid.ts:1289

---

onClick()

onClick(gridCell, e): void

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

Source

src/grid.ts:1300

---

onDoubleClick()

onDoubleClick(gridCell, e): void

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

Source

src/grid.ts:1301

---

onKeyDown()

onKeyDown(gridCell, e): void

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	KeyboardEvent

Returns

void

Source

src/grid.ts:1292

---

onKeyPress()

onKeyPress(gridCell, e): void

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	KeyboardEvent

Returns

void

Source

src/grid.ts:1293

---

onMouseDown()

onMouseDown(gridCell, e): void

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

Source

src/grid.ts:1297

---

onMouseEnter()

onMouseEnter(gridCell, e): void

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

Source

src/grid.ts:1295

---

onMouseLeave()

onMouseLeave(gridCell, e): void

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

Source

src/grid.ts:1296

---

onMouseMove()

onMouseMove(gridCell, e): void

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

Source

src/grid.ts:1299

---

onMouseUp()

onMouseUp(gridCell, e): void

Parameters

Parameter	Type
gridCell	GridCell<TData>
e	MouseEvent

Returns

void

Source

src/grid.ts:1298

---

render()

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

Parameters

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

Returns

void

Inherited from

CanvasRenderer . render

Source

src/grid.ts:1247

---

renderInternal()

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

Parameters

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

Returns

void

Source

src/grid.ts:1266

---

renderSettings()

renderSettings(gridColumn): null | Element

Parameters

Parameter	Type
gridColumn	GridColumn<TData>

Returns

null | Element

Source

src/grid.ts:1264

---

byName()

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

Parameters

Parameter	Type
rendererName	string

Returns

null | GridCellRenderer<any>

Source

src/grid.ts:1285

---

register()

static register(renderer): void

Parameters

Parameter	Type
renderer	any

Returns

void

Source

src/grid.ts:1281