Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LinqTableComponent

Hierarchy

  • LinqTableComponent

Implements

  • OnInit
  • OnChanges
  • OnDestroy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns LinqTableComponent

Properties

autoFilters

autoFilters: any[] = []

bulkActions

bulkActions: TableBulkActions = []

Bulk actions appear when a selection is made, for example email all selected rows.

defaultColumns

defaultColumns: ColDef = ...

defaultFilterChips

defaultFilterChips: boolean = true

Flag to turn off filter chips when a column has been filtered.

defaultGridOptions

defaultGridOptions: GridOptions = ...

defaultPage

defaultPage: number

Set the default page number to render

defaultSearchValue

defaultSearchValue: string

Set a quick search value and trigger the search on load of the table

Private destroy$

destroy$: Subject<unknown> = ...

disableSearch

disableSearch: boolean = false

Hide the quick search bar

exportCSV

exportCSV: boolean = true

Display Export data to CSV option in the footer, will export all current data

exportExcel

exportExcel: boolean = true

Display Export data to Excel option in the footer, will export all current data

footerActions

footerActions: TableFooterActions = []

Array of actions which will be rendered in the footer, optional dropdown action button

gridApi

gridApi: GridApi

gridOptions

gridOptions: GridOptions = ...

Default grid options

gridReady

gridReady: EventEmitter<GridReadyEvent> = ...

headerActions

headerActions: TableHeaderActions = []

Array of actions which wil lbe rendered in the header, based off LinqButtonTemplate

id

id: string | number

ID for the table id html attribute

Readonly intl

intl: LinqIntl

length

length: number = 0

loading

loading: boolean = false

noDataRefContext

noDataRefContext: {} = {}

Variables passed to the ContentChild noDataRef

Type declaration

    noDataTemplateRef

    noDataTemplateRef: TemplateRef<unknown>

    pageIndex

    pageIndex: number

    pageSize

    pageSize: number = 10

    pageSizes

    pageSizes: number[] = ...

    Array of page size for the MatPaginator

    pagination

    pagination: boolean = true

    Hide pagination in table footer

    rowData

    rowData: TableRowData = []

    Data for table, can be observable to be used the rowData$ | async template function.

    searchInput

    searchInput: string

    selected

    selected: unknown[] = []

    tableComponentRef

    tableComponentRef: TemplateRef<unknown>

    tableRefContext

    tableRefContext: { className: string; data: TableRowData; defaultColDef: ColDef; defaultColumns: ColDef; gridOptions: GridOptions; onGridReady: ((params: GridReadyEvent) => void); rowData: TableRowData } = ...

    Variables passed to the ContentChild tableRef

    Type declaration

    • className: string
    • data: TableRowData
    • defaultColDef: ColDef
    • defaultColumns: ColDef
    • gridOptions: GridOptions
    • onGridReady: ((params: GridReadyEvent) => void)
        • (params: GridReadyEvent): void

        • Parameters

          • params: GridReadyEvent

          Returns void

    • rowData: TableRowData

    tableTemplateRef

    tableTemplateRef: TemplateRef<unknown>

    trackingId

    trackingId: string | number

    ID for the table data-id html attribute

    Methods

    manageLoadingOfData

    • manageLoadingOfData(): void

    • Data can be an observable or an array. Handle both cases.

      Returns void

    managePageSizeAndPagination

    • managePageSizeAndPagination(): void

    • Returns void

    ngOnChanges

    • ngOnChanges(changes: SimpleChanges): void

    • Parameters

      • changes: SimpleChanges

      Returns void

    ngOnDestroy

    • ngOnDestroy(): void

    • Returns void

    ngOnInit

    • ngOnInit(): void

    • Returns void

    onGridReady

    • onGridReady(params: GridReadyEvent): void

    • Parameters

      • params: GridReadyEvent

      Returns void

    Generated using TypeDoc