Class TableScope

Class representing a TableScope.

Implements

OnActionTriggeredIf

Hierarchy

RenderScope
- TableScope

Implements

OnActionTriggeredIf

Index

Constructors

constructor

Methods

addAndRenderCellDiv adjustAfterScrolling adjustArea adjustBody adjustColumnsToRowParent adjustContainersAndRows adjustHoverColumns adjustHoverRows applyCssClasses autoRestoreCollapsedExpandedState autoRestoreScrollPosition autoRestoreSortingState changeFocusCell checkForScrollPosSaving clearSelection clearSelectionModel contextmenu createGeMouseEvent debounce debugOnce drawBigCell externalFilterChanged findRowOfImportantRowspanCell firstInit getApi getArea getAreaAndSideIdentByAttr getColumnWidths getNumberByAttr getRowHeights getStringByAttr getTreeArrowColumnIndex hideHoverColumn hideHoverRow initRenderEditor isEditing mouseDraggingEndOnFrame mouseDraggingOnFrame mouseMove onActionTriggered onHeaderDblClicked onMouseClicked onMouseDown repaint rerenderCellContent resetEditorRenderer resetSizeOfWrapperDiv resizeColumn toggleExpandCollapseAll toggleRowCheckbox updateCells updateModelValueAfterEdit create

Constructors

constructor

new TableScope(hostElement, tableModel, domService, tableOptions, eventListener): TableScope
Parameters
- hostElement: HTMLDivElement
- tableModel: TableModelIf
- domService: DomServiceIf
- tableOptions: TableOptionsIf
- eventListener: EventListenerIf
Returns TableScope
Overrides RenderScope.constructor
- Defined in lib/table/table-scope.ts:83

Properties

`Private` api

api: TableApi = ...

`Protected` areaBodyCenter

areaBodyCenter: DivScope

`Protected` areaBodyCenterGeo

areaBodyCenterGeo: GeoData = ...

`Protected` areaBodyEast

areaBodyEast: DivScope

`Protected` areaBodyEastGeo

areaBodyEastGeo: GeoData = ...

`Protected` areaBodyWest

areaBodyWest: DivScope

`Protected` areaBodyWestGeo

areaBodyWestGeo: GeoData = ...

`Protected` areaFooterCenter

areaFooterCenter: DivScope

`Protected` areaFooterEast

areaFooterEast: DivScope

`Protected` areaFooterWest

areaFooterWest: DivScope

`Protected` areaHeaderCenter

areaHeaderCenter: DivScope

`Protected` areaHeaderEast

areaHeaderEast: DivScope

`Protected` areaHeaderWest

areaHeaderWest: DivScope

`Protected` borderFixedEast

borderFixedEast: HTMLDivElement

`Protected` borderFixedWest

borderFixedWest: HTMLDivElement

`Protected` borderFooterTop

borderFooterTop: HTMLDivElement

`Protected` borderHeaderBottom

borderHeaderBottom: HTMLDivElement

`Protected` `Readonly` cleanupFunctions

cleanupFunctions: {
    body: Function[];
    footer: Function[];
    header: Function[];
} = ...

Type declaration

body: Function[]
footer: Function[]
header: Function[]

`Protected` colAndRowspanModels

colAndRowspanModels: AreaObjectMapType<ColAndRowspanModel> = ...

`Protected` contentDiv

contentDiv: HTMLDivElement

`Protected` contentWrapperDiv

contentWrapperDiv: HTMLDivElement

`Protected` `Readonly` dom

dom: ConvenienceDomService

`Private` dragFrom

dragFrom: number = -1

`Private` dragTo

dragTo: number = -1

`Protected` draggingTargetColumnIndex

draggingTargetColumnIndex: number = -1

`Protected` editing

editing: boolean = false

`Protected` `Readonly` eventListener

eventListener: EventListenerIf

`Protected` firstVisibleRowIndex

firstVisibleRowIndex: number = -1

`Protected` `Optional` getFocusModel

getFocusModel?: GetT<FocusModelIf>

`Protected` `Optional` getSelectionModel

getSelectionModel?: GetT<SelectionModelIf>

