Class ACellTableSection<T>`Abstract`

base class for a cell renderer as table section

Type Parameters

T extends IColumn

Hierarchy (view full)

ARowRenderer
- ACellTableSection

Implements

ITableSection

Constructors

constructor

new ACellTableSection<T>(header, body, tableId, style, options?): ACellTableSection<T>
Type Parameters
- T extends IColumn
Parameters
- header: HTMLElement
- body: HTMLElement
- tableId: string
- style: GridStyleManager
- options: Partial<IRowRendererOptions> = {}
Returns ACellTableSection<T>
Overrides ARowRenderer.constructor
- Defined in src/table/ACellTableSection.ts:21

Properties

`Readonly` body

body: HTMLElement

`Readonly` header

header: HTMLElement

`Protected` lastScrollInfo

lastScrollInfo: null | IScrollInfo = null

`Protected` `Readonly` options

options: Readonly<IRowRendererOptions> = ...

`Protected` `Readonly` style

style: GridStyleManager

`Protected` `Readonly` tableId

tableId: string

`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(): ITableCellRenderContext<T>
the current render context, upon change recreate the whole table

Returns ITableCellRenderContext<T>
Overrides ARowRenderer.context
- Defined in src/table/ACellTableSection.ts:178

height

get height(): number
Returns number
Implementation of ITableSection.height
- Defined in src/table/ACellTableSection.ts:97

hidden

get hidden(): boolean
Returns boolean
- Defined in src/table/ACellTableSection.ts:101
set hidden(value): void
Parameters
- value: boolean
Returns void
- Defined in src/table/ACellTableSection.ts:105

`Abstract` id

get id(): string
Returns string
Implementation of ITableSection.id
- Defined in src/table/ACellTableSection.ts:83

`Protected` idPrefix

get idPrefix(): string
Returns string
Overrides ARowRenderer.idPrefix
- Defined in src/table/ACellTableSection.ts:79

`Protected` visibleColumns

get visibleColumns(): IVisibleColumns
Returns IVisibleColumns
- Defined in src/table/ACellTableSection.ts:89

`Protected` visibleFirstColumnPos

get visibleFirstColumnPos(): number
Returns number
- Defined in src/table/ACellTableSection.ts:93

width

get width(): number
Returns number
Implementation of ITableSection.width
- Defined in src/table/ACellTableSection.ts:85

Methods

`Protected` addColumnMixin

addColumnMixin(mixinClass, options?): void
Parameters
- mixinClass: IMixinClass
- Optional options: unknown
Returns void
- Defined in src/table/ACellTableSection.ts:75

`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/table/ACellTableSection.ts:257

`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/table/ACellTableSection.ts:203

`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/table/ACellTableSection.ts:186

`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/table/ACellTableSection.ts:262

destroy

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

Returns void
Implementation of ITableSection.destroy
Overrides ARowRenderer.destroy
- Defined in src/table/ACellTableSection.ts:155

`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/table/ACellTableSection.ts:225

hide

hide(): void
Returns void
Implementation of ITableSection.hide
- Defined in src/table/ACellTableSection.ts:134

init

init(): void
initializes the table and register the onscroll listener

Returns void
nothing
Implementation of ITableSection.init
Overrides ARowRenderer.init
- Defined in src/table/ACellTableSection.ts:149

`Protected` onScrolledHorizontally

onScrolledHorizontally(scrollLeft, clientWidth, isGoingRight): EScrollResult
Parameters
- scrollLeft: number
- clientWidth: number
- isGoingRight: boolean
Returns EScrollResult
- Defined in src/table/ACellTableSection.ts:168

`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
Overrides ARowRenderer.onScrolledVertically
- Defined in src/table/ACellTableSection.ts:161

`Protected` onVisibilityChanged

onVisibilityChanged(_visible): void
hook when the visibility changes
Parameters
- _visible: boolean
  current visibility
Returns void
- Defined in src/table/ACellTableSection.ts:130

`Protected` recreate

recreate(ctx?): void
removes all rows and recreates the table
Parameters
- Optional ctx: IAnimationContext
  optional animation context to create a transition between the previous and the current tables
Returns void
nothing
Overrides ARowRenderer.recreate
- Defined in src/table/ACellTableSection.ts:247

`Protected` recycleCell

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

`Protected` revalidate

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

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

show

show(scrollLeft, clientWidth, isGoingRight): void
show the section
Parameters
- scrollLeft: number
  visible left margin
- clientWidth: number
  visible width
- isGoingRight: boolean
  whether it was a shift to the right
Returns void
Implementation of ITableSection.show
- Defined in src/table/ACellTableSection.ts:138

`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/table/ACellTableSection.ts:212

`Protected` updateColumnWidths

updateColumnWidths(): void
trigger an update all all column widths

Returns void
- Defined in src/table/ACellTableSection.ts:236

`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/table/ACellTableSection.ts:194

`Protected` updateHeaders

updateHeaders(): void
triggers updating the header

Returns void
- Defined in src/table/ACellTableSection.ts:221

`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/table/ACellTableSection.ts:267

`Protected` updateShifts

updateShifts(top, _left): void
Parameters
- top: number
- _left: number
Returns void
- Defined in src/table/ACellTableSection.ts:122

`Protected` updateSizer

updateSizer(firstRowPos): void
Parameters
- firstRowPos: number
Returns void
Overrides ARowRenderer.updateSizer
- Defined in src/table/ACellTableSection.ts:117

Class ACellTableSection<T>Abstract

Type Parameters

T extends IColumn

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends IColumn

Parameters

header: HTMLElement

body: HTMLElement

tableId: string

style: GridStyleManager

options: Partial<IRowRendererOptions> = {}

Returns ACellTableSection<T>

Properties

Readonly body

Readonly header

Protected lastScrollInfo

Protected Readonly options

Protected Readonly style

Protected Readonly tableId

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 ITableCellRenderContext<T>

height

Returns number

hidden

Returns boolean

Parameters

value: boolean

Returns void

Abstract id

Returns string

Protected idPrefix

Returns string

Protected visibleColumns

Returns IVisibleColumns

Protected visibleFirstColumnPos

Returns number

width

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

Class ACellTableSection<T>`Abstract`

`Readonly` body

`Readonly` header

`Protected` lastScrollInfo

`Protected` `Readonly` options

`Protected` `Readonly` style

`Protected` `Readonly` tableId

`Protected` `Readonly` visible

`Protected` visibleFirstRowPos

`Protected` bodyScroller

`Protected` bodySizer

`Protected` `Abstract` context

`Abstract` id

`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` onScrolledHorizontally

`Protected` onScrolledVertically

`Protected` onVisibilityChanged

`Protected` recreate

`Optional` ctx: IAnimationContext

`Protected` recycleCell

`Protected` revalidate

`Protected` update

`Protected` `Abstract` updateCell