File

qwc/projects/qwc/src/lib/components/qwc-data-table/qwc-data-table.component.ts

Description

Qwc data table component

Implements

AfterContentInit OnChanges AfterViewInit OnDestroy

Metadata

selector qwc-data-table
templateUrl ./qwc-data-table.component.html

Index

Properties
Methods
Inputs
Outputs
HostListeners

Constructor

constructor(dragulaService: DragulaService)
Parameters :
Name Type Optional
dragulaService DragulaService No

Inputs

checkBoxEvaluator
Type : function
data
Type : any
dataKey
Default value : "id"
deleteKey
Default value : "isDeleted"
disable
Default value : false
disableTemplateCache
Default value : false
displayColumns
Type : DisplayColumn[]
isRelativeCount
Default value : false
itemDraggable
Default value : false
multiSelect
Default value : false
retainFocusOnDataChange
Type : boolean
rowDragable
Default value : false
rowHeight
Default value : "75"
rowUnSelection
Default value : false
selectedIndex
Type : number
selectedRows
Type : any[]
Default value : []
showAllCheckboxes
Default value : false
showHeader
Default value : true
totalCount
Type : number

Outputs

columnResized
Type : EventEmitter
dataOrderChanged
Type : EventEmitter
dblClick
Type : EventEmitter
displayColumnsChange
Type : EventEmitter
hoveredItemEvent
Type : EventEmitter
loadMore
Type : EventEmitter
renderedRows
Type : EventEmitter
selectionChange
Type : EventEmitter
sort
Type : EventEmitter
viewableRows
Type : EventEmitter

HostListeners

keydown
Arguments : '$event'
keydown(event: KeyboardEvent)

Methods

changeSorting
changeSorting(selectedDisplayColumn: DisplayColumn)

Change sorting

Parameters :
Name Type Optional Description
selectedDisplayColumn DisplayColumn No

Selected display column

Returns : void

void

dblClickHandler
dblClickHandler(selectedData: any)

Db click handler

Parameters :
Name Type Optional Description
selectedData any No

Selected data

Returns : void

void

getColumnWidth
getColumnWidth(displayColumn: DisplayColumn)

Get column width

Parameters :
Name Type Optional Description
displayColumn DisplayColumn No

Display column

