Class ACellRenderer<T>`Abstract`

See

ARowRenderer which manages multiple columns per row

Type Parameters

T extends IColumn

Hierarchy (view full)

ARowRenderer
- ACellRenderer

Constructors

constructor

new ACellRenderer<T>(root, htmlId, options?): ACellRenderer<T>
Type Parameters
- T extends IColumn
Parameters
- root: HTMLElement
- htmlId: string
- options: Partial<IRowRendererOptions> = {}
Returns ACellRenderer<T>
Overrides ARowRenderer.constructor
- Defined in src/ACellRenderer.ts:22

Properties

`Protected` `Readonly` body

body: HTMLElement

`Protected` lastScrollInfo

lastScrollInfo: null | IScrollInfo = null

`Protected` `Readonly` options

options: Readonly<IRowRendererOptions> = ...

`Protected` `Readonly` root

root: HTMLElement

`Protected` `Readonly` style

style: GridStyleManager

`Protected` `Readonly` visible

visible: {
    first: number;
    forcedFirst: number;
    forcedLast: number;
    last: number;
} = ...

currently visible slice

Type declaration

first: number
forcedFirst: number
forcedLast: number
last: number

`Protected` visibleFirstRowPos

visibleFirstRowPos: number = 0

position of the first visible row in pixel

Accessors

`Protected` bodyScroller

get bodyScroller(): HTMLElement
get the scrolling container i.e. parent of the body element

Returns HTMLElement
Inherited from ARowRenderer.bodyScroller
- Defined in src/ARowRenderer.ts:175

`Protected` bodySizer

get bodySizer(): HTMLElement
Returns HTMLElement
Inherited from ARowRenderer.bodySizer
- Defined in src/ARowRenderer.ts:179

`Protected` `Abstract` context

get context(): ICellRenderContext<T>
the current render context, upon change recreate the whole table

Returns ICellRenderContext<T>
Overrides ARowRenderer.context
- Defined in src/ACellRenderer.ts:157

`Protected` header

get header(): HTMLElement
get the header root element

Returns HTMLElement
- Defined in src/ACellRenderer.ts:85

`Protected` headerScroller

get headerScroller(): HTMLElement
get the header scrolling element, i.e its parent

Returns HTMLElement
- Defined in src/ACellRenderer.ts:93

`Protected` idPrefix

get idPrefix(): string
Returns string
Overrides ARowRenderer.idPrefix
- Defined in src/ACellRenderer.ts:78

`Protected` visibleColumns

get visibleColumns(): IVisibleColumns
Returns IVisibleColumns
- Defined in src/ACellRenderer.ts:97

`Protected` visibleFirstColumnPos

get visibleFirstColumnPos(): number
Returns number
- Defined in src/ACellRenderer.ts:101

Methods

`Protected` addColumnMixin

addColumnMixin(mixinClass, options?): void
add another column mixin
Parameters
- mixinClass: IMixinClass
  mixing class to instantiate
- Optional options: unknown
  optional options
Returns void
- Defined in src/ACellRenderer.ts:110

`Protected` addMixin

addMixin(MixinClass, options?): void
register another mixin to this renderer
Parameters
- MixinClass: IMixinClass
  the mixin class to instantiate
- Optional options: unknown
  optional constructor options
Returns void
Inherited from ARowRenderer.addMixin
- Defined in src/ARowRenderer.ts:141

`Protected` clearPool

clearPool(): void
clears the row pool used for faster creation

Returns void
Overrides ARowRenderer.clearPool
- Defined in src/ACellRenderer.ts:256

`Protected` `Abstract` createCell

createCell(document, index, column): HTMLElement | IAsyncUpdate<HTMLElement>
create a new cell node fo the given row index and column
Parameters
- document: Document
  document the create nodes of
- index: number
  the current row index
- column: T
  the current column
Returns HTMLElement | IAsyncUpdate<HTMLElement>
the node representing the cell
- Defined in src/ACellRenderer.ts:182

`Protected` `Abstract` createHeader