`Readonly` hostElement

hostElement: HTMLDivElement

`Protected` hoverColumn

hoverColumn: HTMLDivElement

`Protected` hoverRow

hoverRow: HTMLDivElement

inputHandler

inputHandler: InputHandler

`Protected` `Optional` keyEvent

keyEvent?: GeKeyEvent

`Protected` `Optional` mouseEvent

mouseEvent?: GeMouseEvent

mouseHandler

mouseHandler: MouseHandler

`Private` mouseStartAction

mouseStartAction: string = ""

`Private` mouseStartColumnIndex

mouseStartColumnIndex: number = -1

`Private` mouseStartWidth

mouseStartWidth: number = -1

`Protected` scrollFactorX

scrollFactorX: number = 0

`Protected` scrollFactorY

scrollFactorY: number = 0

`Protected` scrollLeft

scrollLeft: number = 0

`Protected` scrollTop

scrollTop: number = 0

scrollViewport

scrollViewport: HTMLDivElement

`Protected` scrollViewportLeft

scrollViewportLeft: number = 0

`Protected` selectionService

selectionService: SelectionService = ...

shortcutService

shortcutService: ShortcutService

`Protected` `Optional` storeScrollPosStateService

storeScrollPosStateService?: StoreStateScrollPosService

`Optional` storeSortingService

storeSortingService?: StoreStateSortingService

`Optional` storeStateCollapsedExpandService

storeStateCollapsedExpandService?: StoreStateCollapsedExpandService

`Readonly` tableModel

tableModel: TableModelIf

`Readonly` tableOptions

tableOptions: TableOptionsIf

`Protected` tree

tree: boolean = false

Methods

`Protected` addAndRenderCellDiv

addAndRenderCellDiv(__namedParameters): [HTMLDivElement, undefined | Function]
Parameters
- __namedParameters: ArgsRenderCellDiv
Returns [HTMLDivElement, undefined | Function]
Inherited from RenderScope.addAndRenderCellDiv
- Defined in lib/table/render-scope.ts:671

adjustAfterScrolling

adjustAfterScrolling(): void
Returns void
Inherited from RenderScope.adjustAfterScrolling
- Defined in lib/table/render-scope.ts:166

`Protected` adjustArea

adjustArea(areaIdent, yStart?): void
Parameters
- areaIdent: AreaIdent
- yStart: number = 0
Returns void
Inherited from RenderScope.adjustArea
- Defined in lib/table/render-scope.ts:299

`Protected` adjustBody

adjustBody(): void
Returns void
Inherited from RenderScope.adjustBody
- Defined in lib/table/render-scope.ts:273

`Protected` adjustColumnsToRowParent

adjustColumnsToRowParent(__namedParameters): void
Parameters
- __namedParameters: ArgsAdjustColumnsToRowParentParams
Returns void
Inherited from RenderScope.adjustColumnsToRowParent
- Defined in lib/table/render-scope.ts:553

adjustContainersAndRows

adjustContainersAndRows(): void
Returns void
Inherited from RenderScope.adjustContainersAndRows
- Defined in lib/table/ele-scope.ts:139

`Protected` adjustHoverColumns

adjustHoverColumns(mouseMoveEvent): void
Parameters
- mouseMoveEvent: GeMouseEvent
Returns void
Inherited from RenderScope.adjustHoverColumns
- Defined in lib/table/render-scope.ts:855

`Protected` adjustHoverRows

adjustHoverRows(mouseMoveEvent): void
Parameters
- mouseMoveEvent: GeMouseEvent
Returns void
Inherited from RenderScope.adjustHoverRows
- Defined in lib/table/render-scope.ts:832

`Protected` applyCssClasses

applyCssClasses(ele, cssClasses?): void
Parameters
- ele: HTMLDivElement
- cssClasses: {
  [key: string]: boolean;
  } = {}
  - [key: string]: boolean
Returns void
Inherited from RenderScope.applyCssClasses
- Defined in lib/table/render-scope.ts:766

`Private` autoRestoreCollapsedExpandedState

autoRestoreCollapsedExpandedState(): void
Private
Restores the collapsed/expanded state of the rows in the table based on the autoRestoreOptions specified in the tableOptions. This method is private and should not be called directly.