Returns : { "min-width": string; "max-width": string; "flex-grow"?: undefined; } | { "flex-grow": number; "...

void

getTemplate
getTemplate(displayColumn: DisplayColumn)

Get template

Parameters :
Name Type Optional Description
displayColumn DisplayColumn No

Display column

Returns : TemplateRef<any>

TemplateRef Template Referance

handleLeftRightKeysFlow
handleLeftRightKeysFlow(event)

Handle left right arrow for focus

Parameters :
Name Optional Description
event No

event

Returns : void

void

handleSelectCheckboxKeyboardEvent
handleSelectCheckboxKeyboardEvent(event, row, i)
Parameters :
Name Optional Description
event No

Event

row No

Slected Row

i No

Row Index

Returns : void
inView
inView(rowObj: literal type, row: any)

Rows in view Handler

Parameters :
Name Type Optional Description
rowObj literal type No

Row object

row any No

Row data

Returns : void

void

isMacPlatform
isMacPlatform()

Is mac platform

Returns : boolean

boolean

isTemplateProvided
isTemplateProvided(displayColumn: DisplayColumn)

Is template provided

Parameters :
Name Type Optional Description
displayColumn DisplayColumn No

Display column

Returns : boolean

boolean

itemDropped
itemDropped(_event: CdkDragDrop)

Item Dropped

Parameters :
Name Type Optional
_event CdkDragDrop<string[]> No
Returns : void
keyboardEventHandler
keyboardEventHandler(row, i, event)
Parameters :
Name Optional Description
row No

Selected row

i No

Row Index

event No

Event

Returns : void
ngAfterContentInit
ngAfterContentInit()

Component life cycle hook

Returns : void

void

ngAfterViewInit
ngAfterViewInit()

Component life cycle hook

Returns : void

void

ngOnChanges
ngOnChanges(changes: SimpleChanges)

Component life cycle hook

Parameters :
Name Type Optional Description
changes SimpleChanges No

Changes

Returns : void

void

ngOnDestroy
ngOnDestroy()

Component life cycle hook

Returns : void

void

onDragStarted
onDragStarted(event: any, item: any)

On drag started, set the dragged items count and data

Parameters :
Name Type Optional Description
event any No

Event

item any No

Selected Item

Returns : void
onResizeEnd
onResizeEnd(event: any, displayColumn: DisplayColumn)

On resize end

Parameters :
Name Type Optional Description
event any No

Event

displayColumn DisplayColumn No

Display column

Returns : void
onResizeStart
onResizeStart(event: any, displayColumn: DisplayColumn)

On rezise start

Parameters :
Name Type Optional Description
event any No

Event

displayColumn DisplayColumn No

Display column

Returns : void

void

onResizing
onResizing(event: any, displayColumn: DisplayColumn)

On resizing

Parameters :
Name Type Optional Description
event any No

Event

displayColumn DisplayColumn No

Display column

Returns : void
onRowFocus
onRowFocus(rowEl: any, uniqueId: any)

On row focus, get all tab elements

Parameters :
Name Type Optional Description
rowEl any No

template element

uniqueId any No

unique row id

Returns : void

void

resetElementIndex
resetElementIndex()

On table blur, reset active tab index.

Returns : void

void

resetTabIndexOfTableHeaderChildren
resetTabIndexOfTableHeaderChildren()

Reset tab indexes of Table Header children Reset active row and active row index to start from the beginning everytime tab or shift tab is pressed

Returns : void

void

rowToggleSelection
rowToggleSelection(row, index: number, event?)

Row toggle selection

Parameters :
Name Type Optional Description
row No

Row

index number No

Index

event Yes
Returns : void

void

scrollChangeHandler
scrollChangeHandler(visibleIndexRecord: number)

Scroller change handler

Parameters :
Name Type Optional Description
visibleIndexRecord number No

Visible Index record

Returns : void

void

scrollToTop
scrollToTop()

Scroll to top

Returns : void

void

selectionChangeHandler
selectionChangeHandler(selectedData: any, event, rowIndex?: number)

Selection change handler

Parameters :
Name Type Optional Description
selectedData any No

Selected data

event No

Event

rowIndex number Yes

Row index

Returns : void

void

setFocus
setFocus(index: number, event: KeyboardEvent)

Set focus on row element

Parameters :
Name Type Optional Description
index number No

number

event KeyboardEvent No

event

Returns : void

void

setHoveredItemId
setHoveredItemId(id)

Set hovered item id

Parameters :
Name Optional Description
id No

Id

Returns : void

void

toggleSelectAll
toggleSelectAll(selectAll?: boolean)

Select/de-select all the entities

Parameters :
Name Type Optional Description
selectAll boolean Yes

Mark select/de-select all instead of calucaltion from selected entities

Returns : void

void

triggerDblClick
triggerDblClick(selectedData: any, event: Event)

Trigger db click

Parameters :
Name Type Optional Description
selectedData any No

Selected data

event Event No

Event

Returns : void

void

Properties

activeRow
Type : any
activeRowElementIndex
Default value : -1
activeRowElements
Type : any
Default value : []
actualCount
Type : number
Default value : 0
cdkVirtualViewport
Type : CdkVirtualScrollViewport
Decorators :
@ViewChild('cdkVirtualViewport')
dataItems
Type : literal type[]
deletedRowsCount
Type : number
Default value : 0
draggedItemsCount
Type : number
Default value : 0
dragulaId
Type : string
hoveredItemId
Type : number
hoverOnHeader
Default value : false
idTemplateMap
Default value : new Map<string, TemplateRef<any>>()
isLoadMoreEventFired
Default value : false
rowItemTemplates
Type : QueryList<QwcRowItemTemplateDirective>
Decorators :
@ContentChildren(QwcRowItemTemplateDirective)
rowTemplateDataChildren
Type : QueryList<QwcDataTableRow>
Decorators :
@ViewChildren(undefined)
subs
Default value : new Subscription()
tableContentContainer
Type : ElementRef
Decorators :
@ViewChild('tableContentContainer')
tableHeaderContainer
Type : ElementRef
Decorators :
@ViewChild('tableHeaderContainer')
templateCacheSize
Type : number
Default value : 20
trackByFn
Default value : () => {...}

Track by fn

Parameters :
Name Description
index

Index

item

Item

unselectableRowsCount
Type : number
Default value : 0
viewableRows$
Default value : new Subject<void>()
viewableRowsMap
Default value : new Map<string, { element: ElementRef, data: any }>()
viewData
Type : any

result-matching ""

    No results matching ""