Class ACellRenderer<T>`Abstract`

See

ARowRenderer which manages multiple columns per row

Type Parameters

T extends IColumn

Hierarchy (View Summary)

ARowRenderer
- ACellRenderer

Constructors

constructor

new ACellRenderer<T extends IColumn>(
    root: HTMLElement,
    htmlId: string,
    options?: Partial<IRowRendererOptions>,
): 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:20

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

`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:153

`Protected`header

get header(): HTMLElement
get the header root element

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

`Protected`headerScroller

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

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

`Protected`idPrefix

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

`Protected`visibleColumns

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

`Protected`visibleFirstColumnPos

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

Methods

`Protected`addColumnMixin

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

`Protected`addMixin

addMixin(MixinClass: IMixinClass, options?: unknown): void
register another mixin to this renderer
Parameters
- MixinClass: IMixinClass
  the mixin class to instantiate
- Optionaloptions: 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:252

`Protected` `Abstract`createCell

createCell(
    document: Document,
    index: number,
    column: T,
): 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:178

`Protected` `Abstract`createHeader

createHeader(
document: Document,
column: T,
): 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:161

`Protected`createRow

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

destroy

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

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

`Protected`forEachRow

forEachRow(
callback: (row: HTMLElement, rowIndex: number) => void,
inPlace?: boolean,
): void
utility to execute a function for each visible row
Parameters
- callback: (row: HTMLElement, rowIndex: number) => void
  callback to execute
- 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:397

`Protected`handleCellReady

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

`Protected`init

init(): void
initialized this renderer

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

`Protected`onScrolledHorizontally

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

`Protected`onScrolledVertically

onScrolledVertically(
    scrollTop: number,
    clientHeight: number,
    isGoingDown: boolean,
): 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:810

`Protected`recreate

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

`Protected`recycleCell

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

`Protected`revalidate

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

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

`Protected`update

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

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

`Protected` `Abstract`updateCell

updateCell(
    node: HTMLElement,
    index: number,
    column: T,
): 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:187

`Protected`updateColumnWidths

updateColumnWidths(): void
triggers to update all column widths

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

`Protected` `Abstract`updateHeader

updateHeader(
node: HTMLElement,
column: T,
): 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:169

`Protected`updateHeaders

updateHeaders(): void
trigger to update all headers

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

`Protected`updateOffset

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

`Protected`updateRow

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

`Protected`updateShifts

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

`Protected`updateSizer

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

Class ACellRenderer<T>Abstract

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ACellRenderer<T>

Properties

Protected Readonlybody

ProtectedlastScrollInfo

Protected Readonlyoptions

Protected Readonlyroot

Protected Readonlystyle

Protected Readonlyvisible

ProtectedvisibleFirstRowPos

Accessors

ProtectedbodyScroller

Returns HTMLElement

ProtectedbodySizer

Returns HTMLElement

Protected Abstractcontext

Returns ICellRenderContext<T>

Protectedheader

Returns HTMLElement

ProtectedheaderScroller

Returns HTMLElement

ProtectedidPrefix

Returns string

ProtectedvisibleColumns

Returns IVisibleColumns

ProtectedvisibleFirstColumnPos

Returns number

Methods

ProtectedaddColumnMixin

Parameters

Returns void

ProtectedaddMixin

Parameters

Returns void

ProtectedclearPool

Returns void

Protected AbstractcreateCell

Parameters

Returns HTMLElement | IAsyncUpdate<HTMLElement>

Protected AbstractcreateHeader

Parameters

Returns HTMLElement | IAsyncUpdate<HTMLElement>

ProtectedcreateRow

Parameters

Returns void

destroy

Returns void

ProtectedforEachRow

Parameters

Returns void

ProtectedhandleCellReady

Parameters

Returns HTMLElement

Protectedinit

Returns void

ProtectedonScrolledHorizontally

Parameters

Returns EScrollResult

ProtectedonScrolledVertically

Parameters

Returns EScrollResult

Protectedrecreate

Parameters

Returns void

ProtectedrecycleCell

Parameters

Returns void

Protectedrevalidate

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

`Protected`addMixin

`Protected`clearPool

`Protected` `Abstract`createCell

`Protected` `Abstract`createHeader

`Protected`createRow

`Protected`forEachRow

`Protected`handleCellReady

`Protected`init

`Protected`onScrolledHorizontally

`Protected`onScrolledVertically

`Protected`recreate

`Protected`recycleCell

`Protected`revalidate

`Protected`update

`Protected` `Abstract`updateCell

`Protected`updateColumnWidths

`Protected` `Abstract`updateHeader

`Protected`updateHeaders

`Protected`updateOffset

`Protected`updateRow

`Protected`updateShifts

`Protected`updateSizer