createHeader(document, column): HTMLElement | IAsyncUpdate<HTMLElement>
create a new header node for the given column
Parameters
- document: Document
  document to create nodes of
- column: T
  the column to create the header for
Returns HTMLElement | IAsyncUpdate<HTMLElement>
the node representing the header
- Defined in src/ACellRenderer.ts:165

`Protected` createRow

createRow(node, rowIndex): void
creates a new row
Parameters
- node: HTMLElement
  the node of the row
- rowIndex: number
  the row index
Returns void
either an abortable or nothing
Overrides ARowRenderer.createRow
- Defined in src/ACellRenderer.ts:261

destroy

destroy(): void
destroys this renderer and unregisters all event listeners

Returns void
Overrides ARowRenderer.destroy
- Defined in src/ACellRenderer.ts:137

`Protected` forEachRow

forEachRow(callback, inPlace?): void
utility to execute a function for each visible row
Parameters
- callback: ((row, rowIndex) => void)
  callback to execute
  - - (row, rowIndex): void
    - Parameters
      row: HTMLElement
      rowIndex: number
      Returns void
- inPlace: boolean = false
  whether the DOM changes should be performed in place instead of in a fragment
Returns void
Inherited from ARowRenderer.forEachRow
- Defined in src/ARowRenderer.ts:398

`Protected` handleCellReady

handleCellReady(item, ready, column?): HTMLElement
Parameters
- item: HTMLElement
- ready: IAbortAblePromise<void>
- column: number = -1
Returns HTMLElement
- Defined in src/ACellRenderer.ts:204

`Protected` init

init(): void
initialized this renderer

Returns void
Overrides ARowRenderer.init
- Defined in src/ACellRenderer.ts:117

`Protected` onScrolledHorizontally

onScrolledHorizontally(scrollLeft, clientWidth, isGoingRight): EScrollResult
will be called when scrolled horizontally
Parameters
- scrollLeft: number
- clientWidth: number
- isGoingRight: boolean
Returns EScrollResult
- Defined in src/ACellRenderer.ts:149

`Protected` onScrolledVertically

onScrolledVertically(scrollTop, clientHeight, isGoingDown): EScrollResult
scrolling vertically
Parameters
- scrollTop: number
  top scrolling
- clientHeight: number
  visible height
- isGoingDown: boolean
  hint whether the scrollTop increases
Returns EScrollResult
full in case of a full rebuild or partial update
Inherited from ARowRenderer.onScrolledVertically
- Defined in src/ARowRenderer.ts:811

`Protected` recreate

recreate(ctx?): void
triggers to recreate the whole table
Parameters
- Optional ctx: IAnimationContext
  optional animation context
Returns void
Overrides ARowRenderer.recreate
- Defined in src/ACellRenderer.ts:246

`Protected` recycleCell

recycleCell(item, column?): void
Parameters
- item: HTMLElement
- column: number = -1
Returns void
- Defined in src/ACellRenderer.ts:208

`Protected` revalidate

revalidate(): void
triggers a revalidation of the current scrolling offset

Returns void
Inherited from ARowRenderer.revalidate
- Defined in src/ARowRenderer.ts:798

`Protected` update

update(): void
triggers and visual update of all visible rows

Returns void
Inherited from ARowRenderer.update
- Defined in src/ARowRenderer.ts:375

`Protected` `Abstract` updateCell

updateCell(node, index, column): void | HTMLElement | IAsyncUpdate<HTMLElement>
updates the given cell node with the given row index and column
Parameters
- node: HTMLElement
  node to update
- index: number
  row index to use
- column: T
  column to use
Returns void | HTMLElement | IAsyncUpdate<HTMLElement>
an optional new replacement node for the header
- Defined in src/ACellRenderer.ts:191

`Protected` updateColumnWidths

updateColumnWidths(): void
triggers to update all column widths

Returns void
- Defined in src/ACellRenderer.ts:215

`Protected` `Abstract` updateHeader

updateHeader(node, column): void | HTMLElement | IAsyncUpdate<HTMLElement>
updates the given header node with the given column
Parameters
- node: HTMLElement
  node to update
