Data Grid
API reference for Material Extensions Data Grid
import { MtxGridModule } from '@ng-matero/extensions/data-grid';
Directives
MtxGrid
MtxGrid
Selector: [mtx-grid]
Exported as: mtxGrid
Properties
Basic
Name | Description |
@Input() | The grid columns defination. |
@Input() | The grid data source. |
@Input() | The length of the total number of data. Defaulted to |
@Input() | Whether the table loading is ended. Defaulted to |
@Input() | Tracking function that will be used to check the differences in data changes. |
@Input() | Whether the column can be resized. Defaulted to |
Page
Name | Description |
@Input() | Whether paging the data just on front end. Defaulted to |
@Input() | Whether show the paginator. Defaulted to |
@Input() | Whether the paginator is disabled. Defaulted to |
@Input() | Whether to show the first/last buttons UI to the user. Defaulted to |
@Input() | The zero-based page index of the displayed list of items. Defaulted to |
@Input() | Number of items to display on a page. By default set to |
@Input() | The set of provided page size options to display to the user. By default set to |
@Input() | Whether hide the pagesize. Defaulted to |
@Output() | Event emitted when the paginator changes the page size or page index. |
@Input() | The pagination template. |
Sort
Name | Description |
@Input() | Whether sort data just on front end. Defaulted to |
@Input() | The id of the most recently sorted MatSortable. |
@Input() | The sort direction of the currently active MatSortable. |
@Input() | Whether to disable the user from clearing the sort by finishing the sort direction cycle. May be overriden by the column's disable clear definition. Defaulted to |
@Input() | Whether the grid sort is disabled. Defaulted to |
@Input() | The direction to set when an MatSortable is initially sorted. May be overriden by the column's sort definition. Defaulted to |
@Output() | Event emitted when the user changes either the active sort or sort direction. |
Expansion
Name | Description |
@Input() | Whether the row can be expanded. Defaulted to |
@Input() | The template of expandable row. |
@Output() | Event emitted when the user toggle the expandable row. |
Selection
Name | Description |
@Input() | Whether the user can selecte multiple row or cell. Defaulted to |
@Input() | Whether the row can be selectable. Defaulted to |
@Input() | The row selected items default. Defaulted to |
@Input() | Whether hide the row selection checkbox. Defaulted to |
@Input() | The row selection formatter to set disabled and checkbox hiding. |
@Output() | The row class formatter to set class. |
@Output() | Event emitted when the row be selected. |
@Input() | Whether the cell can be selectable. Defaulted to |
@Output() | Event emitted when the cell be selected. |
Toolbar
Name | Description |
@Input() | Whether show the grid toolbar. Defaulted to |
@Input() | The toolbar title. Defaulted to |
@Input() | The toolbar template. |
Column menu
Name | Description |
@Input() | Whether the column can be hiding. Defaulted to |
@Input() | Hide or show when column hiding checkbox be checked. Defaulted to |
@Input() | Whether the column can be moving. Defaulted to |
@Input() | Whether the column can be fixed. Defaulted to |
@Output() | Event emitted when the column be hided or be resorted. |
@Input() | Whether show header of column menu. Defaulted to |
@Input() | The header text of column menu. Defaulted to |
@Input() | The header template of column menu. |
@Input() | Whether show footer of column menu. Defaulted to |
@Input() | The header text of column menu. Defaulted to |
@Input() | The footer template of column menu. |
@Input() | Whether show column menu button. Defaulted to |
@Input() | The column menu button text. Defaulted to |
@Input() | The column menu button type. Defaulted to |
@Input() | The column menu button color. Defaulted to |
@Input() | The column menu button class. Defaulted to |
@Input() | The column menu button icon. Defaulted to |
Row
Name | Description |
@Input() | Whether use hover style. Defaulted to |
@Input() | Whether use striped style. Defaulted to |
@Output() | Row click event. |
Templates
Name | Description |
@Input() | The grid header cell template. |
@Input() | The grid header cell template exclude sort. |
@Input() | The grid body cell template. |
Summary
Name | Description |
@Input() | Whether show summary. Defaulted to |
@Input() | The summary template. |
No result
Name | Description |
@Input() | The no result text. Defaulted to |
@Input() | The no result template. |
Sidebar
Name | Description |
@Input() | Whether show sidebar. Defaulted to |
@Input() | The sidebar template. |
Status bar
Name | Description |
@Input() | Whether show status bar. Defaulted to |
@Input() | The status bar template. |
Interfaces
Column
Column Type
Column Type Parameter
Column Sort Properties
Column Button
Column Tag
Row Selection Formatter
Row class formatter
Last updated