Returns void
- Defined in lib/table/table-scope.ts:561

`Private` autoRestoreScrollPosition

autoRestoreScrollPosition(): void
Private
Restores the scroll position of the table if auto restore options are enabled.

Returns void
Memberof
ClassName
- Defined in lib/table/table-scope.ts:519

`Private` autoRestoreSortingState

autoRestoreSortingState(): void
Private
Automatically restores the sorting state of the table.

Returns void
Function
autoRestoreSortingState

Memberof
ClassName

Description
This method checks if the autoRestoreSortingState option is enabled in the tableOptions. If enabled, it uses the storeSortingService to retrieve the sort items array. If there are sort items present, it applies them to the table's body model using the doSort method.
- Defined in lib/table/table-scope.ts:545

`Private` changeFocusCell

changeFocusCell(dx, dy): boolean
Changes the focus cell using the specified deltas.
Parameters
- dx: number
  The delta for the column index.
- dy: number
  The delta for the row index.
Returns boolean
- True if the focus cell was changed, false otherwise.
- Defined in lib/table/table-scope.ts:455

checkForScrollPosSaving

checkForScrollPosSaving(): void
Returns void
Inherited from RenderScope.checkForScrollPosSaving
- Defined in lib/table/render-scope.ts:220

clearSelection

clearSelection(): void
Returns void
Inherited from RenderScope.clearSelection
- Defined in lib/table/render-scope.ts:129

`Private` clearSelectionModel

clearSelectionModel(): void
Clears the selection model, if available.

Returns void
- Defined in lib/table/table-scope.ts:485

contextmenu

contextmenu(mouseMoveEvent): void
Triggers the context menu event based on the mouse move event.
Parameters
- mouseMoveEvent: GeMouseEvent
  The mouse move event object.
Returns void
- Defined in lib/table/table-scope.ts:333

createGeMouseEvent

createGeMouseEvent(mouseEvent): GeMouseEvent
Creates a GeMouseEvent object based on a MouseEvent.
Parameters
- mouseEvent: MouseEvent
  The MouseEvent object to create the GeMouseEvent from.
Returns GeMouseEvent
- The created GeMouseEvent object.
- Defined in lib/table/table-scope.ts:208

`Protected` debounce

debounce(fn, delay?): void
Parameters
- fn: Function
- delay: number = 1000
Returns void
Inherited from RenderScope.debounce
- Defined in lib/table/render-scope.ts:879

`Private` debugOnce

debugOnce(bodyX, bodyY): void
Parameters
- bodyX: number
- bodyY: number
Returns void
- Defined in lib/table/table-scope.ts:491

`Protected` drawBigCell

drawBigCell(range, xStart, yStart, areaModel, parentDiv, sideIdent): void
Protected
Draws big cells (rowspan and or colspan) in body/center
Parameters
- range: CellRange
  CellRange
- xStart: number
  X position in pixel for top left corner
- yStart: number
  Y position in pixel for top left corner
- areaModel: AreaModelIf
  AreaModelIf
- parentDiv: HTMLDivElement
  Parent div as HTMLDivElement
- sideIdent: SideIdent
  SideIdent (west,center,east)
Returns void
Inherited from RenderScope.drawBigCell
- Defined in lib/table/render-scope.ts:459

externalFilterChanged

externalFilterChanged(clearSelection?): void
Updates the table (repaint) when an external filter is changed.
Parameters
- clearSelection: boolean = true
  Indicates whether to clear the selection model or not. Default value is true.
Returns void
- Defined in lib/table/table-scope.ts:404

`Protected` findRowOfImportantRowspanCell

findRowOfImportantRowspanCell(areaModel, rowIndex, colIndex): number
Parameters
- areaModel: AreaModelIf
- rowIndex: number
- colIndex: number
Returns number
Inherited from RenderScope.findRowOfImportantRowspanCell
- Defined in lib/table/render-scope.ts:538

firstInit

firstInit(): TableScope
Initializes the table. Called by the table component.

Returns TableScope
This instance of the table scope.

Function
firstInit

