Docs for m2-core, m2-components
  1. Classes
  2. DataTableUtils

File

projects/m2-core/src/lib/core/utils/data-table.utils.ts

Index

Methods

Methods

Static adjustShiftedColumnHeaders
adjustShiftedColumnHeaders(datatableComponent: DatatableComponent)
Parameters :
Name Type Optional
datatableComponent DatatableComponent No
Returns : void
Static detectChanges
detectChanges(datatableComponent: DatatableComponent)
Parameters :
Name Type Optional
datatableComponent DatatableComponent No
Returns : void
Static findItemIds
findItemIds(tableRows: Object[], idPropName: string)
Parameters :
Name Type Optional
tableRows Object[] No
idPropName string No
Returns : number[]
Static findRow
findRow(tableRows: T[], entityId: number, idPropName)
Type parameters :
  • T
Parameters :
Name Type Optional Default value
tableRows T[] No
entityId number No
idPropName No CONSTANTS.ITEM_ID_COLUMN_PROPERTY
Returns : T
Static findRowById
findRowById(tableRows: R[], id: number)
Type parameters :
  • R
Parameters :
Name Type Optional
tableRows R[] No
id number No
Returns : R
Static findRowIndex
findRowIndex(tableRows: T[], entityId: number, idPropName)
Type parameters :
  • T
Parameters :
Name Type Optional Default value
tableRows T[] No
entityId number No
idPropName No CONSTANTS.ITEM_ID_COLUMN_PROPERTY
Returns : number
Static findRowsIndexes
findRowsIndexes(targetRows: T[], allRows: T[], idPropName: string)
Type parameters :
  • T

Returns indexes of LOADED target rows.

Parameters :
Name Type Optional
targetRows T[] No
allRows T[] No
idPropName string No
Returns : number[]
Static formatAttributeColumn
formatAttributeColumn(column: DatatableColumn, attrType: AttributeType)
Parameters :
Name Type Optional
column DatatableColumn No
attrType AttributeType No
Returns : void
Static formColumnBar
formColumnBar(prop, name: string, width: number, notFaceted)
Type parameters :
  • T
Parameters :
Name Type Optional Default value
prop No
name string No
width number No 150
notFaceted No false
Returns : DatatableColumn
Static formColumnId
formColumnId(propertyId: number)
Parameters :
Name Type Optional
propertyId number No
Returns : string
Static formColumnsMap
formColumnsMap(columnInfos: ColumnInfo<T>[], headerCellTmpl: TemplateRef, elementRefCellTmpl: TemplateRef, imgValueCellTmpl: TemplateRef)
Type parameters :
  • T
Parameters :
Name Type Optional
columnInfos ColumnInfo<T>[] No
headerCellTmpl TemplateRef<any> No
elementRefCellTmpl TemplateRef<any> No
imgValueCellTmpl TemplateRef<any> No
Returns : Map<T, DatatableColumn>
Static formHandleColumn
formHandleColumn(headerTemplate?: TemplateRef)
Parameters :
Name Type Optional
headerTemplate TemplateRef<any> Yes
Returns : DatatableColumn
Static formParentNodeNameColumnBar
formParentNodeNameColumnBar()
Returns : DatatableColumn
Static formToolsColumn
formToolsColumn(headerTemplate?: TemplateRef)

This column serves as tool buttons container and filler

Parameters :
Name Type Optional
headerTemplate TemplateRef<any> Yes
Returns : DatatableColumn
Static getAnyItemId
getAnyItemId(tableRows: Object[], idPropName)
Parameters :
Name Type Optional Default value
tableRows Object[] No
idPropName No CONSTANTS.ITEM_ID_COLUMN_PROPERTY
Returns : number
Static getCellValueIds
getCellValueIds(row: TableRow, columnOrColumnId: DatatableColumn | string)
Parameters :
Name Type Optional
row TableRow No
columnOrColumnId DatatableColumn | string No
Returns : number[]
Static getColumnAlignmentIconClass
getColumnAlignmentIconClass(alignment: TextAlignment)
Parameters :
Name Type Optional
alignment TextAlignment No
Returns : string
Static getColumnAlignmentOrdinal
getColumnAlignmentOrdinal(alignment: TextAlignment)
Parameters :
Name Type Optional
alignment TextAlignment No
Returns : number
Static getConstraintRowClass
getConstraintRowClass(row: ConstraintTableRow)
Parameters :
Name Type Optional
row ConstraintTableRow No
Returns : string
Static getLoadedRowIndexes
getLoadedRowIndexes(tableRows: Object[], idPropName)
Parameters :
Name Type Optional Default value
tableRows Object[] No
idPropName No CONSTANTS.ITEM_ID_COLUMN_PROPERTY
Returns : Map<number, number>
Static getLoadedRowsMap
getLoadedRowsMap(tableRows: T[], idPropName)
Type parameters :
  • T

