Index
Constructors
Public Properties
Protected Properties
- bodyCellContainerDiv
- bodyDiv
- bodyViewportDiv
- columns
- cssPrefix
- dataTable
- eventEmitter
- footerDiv
- footerPaginateDiv
- headerCellContainerDiv
- headerDiv
- headerRowDiv
- headerViewportDiv
- rootDiv
- slot
- tableCss
Public Accessors
Public Methods
- addEventListener
- clear
- destroy
- ensureRowVisibility
- fireEvent
- focus
- getColumns
- getData
- refresh
- removeEventListener
- setData
Protected Methods
- clearDOM
- getGlobalIndexByLocal
- getLocalIndexByGlobal
- hasData
- hideProgress
- init
- render
- renderAddColumnButton
- renderBody
- renderCell
- renderColumnHeader
- renderFooter
- renderHeader
- renderPageInfoBlock
- renderPageNavigator
- renderRow
- showProgress
- updateHeight
Constructors
constructor
⊕ new EasyGrid(options: EasyGridOptions): EasyGrid
Parameters:
- options: EasyGridOptions
Public Properties
cellRendererStore
● cellRendererStore: GridCellRendererStore
options
● options: EasyGridOptions
Protected Properties
bodyCellContainerDiv
● bodyCellContainerDiv: HTMLDivElement
bodyDiv
● bodyDiv: HTMLDivElement
bodyViewportDiv
● bodyViewportDiv: HTMLDivElement
columns
● columns: GridColumnList
cssPrefix
● cssPrefix: string = "keg"
dataTable
● dataTable: EasyDataTable
eventEmitter
● eventEmitter: EventEmitter
footerDiv
● footerDiv: HTMLDivElement
footerPaginateDiv
● footerPaginateDiv: HTMLDivElement
headerCellContainerDiv
● headerCellContainerDiv: HTMLDivElement
headerDiv
● headerDiv: HTMLDivElement
headerRowDiv
● headerRowDiv: HTMLDivElement
headerViewportDiv
● headerViewportDiv: HTMLDivElement
rootDiv
● rootDiv: HTMLDivElement
slot
● slot: HTMLElement
tableCss
● tableCss?: string
Public Accessors
activeRowIndex
⇄ get activeRowIndex(): number
Returns number
⇄ set activeRowIndex(value: number): void
Parameters:
- value:
number
Returns void
Public Methods
addEventListener
▸ addEventListener(eventType: "init",handler: () => void): string
Parameters:
- eventType:
"init" - handler: () =>
void
Returns string
▸ addEventListener(eventType: "rowClick",handler: (ev: RowClickEvent) => void): string
Parameters:
- eventType:
"rowClick" - handler: (ev: RowClickEvent) =>
void
Returns string
▸ addEventListener(eventType: "rowDbClick",handler: (ev: RowClickEvent) => void): string
Parameters:
- eventType:
"rowDbClick" - handler: (ev: RowClickEvent) =>
void
Returns string
▸ addEventListener(eventType: "pageChanged",handler: (ev: PageChangedEvent) => void): string
Parameters:
- eventType:
"pageChanged" - handler: (ev: PageChangedEvent) =>
void
Returns string
▸ addEventListener(eventType: "addColumnClick",handler: (ev: AddColumnClickEvent) => void): string
Parameters:
- eventType:
"addColumnClick" - handler: (ev: AddColumnClickEvent) =>
void
Returns string
▸ addEventListener(eventType: "columnChanged",handler: (ev: ColumnChangedEvent) => void): string
Parameters:
- eventType:
"columnChanged" - handler: (ev: ColumnChangedEvent) =>
void
Returns string
▸ addEventListener(eventType: "columnMoved",handler: (ev: ColumnMovedEvent) => void): string
Parameters:
- eventType:
"columnMoved" - handler: (ev: ColumnMovedEvent) =>
void
Returns string
▸ addEventListener(eventType: "columnDeleted",handler: (ev: ColumnDeletedEvent) => void): string
Parameters:
- eventType:
"columnDeleted" - handler: (ev: ColumnDeletedEvent) =>
void
Returns string
▸ addEventListener(eventType: "activeRowChanged",handler: (ev: ActiveRowChangedEvent) => void): string
Parameters:
- eventType:
"activeRowChanged" - handler: (ev: ActiveRowChangedEvent) =>
void
Returns string
clear
▸ clear(): void
Returns void
destroy
▸ destroy(): void
Returns void
ensureRowVisibility
▸ ensureRowVisibility(rowOrIndex: HTMLElement | number): void
Parameters:
- rowOrIndex:
HTMLElement|number
Returns void
fireEvent
▸ fireEvent(event: GridEvent | GridEventType): void
Parameters:
- event: GridEvent |
GridEventType
Returns void
focus
▸ focus(): void
Returns void
getColumns
▸ getColumns(): GridColumnList
Returns GridColumnList
getData
▸ getData(): EasyDataTable
Returns EasyDataTable
refresh
▸ refresh(): void
Returns void
removeEventListener
▸ removeEventListener(eventType: string,handlerId: string): void
Parameters:
- eventType:
string - handlerId:
string
Returns void
setData
▸ setData(data: EasyDataTable): void
Parameters:
- data: EasyDataTable
Returns void
Protected Methods
clearDOM
▸ clearDOM(): void
Returns void
getGlobalIndexByLocal
▸ getGlobalIndexByLocal(index: number): number
Parameters:
- index:
number
Returns number
getLocalIndexByGlobal
▸ getLocalIndexByGlobal(index: number): number
Parameters:
- index:
number
Returns number
hasData
▸ hasData(): boolean
Returns boolean
hideProgress
▸ hideProgress(): void
Returns void
init
▸ init(options: EasyGridOptions): void
Parameters:
- options: EasyGridOptions
Returns void
render
▸ render(): void
Returns void
renderAddColumnButton
▸ renderAddColumnButton(): HTMLElement
Returns HTMLElement
renderBody
▸ renderBody(): void
Returns void
renderCell
▸ renderCell(column: GridColumn,colIndex: number,value: any,rowElement: HTMLElement): HTMLDivElement
Parameters:
- column: GridColumn
- colIndex:
number - value:
any - rowElement:
HTMLElement
Returns HTMLDivElement
renderColumnHeader
▸ renderColumnHeader(column: GridColumn,index: number): HTMLElement
Parameters:
- column: GridColumn
- index:
number
Returns HTMLElement
renderFooter
▸ renderFooter(): void
Returns void
renderHeader
▸ renderHeader(): void
Returns void
renderPageInfoBlock
▸ renderPageInfoBlock(): HTMLDivElement
Returns HTMLDivElement
renderPageNavigator
▸ renderPageNavigator(): HTMLDivElement
Returns HTMLDivElement
renderRow
▸ renderRow(row: DataRow,index: number): HTMLDivElement
Parameters:
- row: DataRow
- index:
number
Returns HTMLDivElement
showProgress
▸ showProgress(): void
Returns void
updateHeight
▸ updateHeight(): Promise<void>
Returns Promise<void>