Memberof
TableScope
- Defined in lib/table/table-scope.ts:189

getApi

getApi(): TableApi
Retrieves the TableApi object.

Returns TableApi
The TableApi object.
- Defined in lib/table/table-scope.ts:176

`Protected` getArea

getArea(rowIdent, sideIdent): DivScope
Parameters
- rowIdent: AreaIdent
- sideIdent: SideIdent
Returns DivScope
Inherited from RenderScope.getArea
- Defined in lib/table/render-scope.ts:256

`Protected` getAreaAndSideIdentByAttr

getAreaAndSideIdentByAttr(srcElement): [undefined | AreaIdent, undefined | SideIdent]
Parameters
- srcElement: HTMLElement
Returns [undefined | AreaIdent, undefined | SideIdent]
Inherited from RenderScope.getAreaAndSideIdentByAttr
- Defined in lib/table/render-scope.ts:245

`Protected` getColumnWidths

getColumnWidths(startIndex, endIndex): number[]
Parameters
- startIndex: number
- endIndex: number
Returns number[]
Inherited from RenderScope.getColumnWidths
- Defined in lib/table/render-scope.ts:816

`Protected` getNumberByAttr

getNumberByAttr(srcElement, key): number
Parameters
- srcElement: HTMLElement
- key: string
Returns number
Inherited from RenderScope.getNumberByAttr
- Defined in lib/table/render-scope.ts:283

`Protected` getRowHeights

getRowHeights(startIndex, endIndex, areaModel): number[]
Parameters
- startIndex: number
- endIndex: number
- areaModel: AreaModelIf
Returns number[]
Inherited from RenderScope.getRowHeights
- Defined in lib/table/render-scope.ts:824

`Protected` getStringByAttr

getStringByAttr(srcElement, key): string
Parameters
- srcElement: HTMLElement
- key: string
Returns string
Inherited from RenderScope.getStringByAttr
- Defined in lib/table/render-scope.ts:291

`Protected` getTreeArrowColumnIndex

getTreeArrowColumnIndex(): 0 | 1
Returns 0 | 1
Inherited from RenderScope.getTreeArrowColumnIndex
- Defined in lib/table/render-scope.ts:661

`Protected` hideHoverColumn

hideHoverColumn(): void
Returns void
Inherited from RenderScope.hideHoverColumn
- Defined in lib/table/render-scope.ts:873

`Protected` hideHoverRow

hideHoverRow(): void
Returns void
Inherited from RenderScope.hideHoverRow
- Defined in lib/table/render-scope.ts:849

initRenderEditor

initRenderEditor(rowIdx, colIdx): void
Parameters
- rowIdx: number
- colIdx: number
Returns void
Inherited from RenderScope.initRenderEditor
- Defined in lib/table/render-scope.ts:136

isEditing

isEditing(): boolean
Returns boolean
Inherited from RenderScope.isEditing
- Defined in lib/table/render-scope.ts:118

mouseDraggingEndOnFrame

mouseDraggingEndOnFrame(mouseEvent): void
Handles the end of mouse dragging event on a frame.
Parameters
- mouseEvent: GeMouseEvent
  The mouse event object.
Returns void
- Defined in lib/table/table-scope.ts:298

mouseDraggingOnFrame

mouseDraggingOnFrame(mouseEvent): void
Handles mouse dragging on the frame.
Parameters
- mouseEvent: GeMouseEvent
  The mouse event object.
Returns void
- Defined in lib/table/table-scope.ts:263

mouseMove

mouseMove(mouseMoveEvent): void
Handles the mouse move event.
Parameters
- mouseMoveEvent: GeMouseEvent
  The mouse move event object.
Returns void
- Defined in lib/table/table-scope.ts:321

onActionTriggered

onActionTriggered(actionId): boolean
Triggers an action based on the provided action ID.
Parameters
- actionId: "START_EDITING" | "TOGGLE_SELECTION" | "SELECT_ALL" | "DESELECT_ALL" | "NAVIGATE_LEFT" | "NAVIGATE_RIGHT" | "NAVIGATE_UP" | "NAVIGATE_DOWN"
  The ID of the action to be triggered.