Find rows or rows' indexes in loaded rows array

Parameters :
Name Type Optional Default value
tableRows T[] No
idPropName No CONSTANTS.ITEM_ID_COLUMN_PROPERTY
Returns : Map<number, T>
Static getRowClass
getRowClass(row: PageRow)

Rows

Parameters :
Name Type Optional
row PageRow No
Returns : string
Static getRowIndex
getRowIndex(datatableComponent: DatatableComponent, row: T)
Type parameters :
  • T

FIXME the following method returns valid indexes only when requested row is visible in viewport - use alternative approach!!!

Parameters :
Name Type Optional
datatableComponent DatatableComponent No
row T No
Returns : number
Static getTableScrollLeft
getTableScrollLeft(datatableComponent: DatatableComponent)
Parameters :
Name Type Optional
datatableComponent DatatableComponent No
Returns : number
Static getViewportRowIndexes
getViewportRowIndexes(datatableComponent: DatatableComponent)
Parameters :
Name Type Optional
datatableComponent DatatableComponent No
Returns : number[]
Static isRowInViewport
isRowInViewport(datatableComponent: DatatableComponent, index: number)
Parameters :
Name Type Optional
datatableComponent DatatableComponent No
index number No
Returns : boolean
Static recalculateColumns
recalculateColumns(datatableComponent: DatatableComponent)
Parameters :
Name Type Optional
datatableComponent DatatableComponent No
Returns : void
Static resetColumnFacets
resetColumnFacets(tableColumns: DatatableColumn[], datatableComponent?: DatatableComponent)
Parameters :
Name Type Optional
tableColumns DatatableColumn[] No
datatableComponent DatatableComponent Yes
Returns : boolean
Static resetScroll
resetScroll(datatableComponent: DatatableComponent, scrollLeftToPreserve: number)
Parameters :
Name Type Optional Default value
datatableComponent DatatableComponent No
scrollLeftToPreserve number No 0
Returns : void
Static scrollRowIntoView
scrollRowIntoView(datatableComponent: DatatableComponent, rowIndex: number)
Parameters :
Name Type Optional
datatableComponent DatatableComponent No
rowIndex number No
Returns : void
Static scrollTop
scrollTop(datatableComponent: DatatableComponent, scrollLeftToPreserve?: number)
Parameters :
Name Type Optional
datatableComponent DatatableComponent No
scrollLeftToPreserve number Yes
Returns : void
Static setColumnAlignment
setColumnAlignment(column: DatatableColumn, alignment: TextAlignment)

Column alignment

Parameters :
Name Type Optional
column DatatableColumn No
alignment TextAlignment No
Returns : void
Static setTablePage
setTablePage(datatableComponent: DatatableComponent, itemIndex: number, rowsCount: number, timeout: number, force)
Parameters :
Name Type Optional Default value
datatableComponent DatatableComponent No
itemIndex number No
rowsCount number No
timeout number No 0
force No false
Returns : void
Static sortColumns
sortColumns(columns: DatatableColumn[])
Parameters :
Name Type Optional
columns DatatableColumn[] No
Returns : void
Static triggerScroll
triggerScroll(datatableComponent: DatatableComponent)
Parameters :
Name Type Optional
datatableComponent DatatableComponent No
Returns : void
Static valuesToTableCellInfos
valuesToTableCellInfos(values: PropertyValue[])
Parameters :
Name Type Optional
values PropertyValue[] No
Returns : TableCellInfo[]
Static valueToTableCellInfo
valueToTableCellInfo(value: PropertyValue)

Cells

Parameters :
Name Type Optional
value PropertyValue No
Returns : TableCellInfo

results matching ""

    No results matching ""