- column: T
  the column to represents
Returns void | HTMLElement | IAsyncUpdate<HTMLElement>
an optional new replacement node for the header
- Defined in src/ACellRenderer.ts:173

`Protected` updateHeaders

updateHeaders(): void
trigger to update all headers

Returns void
- Defined in src/ACellRenderer.ts:200

`Protected` updateOffset

updateOffset(firstRowPos): void
Parameters
- firstRowPos: number
Returns void
Inherited from ARowRenderer.updateOffset
- Defined in src/ARowRenderer.ts:485

`Protected` updateRow

updateRow(node, rowIndex): void
updates a row
Parameters
- node: HTMLElement
  the node of the row
- rowIndex: number
  the row index
Returns void
either an abortable or nothing
Overrides ARowRenderer.updateRow
- Defined in src/ACellRenderer.ts:265

`Protected` updateShifts

updateShifts(top, _left): void
Parameters
- top: number
- _left: number
Returns void
- Defined in src/ACellRenderer.ts:238

`Protected` updateSizer

updateSizer(firstRowPos): void
Parameters
- firstRowPos: number
Returns void
Overrides ARowRenderer.updateSizer
- Defined in src/ACellRenderer.ts:226

Class ACellRenderer<T>Abstract

See

Type Parameters

T extends IColumn

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends IColumn

Parameters

root: HTMLElement

htmlId: string

options: Partial<IRowRendererOptions> = {}

Returns ACellRenderer<T>

Properties

Protected Readonly body

Protected lastScrollInfo

Protected Readonly options

Protected Readonly root

Protected Readonly style

Protected Readonly visible

Type declaration

first: number

forcedFirst: number

forcedLast: number

last: number

Protected visibleFirstRowPos

Accessors

Protected bodyScroller

Returns HTMLElement

Protected bodySizer

Returns HTMLElement

Protected Abstract context

Returns ICellRenderContext<T>

Protected header

Returns HTMLElement

Protected headerScroller

Returns HTMLElement

Protected idPrefix

Returns string

Protected visibleColumns

Returns IVisibleColumns

Protected visibleFirstColumnPos

Returns number

Methods

Protected addColumnMixin

Parameters

mixinClass: IMixinClass

Optional options: unknown

Returns void

Protected addMixin

Parameters

MixinClass: IMixinClass

Optional options: unknown

Returns void

Protected clearPool

Returns void

Protected Abstract createCell

Parameters

document: Document

index: number

column: T

Returns HTMLElement | IAsyncUpdate<HTMLElement>

Protected Abstract createHeader

Parameters

document: Document

column: T

Returns HTMLElement | IAsyncUpdate<HTMLElement>

Protected createRow

Parameters

node: HTMLElement

rowIndex: number

Returns void

destroy

Returns void

Class ACellRenderer<T>`Abstract`

`Protected` `Readonly` body

`Protected` lastScrollInfo

`Protected` `Readonly` options

`Protected` `Readonly` root

`Protected` `Readonly` style

`Protected` `Readonly` visible

`Protected` visibleFirstRowPos

`Protected` bodyScroller

`Protected` bodySizer

`Protected` `Abstract` context

`Protected` header

`Protected` headerScroller

`Protected` idPrefix

`Protected` visibleColumns

`Protected` visibleFirstColumnPos

`Protected` addColumnMixin

`Optional` options: unknown

`Protected` addMixin

`Optional` options: unknown

`Protected` clearPool

`Protected` `Abstract` createCell

`Protected` `Abstract` createHeader

`Protected` createRow

`Protected` forEachRow

`Protected` handleCellReady

`Protected` init

`Protected` onScrolledHorizontally

`Protected` onScrolledVertically

`Protected` recreate

`Optional` ctx: IAnimationContext

`Protected` recycleCell

`Protected` revalidate

`Protected` update

`Protected` `Abstract` updateCell

`Protected` updateColumnWidths

`Protected` `Abstract` updateHeader

`Protected` updateHeaders

`Protected` updateOffset

`Protected` updateRow

`Protected` updateShifts