Returns boolean
- Returns true if the action was successfully triggered; otherwise, false.
Implementation of OnActionTriggeredIf.onActionTriggered
- Defined in lib/table/table-scope.ts:121

onHeaderDblClicked

onHeaderDblClicked(event, _rowIdx, colIdx): void
Handle the double click event on the table header.
Parameters
- event: MouseEvent
  The mouse event that triggered the double click.
- _rowIdx: number
  The row index of the header.
- colIdx: number
  The column index of the header.
Returns void
- Defined in lib/table/table-scope.ts:427

onMouseClicked

onMouseClicked(evt, previousEvt): void
Handle mouse click events.
Parameters
- evt: GeMouseEvent
  The mouse click event.
- previousEvt: undefined | GeMouseEvent
  The previous mouse click event, if any.
Returns void
- Defined in lib/table/table-scope.ts:380

onMouseDown

onMouseDown(mouseEvent): void
Handles the mouse down event.
Parameters
- mouseEvent: GeMouseEvent
  The mouse event object.
Returns void
- Defined in lib/table/table-scope.ts:243

repaint

repaint(): void
Returns void
Inherited from RenderScope.repaint
- Defined in lib/table/render-scope.ts:162

rerenderCellContent

rerenderCellContent(__namedParameters): void
Parameters
- __namedParameters: TableCellUpdateEventIf
Returns void
Inherited from RenderScope.rerenderCellContent
- Defined in lib/table/render-scope.ts:780

resetEditorRenderer

resetEditorRenderer(): void
Returns void
Inherited from RenderScope.resetEditorRenderer
- Defined in lib/table/render-scope.ts:122

`Protected` resetSizeOfWrapperDiv

resetSizeOfWrapperDiv(): void
Returns void
Inherited from RenderScope.resetSizeOfWrapperDiv
- Defined in lib/table/ele-scope.ts:280

`Private` resizeColumn

resizeColumn(mouseEvent): void
Resizes the column based on the mouse event.
Parameters
- mouseEvent: GeMouseEvent
  The mouse event that triggered the resize.
Returns void
- Defined in lib/table/table-scope.ts:473

toggleExpandCollapseAll

toggleExpandCollapseAll(expand?): void
Toggles the expand or collapse state of all items in the body area model.
Parameters
- Optional expand: boolean = true
  Whether to expand or collapse all items. Default is true.
Returns void
- Defined in lib/table/table-scope.ts:344

toggleRowCheckbox

toggleRowCheckbox(rowIdx, _colIdx, areaIdent): void
Toggles the checkbox state of a specific row in a table.
Parameters
- rowIdx: number
  The index of the row to toggle the checkbox state.
- _colIdx: number
  The index of the column. This parameter is unused.
- areaIdent: AreaIdent
  The identifier of the table area.
Returns void
- This method does not return anything.
- Defined in lib/table/table-scope.ts:363

updateCells

updateCells(events, repaintAll?): void
Parameters
- events: TableCellUpdateEventIf[]
- repaintAll: boolean = false
Returns void
Inherited from RenderScope.updateCells
- Defined in lib/table/render-scope.ts:227

updateModelValueAfterEdit

updateModelValueAfterEdit(areaIdent, rowIndex, columnIndex, value): void
Parameters
- areaIdent: AreaIdent
- rowIndex: number
- columnIndex: number
- value: string
Returns void
- Defined in lib/table/table-scope.ts:158

`Static` create

create(hostElement, tableModel, tableOptions?, eventListener?, domService?): TableScope
Creates a TableScope instance.
Parameters
- hostElement: HTMLDivElement
  The HTML div element that will contain the table.
- tableModel: TableModelIf
  The table model object.
- Optional tableOptions: TableOptionsIf = ...
  The optional table options object.
- Optional eventListener: EventListenerIf = ...
  The optional event listener object.
- Optional domService: DomServiceIf = ...
  The optional DOM service object.
Returns TableScope
- The newly created TableScope instance.
- Defined in lib/table/table-scope.ts:67

Class TableScope

Implements

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

hostElement: HTMLDivElement

tableModel: TableModelIf

