Class CustomCanvasTable<T>

Type parameters

T

Hierarchy

CustomCanvasTable
- CanvasTable
- OffscreenCanvasTableWorker

Implements

IDrawable

Index

Constructors

constructor

new CustomCanvasTable(config: ICanvasTableConfig | undefined): CustomCanvasTable

- Defined in share/CustomCanvasTable.ts:238
Parameters
- config: ICanvasTableConfig | undefined
Returns CustomCanvasTable

Methods

addEvent

addEvent(EventName: "edit", event: EventManagerEdit): void
addEvent(eventName: "clickHeader", event: EventManagerClickHeader<T>): void
addEvent(eventName: "click" | "dblClick", event: EventManagerClick<T>): void
addEvent(eventName: "reCalcForScrollView", event: EventManagerReCalcForScrollView): void

- Defined in share/CustomCanvasTable.ts:491
Parameters
- EventName: "edit"
- event: EventManagerEdit
Returns void
- Defined in share/CustomCanvasTable.ts:492
Parameters
- eventName: "clickHeader"
- event: EventManagerClickHeader<T>
Returns void
- Defined in share/CustomCanvasTable.ts:493
Parameters
- eventName: "click" | "dblClick"
- event: EventManagerClick<T>
Returns void
- Defined in share/CustomCanvasTable.ts:494
Parameters
- eventName: "reCalcForScrollView"
- event: EventManagerReCalcForScrollView
Returns void

askForReDraw

askForReDraw(config?: IDrawConfig): void

- Defined in share/CustomCanvasTable.ts:272
Let CanvasTable redraw

Parameters
- Optional config: IDrawConfig
Returns void

askForReIndex

askForReIndex(): void

- Defined in share/CustomCanvasTable.ts:296
Recalc index and then redraw You need to call this if size of the data was change or columns witch was change is in active groupby or sort

Returns void

clearEditData

clearEditData(): void

- Defined in share/CustomCanvasTable.ts:538
Returns void

collapseAll

collapseAll(): void

- Defined in share/CustomCanvasTable.ts:470
Collapse All data in tree mode

Returns void

expendAll

expendAll(): void

- Defined in share/CustomCanvasTable.ts:446
Expend All data in tree mode

Returns void

getEditData

getEditData(): object

- Defined in share/CustomCanvasTable.ts:535
Returns object
- [index: number]: IEditRowItem

getScrollView

getScrollView(): ScrollView | undefined

- Defined in share/CustomCanvasTable.ts:244
Returns ScrollView | undefined

getTableMode

getTableMode(): CanvasTableMode

- Defined in share/CustomCanvasTable.ts:374
Returns CanvasTableMode

getUpdateData

getUpdateData(row: number, field: string): object | undefined

- Defined in share/CustomCanvasTable.ts:519
Parameters
- row: number
- field: string
Returns object | undefined

getUpdateDataOrData

getUpdateDataOrData(row: number, field: string): any

- Defined in share/CustomCanvasTable.ts:527
Parameters
- row: number
- field: string
Returns any

isPlanToRedraw

isPlanToRedraw(): boolean

Implementation of IDrawable.isPlanToRedraw
- Defined in share/CustomCanvasTable.ts:260
Is CanvasTable goging to redraw in next frame

Returns boolean

removeEvent

removeEvent(EventName: "edit", event: EventManagerEdit): void
removeEvent(eventName: "clickHeader", event: EventManagerClickHeader<T>): void
removeEvent(eventName: "click" | "dblClick", event: EventManagerClick<T>): void
removeEvent(eventName: "reCalcForScrollView", event: EventManagerReCalcForScrollView): void

- Defined in share/CustomCanvasTable.ts:499
Parameters
- EventName: "edit"
- event: EventManagerEdit
Returns void
- Defined in share/CustomCanvasTable.ts:500
Parameters
- eventName: "clickHeader"
- event: EventManagerClickHeader<T>
Returns void
- Defined in share/CustomCanvasTable.ts:501
Parameters
- eventName: "click" | "dblClick"
- event: EventManagerClick<T>
Returns void
- Defined in share/CustomCanvasTable.ts:502
Parameters
- eventName: "reCalcForScrollView"
- event: EventManagerReCalcForScrollView
Returns void

Abstract resize

resize(): void

- Defined in share/CustomCanvasTable.ts:542
Returns void

setAllowEdit

setAllowEdit(allowEdit: boolean): void

- Defined in share/CustomCanvasTable.ts:301
Parameters
- allowEdit: boolean
Returns void

setColumnVisible

setColumnVisible(col: number | ICanvasTableColumnConf<T>, visible: boolean): void

- Defined in share/CustomCanvasTable.ts:394
Change the visibility of the column

Parameters
- col: number | ICanvasTableColumnConf<T>
  
  index of colum or the column it self
- visible: boolean
  
  show or hide the colum
Returns void

setCustomSort

setCustomSort(customSort?: CustomSort<T> | null): void

- Defined in share/CustomCanvasTable.ts:326
Parameters
- Optional customSort: CustomSort<T> | null
Returns void

setData

setData(data?: T[]): void

- Defined in share/CustomCanvasTable.ts:382
Set new Data and then reindex and redraw

Parameters
- Optional data: T[]
  
  new Data
Returns void

setFilter

setFilter(filter?: CustomFilter<T> | null): void

- Defined in share/CustomCanvasTable.ts:315
Parameters
- Optional filter: CustomFilter<T> | null
Returns void

setGroupBy

setGroupBy(col?: Array<string | ICanvasTableGroup>): void

- Defined in share/CustomCanvasTable.ts:343
Set group by data

Parameters
- Optional col: Array<string | ICanvasTableGroup>
Returns void

setRowColStyle

setRowColStyle(style?: CustomRowColStyle<T> | null): void

- Defined in share/CustomCanvasTable.ts:305
Parameters
- Optional style: CustomRowColStyle<T> | null
Returns void

setRowTableGroup

setRowTableGroup(row?: string | ICanvasRowTableGroup): void

- Defined in share/CustomCanvasTable.ts:359
Parameters
- Optional row: string | ICanvasRowTableGroup
Returns void

setSort

setSort(sortCol?: Array<ICanvasTableColumnSort<T>>): void

- Defined in share/CustomCanvasTable.ts:333
Parameters
- Optional sortCol: Array<ICanvasTableColumnSort<T>>
Returns void

setTableMode

setTableMode(tableMode: CanvasTableMode): void

- Defined in share/CustomCanvasTable.ts:368
Parameters
- tableMode: CanvasTableMode
Returns void

setUpdateData

setUpdateData(row: number, field: string, data: any): void

- Defined in share/CustomCanvasTable.ts:510
Parameters
- row: number
- field: string
- data: any
Returns void

updateColumns

updateColumns(col: Array<ICanvasTableColumnConf<T>>): void

- Defined in share/CustomCanvasTable.ts:414
Parameters
- col: Array<ICanvasTableColumnConf<T>>
Returns void

updateConfig

updateConfig(config: ICanvasTableConfig | undefined): void

- Defined in share/CustomCanvasTable.ts:252
To customize style of CanvasTable

Parameters
- config: ICanvasTableConfig | undefined
  
  config
Returns void

Generated using TypeDoc