domService: DomServiceIf

tableOptions: TableOptionsIf

eventListener: EventListenerIf

Returns TableScope

Properties

Private api

Protected areaBodyCenter

Protected areaBodyCenterGeo

Protected areaBodyEast

Protected areaBodyEastGeo

Protected areaBodyWest

Protected areaBodyWestGeo

Protected areaFooterCenter

Protected areaFooterEast

Protected areaFooterWest

Protected areaHeaderCenter

Protected areaHeaderEast

Protected areaHeaderWest

Protected borderFixedEast

Protected borderFixedWest

Protected borderFooterTop

Protected borderHeaderBottom

Protected Readonly cleanupFunctions

Type declaration

body: Function[]

footer: Function[]

header: Function[]

Protected colAndRowspanModels

Protected contentDiv

Protected contentWrapperDiv

Protected Readonly dom

Private dragFrom

Private dragTo

Protected draggingTargetColumnIndex

Protected editing

Protected Readonly eventListener

Protected firstVisibleRowIndex

Protected Optional getFocusModel

Protected Optional getSelectionModel

Readonly hostElement

Protected hoverColumn

Protected hoverRow

inputHandler

Protected Optional keyEvent

Protected Optional mouseEvent

mouseHandler

Private mouseStartAction

Private mouseStartColumnIndex

Private mouseStartWidth

Protected scrollFactorX

Protected scrollFactorY

Protected scrollLeft

Protected scrollTop

scrollViewport

Protected scrollViewportLeft

Protected selectionService

shortcutService

Protected Optional storeScrollPosStateService

Optional storeSortingService

Optional storeStateCollapsedExpandService

Readonly tableModel

Readonly tableOptions

Protected tree

Methods

Protected addAndRenderCellDiv

Parameters

__namedParameters: ArgsRenderCellDiv

`Private` api

`Protected` areaBodyCenter

`Protected` areaBodyCenterGeo

`Protected` areaBodyEast

`Protected` areaBodyEastGeo

`Protected` areaBodyWest

`Protected` areaBodyWestGeo

`Protected` areaFooterCenter

`Protected` areaFooterEast

`Protected` areaFooterWest

`Protected` areaHeaderCenter

`Protected` areaHeaderEast

`Protected` areaHeaderWest

`Protected` borderFixedEast

`Protected` borderFixedWest

`Protected` borderFooterTop

`Protected` borderHeaderBottom

`Protected` `Readonly` cleanupFunctions

`Protected` colAndRowspanModels

`Protected` contentDiv

`Protected` contentWrapperDiv

`Protected` `Readonly` dom

`Private` dragFrom

`Private` dragTo

`Protected` draggingTargetColumnIndex

`Protected` editing

`Protected` `Readonly` eventListener

`Protected` firstVisibleRowIndex

`Protected` `Optional` getFocusModel

`Protected` `Optional` getSelectionModel

`Readonly` hostElement

`Protected` hoverColumn

`Protected` hoverRow

`Protected` `Optional` keyEvent

`Protected` `Optional` mouseEvent

`Private` mouseStartAction

`Private` mouseStartColumnIndex

`Private` mouseStartWidth

`Protected` scrollFactorX

`Protected` scrollFactorY

`Protected` scrollLeft

`Protected` scrollTop

`Protected` scrollViewportLeft

`Protected` selectionService

`Protected` `Optional` storeScrollPosStateService

`Optional` storeSortingService

`Optional` storeStateCollapsedExpandService

`Readonly` tableModel

`Readonly` tableOptions

`Protected` tree

`Protected` addAndRenderCellDiv

`Protected` adjustArea

`Protected` adjustBody

`Protected` adjustColumnsToRowParent

`Protected` adjustHoverColumns

`Protected` adjustHoverRows

`Protected` applyCssClasses

cssClasses: {
[key: string]: boolean;
} = {}

`Private` autoRestoreCollapsedExpandedState

`Private` autoRestoreScrollPosition

`Private` autoRestoreSortingState

`Private` changeFocusCell

`Private` clearSelectionModel

`Protected` debounce

`Private` debugOnce

`Protected` drawBigCell