Interface for a class Grid
EmitType<PageEventArgs|GroupEventArgs|FilterEventArgs|SearchEventArgs|SortEventArgs|AddEventArgs|SaveEventArgs|EditEventArgs|DeleteEventArgs|ActionEventArgs>
Triggers when Grid actions such as sorting, filtering, paging, grouping etc., starts.
<ejs-grid [dataSource]='data' allowPaging='true' (actionBegin)='actionBegin($event)'>
</ejs-grid>import { Component } from '@angular/core';
import { orderDetails } from './data';
import { PageEventArgs, PageService } from '@syncfusion/ej2-angular-grids'
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [PageService]
})
export class AppComponent {
public data: Object[] = orderDetails;
// For Paging action
public actionBegin(args: PageEventArgs) {
console.log(args.requestType);
}
} EmitType<PageEventArgs|GroupEventArgs|FilterEventArgs|SearchEventArgs|SortEventArgs|AddEventArgs|SaveEventArgs|EditEventArgs|DeleteEventArgs|ActionEventArgs>
Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.
Triggers when any Grid action failed to achieve the desired results.
EmitType<BatchAddArgs>
Triggers when records are added in batch mode.
EmitType<BatchCancelArgs>
Triggers when cancel the batch edit changes batch mode.
EmitType<BatchDeleteArgs>
Triggers when records are deleted in batch mode.
EmitType<BeforeAutoFillEventArgs>
Triggers before Grid autoFill action.
Triggers before records are added in batch mode.
EmitType<BeforeBatchDeleteArgs>
Triggers before records are deleted in batch mode.
Triggers before records are saved in batch mode.
Triggers before Grid copy action.
Triggers before data is bound to Grid.
EmitType<Object>
Triggers before Grid data is exported to Excel file.
EmitType<AdaptiveDialogEventArgs>
Triggers before adaptive filter and sort dialogs open.
EmitType<ColumnChooserEventArgs>
Triggers before the columnChooser open.
EmitType<BeforePasteEventArgs>
Triggers before Grid paste action.
EmitType<Object>
Triggers before Grid data is exported to PDF document.
Triggers before the print action starts.
Triggers before the record is to be edit.
EmitType<CellDeselectEventArgs>
Triggers when a particular selected cell is deselected.
EmitType<CellDeselectEventArgs>
Triggers before the selected cell is deselecting.
Triggers when the cell is being edited.
Triggers when cell is saved.
Triggers when cell is saved.
Triggers after a cell is selected.
EmitType<CellSelectingEventArgs>
Triggers before any cell selection occurs.
EmitType<CheckBoxChangeEventArgs>
Triggers when the check box state change in checkbox column.
EmitType<ColumnDataStateChangeEventArgs>
Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done to get column dataSource.
In this event,the current view column data and total record count should be assigned to the column dataSource based
on the action performed.
EmitType<ColumnDeselectEventArgs>
Triggers when a selected column is deselected.
EmitType<ColumnDeselectEventArgs>
Triggers before deselecting the selected column.
Triggers when column header element is dragged (moved) continuously.
Triggers when column header element drag (move) starts.
Triggers when a column header element is dropped on the target column.
EmitType<MenuEventArgs>
Triggers when click on column menu.
EmitType<ColumnMenuOpenEventArgs>
Triggers before column menu opens.
EmitType<ColumnSelectEventArgs>
Triggers after a column is selected.
EmitType<ColumnSelectingEventArgs>
Triggers before column selection occurs.
EmitType<CommandClickEventArgs>
Triggers when command button is clicked.
EmitType<MenuEventArgs>
Triggers when click on context menu.
EmitType<BeforeOpenCloseMenuEventArgs>
Triggers before context menu opens.
EmitType<Object>
Triggers when the component is created.
EmitType<Object>
Triggers when data source is populated in the Grid.
EmitType<DataSourceChangedEventArgs>
Triggers when the grid data is added, deleted and updated. Invoke the done method from the argument to start render after edit operation.
EmitType<DataStateChangeEventArgs>
Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done.
In this event,the current view data and total record count should be assigned to the dataSource based on the action performed.
EmitType<Object>
Triggers when the component is destroyed.
EmitType<DetailDataBoundEventArgs>
Triggers after detail row expands.
This event triggers at initial expand.
EmitType<AggregateQueryCellInfoEventArgs>
Triggers before exporting aggregate cell to Excel document. You can also customize the PDF cells.
EmitType<ExcelExportCompleteArgs>
Triggers after Grid data is exported to Excel file.
EmitType<ExcelHeaderQueryCellInfoEventArgs>
Triggers before exporting each header cell to Excel file. You can also customize the Excel cells.
EmitType<ExcelQueryCellInfoEventArgs>
Triggers before exporting each cell to Excel file. You can also customize the Excel cells.
EmitType<ExportDetailDataBoundEventArgs>
Triggers before exporting each detail Grid to PDF document.
EmitType<ExportDetailTemplateEventArgs>
Triggers before exporting each detail template.
EmitType<ExportGroupCaptionEventArgs>
Triggers before exporting each caption row to PDF/Excel/CSV document. You can also customize the export caption row values.
EmitType<HeaderCellInfoEventArgs>
Triggered for stacked header.
EmitType<KeyboardEventArgs>
Triggers when any keyboard keys are pressed inside the grid.
Triggers when collapse the caption row in lazy load grouping.
Triggers when expand the caption row in lazy load grouping.
EmitType<Object>
This event allows customization of Grid properties before rendering.
EmitType<AggregateQueryCellInfoEventArgs>
Triggers before exporting aggregate cell to PDF document. You can also customize the PDF cells.
EmitType<PdfExportCompleteArgs>
Triggers after Grid data is exported to PDF document.
EmitType<PdfHeaderQueryCellInfoEventArgs>
Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.
EmitType<PdfQueryCellInfoEventArgs>
Triggers before exporting each cell to PDF document. You can also customize the PDF cells.
Triggers after print action is completed.
EmitType<QueryCellInfoEventArgs>
Triggered every time a request is made to access cell information, element, or data. This will be triggered before the cell element is appended to the Grid element.
EmitType<RecordClickEventArgs>
Triggers when record is clicked.
EmitType<RecordDoubleClickEventArgs>
Triggers when record is double clicked.
Triggers when column resize starts.
Triggers when column resize ends.
Triggers on column resizing.
EmitType<RowDataBoundEventArgs>
Triggered every time a request is made to access row information, element, or data. This will be triggered before the row element is appended to the Grid element.
EmitType<RowDeselectEventArgs>
Triggers when a selected row is deselected.
EmitType<RowDeselectingEventArgs>
Triggers before deselecting the selected row.
Triggers when row elements are dragged (moved) continuously.
Triggers when row element’s drag(move) starts.
Triggers when row element’s before drag(move).
Triggers when row elements are dropped on the target row.
Triggers after a row is selected.
EmitType<RowSelectingEventArgs>
Triggers before row selection occurs.
EmitType<ClickEventArgs>
Triggers when toolbar item is clicked.
Configures the Grid aggregate rows.
<ejs-grid [dataSource]="data">
<e-columns>
<e-column field='CustomerName' headerText='Customer Name' width='150'></e-column>
<e-column field='Freight' headerText='Freight' width='150' format='C2' textAlign='Right'></e-column>
</e-columns>
<e-aggregates>
<e-aggregate>
<e-columns>
<e-column type="Sum" field="Freight" format="C2">
<ng-template #footerTemplate let-data>Sum: {{data.Sum}}</ng-template>
</e-column>
</e-columns>
</e-aggregate>
</e-aggregates>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { AggregateService,GridComponent } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [AggregateService]
})
export class AppComponent implements OnInit {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
}Check the
Aggregatesfor its configuration.
boolean
If allowExcelExport set to true, then it will allow the user to export grid to Excel file.
Check the
ExcelExportto configure exporting document.
<ejs-grid [dataSource]='data' [toolbar]='toolbar' [allowExcelExport]='true'>
</ejs-grid>import { Component, OnInit} from '@angular/core';
import { orderDetails } from './data';
import { GridComponent, ToolbarService, ExcelExportService} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [ToolbarService, ExcelExportService]
})
export class AppComponent implements OnInit {
public data: Object[];
public toolbar: string[];
public ngOnInit(): void {
this.data = orderDetails;
this.toolbar = ['ExcelExport'];
}
} boolean
If allowFiltering set to true the filter bar will be displayed.
If set to false the filter bar will not be displayed.
Filter bar allows the user to filter grid records with required criteria.
Check the
Filteringto customize its default behavior.
<ejs-grid [dataSource]='data' [allowFiltering]='true'>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent, FilterService} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[FilterService]
})
export class AppComponent implements OnInit {
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
} boolean
If allowGrouping set to true, then it will allow the user to dynamically group or ungroup columns.
Grouping can be done by drag and drop columns from column header to group drop area.
Check the
Groupingto customize its default behavior.
<ejs-grid [dataSource]='data' [allowGrouping]='true'>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent,GroupService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[GroupService]
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
} boolean
Enables or disables the key board interaction of Grid.
boolean
If allowMultiSorting set to true, then it will allow the user to sort multiple column in the grid.
allowSortingshould be true.
<ejs-grid [dataSource]='data' [allowSorting]='true' [allowMultiSorting]='true'>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent, SortService} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[SortService]
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
} boolean
If allowPaging is set to true, the pager renders at the footer of the Grid. It is used to handle page navigation in the Grid.
Check the
Pagingto configure the grid pager.
boolean
If allowPdfExport set to true, then it will allow the user to export grid to Pdf file.
Check the
Pdfexportto configure the exporting document.
<ejs-grid [dataSource]='data' [toolbar]='toolbar' [allowPdfExport]='true'>
</ejs-grid>import { Component, OnInit, ViewChild } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent, ToolbarService, PdfExportService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [ToolbarService, PdfExportService ]
})
export class AppComponent implements OnInit {
public data: Object[];
public toolbar: string[];
public ngOnInit(): void {
this.data = orderDetails;
this.toolbar = ['PdfExport'];
}
} boolean
If allowReordering is set to true, Grid columns can be reordered.
Reordering can be done by drag and drop of a particular column from one index to another index.
If Grid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
<ejs-grid [dataSource]='data' [allowReordering]="true">
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent, ReorderService} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[ReorderService]
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
} boolean
If allowResizing is set to true, Grid columns can be resized.
<ejs-grid [dataSource]='data' [allowResizing]="true">
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent, ResizeService} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[ResizeService]
})
export class AppComponent implements OnInit {
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
} boolean
If allowRowDragAndDrop is set to true, you can drag and drop grid rows at another grid.
<ejs-grid [dataSource]='data' [allowRowDragAndDrop]='true'>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent, RowDDService} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[RowDDService]
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
} boolean
If allowSelection is set to true, it allows selection of (highlight row) Grid records by clicking it.
<ejs-grid [dataSource]='data' [allowSelection]='true'>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
} boolean
If allowSorting is set to true, it allows sorting of grid records when column header is clicked.
Check the
Sortingto customize its default behavior.
<ejs-grid [dataSource]='data' [allowSorting]='true'>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent, SortService} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[SortService]
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
} boolean
If allowTextWrap set to true,
then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
<ejs-grid [dataSource]='data' [allowTextWrap]='true'>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
} boolean
If autoFit set to true, then it will auto fit the columns based on given width.
Defines Grid options to render child Grid.
It requires the queryString for parent
and child relationship.
Check the
Child Gridfor its configuration.
Defines the mode of clip. The available modes are,
Clip: Truncates the cell content when it overflows its area.
Ellipsis: Displays ellipsis when the cell content overflows its area.
EllipsisWithTooltip: Displays ellipsis when the cell content overflows its area,
also it will display the tooltip while hover on ellipsis is applied.
<ejs-grid [dataSource]='data' [clipMode]="Ellipsis">
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderDetails } from './data';
import { GridComponent} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderDetails;
}
}Configures the column chooser in the Grid.
ColumnMenuItem[] | ColumnMenuItemModel[]
columnMenuItems defines both built-in and custom column menu items.
The available built-in items are,
AutoFitAll - Auto fit the size of all columns.AutoFit - Auto fit the current column.Group - Group by current column.Ungroup - Ungroup by current column.SortAscending - Sort the current column in ascending order.SortDescending - Sort the current column in descending order.Filter - Filter options will show based on filterSettings property like checkbox filter, excel filter, menu filter.columnQueryModeprovides options to retrive data from the datasource.Their types are
All: It Retrives whole datasource.Schema: Retrives data for all the defined columns in grid from the datasource.ExcludeHidden: Retrives data only for visible columns of grid from the dataSource. Column[] | string[] | ColumnModel[]
Defines the schema of dataSource.
If the columns declaration is empty or undefined then the columns are automatically generated from data source.
<ejs-grid [dataSource]="data">
<e-columns>
<e-column field='CustomerName' headerText='Customer Name' width='150'></e-column>
<e-column field='Freight' headerText='Freight' width='150' format='C2' textAlign='Right'></e-column>
</e-columns>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
} ContextMenuItem[] | ContextMenuItemModel[]
contextMenuItems defines both built-in and custom context menu items.
The available built-in items are,
AutoFitAll - Auto fit the size of all columns.AutoFit - Auto fit the current column.Group - Group by current column.Ungroup - Ungroup by current column.Edit - Edit the current record.Delete - Delete the current record.Save - Save the edited record.Cancel - Cancel the edited state.Copy - Copy the selected records.PdfExport - Export the grid as Pdf format.ExcelExport - Export the grid as Excel format.CsvExport - Export the grid as CSV format.SortAscending - Sort the current column in ascending order.SortDescending - Sort the current column in descending order.FirstPage - Go to the first page.PrevPage - Go to the previous page.LastPage - Go to the last page.NextPage - Go to the next page. string
Defines the own class for the grid element.
ActionArgs
Gets or sets the current action details.
Object[]
Gets the currently visible records of the Grid.
Object | DataManager | DataResult
It is used to render grid table rows.
If the dataSource is an array of JavaScript objects,
then Grid will create instance of DataManager
from this dataSource.
If the dataSource is an existing DataManager,
the Grid will not initialize a new one.
Check the available
Adaptorsto customize the data operation.
<ejs-grid [dataSource]="data"> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
} string | Function
The detail template allows you to show or hide additional information about a particular row.
It accepts either the template string or the HTML element ID.
Configures the edit settings.
<ejs-grid [dataSource]="data" [editSettings]='editSettings' [toolbar]='toolbar'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent, EditService, ToolbarService, EditSettingsModel,ToolbarItems} from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [EditService, ToolbarService]
})
export class AppComponent implements OnInit{
public data: Object[];
public editSettings: EditSettingsModel;
public toolbar: ToolbarItems[];
public ngOnInit(): void {
this.data = orderData;
this.editSettings = { allowEditing: true, allowAdding: true, allowDeleting: true };
this.toolbar = ['Add', 'Edit', 'Delete', 'Update', 'Cancel'];
}
} string
Defines the version for Grid persistence.
string | Function
The empty record template that renders customized element or text or image instead of displaying the empty record message in the grid.
It accepts either the template string or the HTML element ID.
boolean
If enableAdaptiveUI set to true the grid filter, sort, and edit dialogs render adaptively.
boolean
If enableAltRow is set to true, the grid will render with e-altrow CSS class to the alternative tr elements.
Check the
AltRowto customize the styles of alternative rows.
<ejs-grid [dataSource]="data" [enableAltRow]="true"> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
} boolean
If enableAutoFill is set to true, then the auto fill icon will displayed on cell selection for copy cells.
It requires the selection mode to be Cell and cellSelectionMode to be Box.
<ejs-grid [dataSource]="data" [enableAutoFill]="true" [selectionSettings]="selectionOptions" > </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent,SelectionSettingsModel } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit{
public data: Object[];
public selectionOptions: SelectionSettingsModel;
public ngOnInit(): void {
this.data = orderData;
this.selectionOptions = { cellSelectionMode: 'Box', mode: 'Cell' };
}
} boolean
If enableColumnVirtualization set to true, then the Grid will render only the columns visible within the view-port
and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Grid.
<ejs-grid [dataSource]="data" height='300' [enableVirtualization]='true' [enableColumnVirtualization]='true'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent,VirtualScrollService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[VirtualScrollService]
})
export class AppComponent implements OnInit {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
} boolean
If enableHeaderFocus set to true, then header element will be focused when focus moves to grid.
boolean
If enableHover is set to true, the row hover is enabled in the Grid.
<ejs-grid [dataSource]="data" [enableHover]="true" > </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
} boolean
Specifies whether to display or remove the untrusted HTML values in the Grid component. If ‘enableHtmlSanitizer’ set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.
boolean
If enableImmutableMode is set to true, the grid will reuse old rows if it exists in the new result instead of
full refresh while performing the grid actions.
boolean
If enableInfiniteScrolling set to true, then the data will be loaded in Grid when the scrollbar reaches the end.
This helps to load large dataset in Grid.
<ejs-grid [dataSource]="data" height='300' enableInfiniteScrolling='true' > </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent,InfiniteScrollService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [InfiniteScrollService]
})
export class AppComponent implements OnInit{
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
} boolean
Enable or disable persisting component’s state between page reloads.
boolean
Enable or disable rendering component in right to left direction.
boolean
If ‘enableStickyHeader’ set to true, then the user can able to make the column headers visible when the document is scrolled.
boolean
Specifies the shimmer effect for Grid virtual and infinite scrolling.
boolean
If enableVirtualization set to true, then the Grid will render only the rows visible within the view-port
and load subsequent rows on vertical scrolling. This helps to load large dataset in Grid.
<ejs-grid [dataSource]="data" height='300' [enableVirtualization]='true'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent,VirtualScrollService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[VirtualScrollService]
})
export class AppComponent implements OnInit {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
} string[]
Defines the id of the grids that needs to be exported
Configures the filter settings of the Grid.
<ejs-grid [dataSource]="data" [allowFiltering]='true' [filterSettings]='filterOptions' > </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent,FilterSettingsModel, FilterService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[FilterService]
})
export class AppComponent implements OnInit{
public data: Object[];
public filterOptions: FilterSettingsModel;
public ngOnInit(): void {
this.data = orderData;
this.filterOptions = { type: 'Menu'};
}
} number
Gets or sets the number of frozen columns.
<ejs-grid [dataSource]="data" [frozenColumns]='1' > </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent,FreezeService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[FreezeService]
})
export class AppComponent implements OnInit {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
} number
Gets or sets the number of frozen rows.
<ejs-grid [dataSource]="data" [frozenRows]='2' > </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GridComponent,FreezeService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers:[FreezeService]
})
export class AppComponent implements OnInit {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
}Defines the mode of grid lines. The available modes are,
Both: Displays both horizontal and vertical grid lines.None: No grid lines are displayed.Horizontal: Displays the horizontal grid lines only.Vertical: Displays the vertical grid lines only.Default: Displays grid lines based on the theme. <ejs-grid [dataSource]='data' gridLines='Both'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html'
})
export class AppComponent {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
}Configures the group settings.
<ejs-grid [dataSource]='data' [allowGrouping]="true" [groupSettings]="groupOptions">
<e-columns>
<e-column field='CustomerName' headerText='Customer Name' width='150'></e-column>
<e-column field='Freight' headerText='Freight' width='150' format='C2' textAlign='Right'></e-column>
</e-columns>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { GroupService, GroupSettingsModel } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [GroupService]
})
export class AppComponent {
public data: Object[];
public groupOptions: GroupSettingsModel;
public ngOnInit(): void {
this.data = orderData;
this.groupOptions = { columns: ['Freight'] };
}
} string | number
Defines the scrollable height of the grid content.
<ejs-grid [dataSource]='data' height='400'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html'
})
export class AppComponent {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
}Defines the hierarchy grid print modes. The available modes are
Expanded - Prints the master grid with expanded child grids.All - Prints the master grid with all the child grids.None - Prints the master grid alone.Configures the infinite scroll settings.
<ejs-grid [dataSource]='data' [enableInfiniteScrolling]='true' [infiniteScrollSettings]='infiniteOptions' [pageSettings]='pageOptions' height:'400'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { InfiniteScrollService, InfiniteScrollSettingsModel, PageSettingsModel } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [InfiniteScrollService]
})
export class AppComponent {
public data: Object[];
public pageOptions: PageSettingsModel;
public infiniteOptions: InfiniteScrollSettingsModel;
public ngOnInit(): void {
this.data = orderData;
this.pageOptions = { pageSize: 50 };
this.infiniteOptions = { enableCache: true, maxBlocks: 3, initialBlocks: 3 };
}
}Configures the Loading Indicator of the Grid.
string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Configures the pager in the Grid.
<ejs-grid [dataSource]='data' [allowPaging]='true' [pageSettings]='pageOptions'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { PageService, PageSettingsModel } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [PageService]
})
export class AppComponent {
public data: Object[];
public optiopageOptionsns: PageSettingsModel;
public ngOnInit(): void {
this.data = orderData;
this.pageOptions = { currentPage: 1, pageSize: 12, pageCount: 8, pageSizes: true };
}
} string | Function
It used to render pager template
ParentDetails
Gets the parent Grid details.
Defines the print modes. The available print modes are
AllPages: Prints all pages of the Grid.CurrentPage: Prints the current page of the Grid. <ejs-grid [dataSource]='data' printMode='CurrentPage' [allowPaging]='true' [toolbar]='toolbarOptions'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { PageService, ToolbarService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [PageService, ToolbarService]
})
export class AppComponent {
public data: Object[];
public toolbarOptions: string[];
public ngOnInit(): void {
this.data = orderData;
this.toolbarOptions = ['Print'];
}
} Query
Defines the external Query
that will be executed along with data processing.
<ejs-grid [dataSource]='data' [query]='query'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { DataManager, ODataAdaptor, Query } from '@syncfusion/ej2-data';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html'
})
export class AppComponent {
public data: DataManager;
public query: Query;
public ngOnInit(): void {
this.data = new DataManager({
url: 'https://js.syncfusion.com/demos/ejServices/Wcf/Northwind.svc/Orders?$top=7',
adaptor: new ODataAdaptor()
});
this.query = new Query().addParams('ej2grid', 'true');
}
} string
Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.
Defines the resizing behavior of the Grid.
Configures the row drop settings.
number
Defines the height of Grid rows.
<ejs-grid [dataSource]='data' rowHeight='20'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html'
})
export class AppComponent {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
}Defines the grid row elements rendering direction. The available directions are,
Horizontal: Renders the grid row elements in the horizontal directionVertical: Renders the grid row elements in the vertical direction string | Function
The row template that renders customized rows from the given template. By default, Grid renders a table row for every data source item.
- It accepts either template string or HTML element ID.
- The row template must be a table row. Check the
Row Templatecustomization.
Configures the search behavior in the Grid.
<ejs-grid [dataSource]='data' [searchSettings]='searchOptions' [toolbar]='toolbarOptions'>
<e-columns>
<e-column field='CustomerName' headerText='Customer Name' width='150'></e-column>
<e-column field='Freight' headerText='Freight' width='150' format='C2' textAlign='Right'></e-column>
</e-columns>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { ToolbarService, SearchService, SearchSettingsModel } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [ToolbarService, SearchService]
})
export class AppComponent {
public data: Object[];
public toolbarOptions: string[];
public searchOptions: SearchSettingsModel;
public ngOnInit(): void {
this.data = orderData;
this.toolbarOptions = ['Search'];
this.searchOptions = { fields: ['CustomerName'], key: 'Ha' };
}
} number
The selectedRowIndex allows you to select a row at initial rendering.
You can also get the currently selected row index.
<ejs-grid [dataSource]='data' [selectedRowIndex]='5'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html'
})
export class AppComponent {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
}Configures the selection settings.
<ejs-grid [dataSource]='data' [selectionSettings]='selectionOptions'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { SelectionSettingsModel } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html'
})
export class AppComponent {
public data: Object[];
public selectionOptions: SelectionSettingsModel;
public ngOnInit(): void {
this.data = orderData;
this.selectionOptions = { mode: 'Cell', cellSelectionMode: 'Box', type: 'Multiple' };
}
} boolean
If showColumnChooser is set to true, it allows you to dynamically show or hide columns.
Check the
ColumnChooserfor its configuration.
<ejs-grid [dataSource]='data' [toolbar]='toolbarOptions' [showColumnChooser]='true'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { ColumnChooserService , ToolbarService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [ColumnChooserService, ToolbarService]
})
export class AppComponent {
public data: Object[];
public toolbarOptions: string[];
public ngOnInit(): void {
this.data = orderData;
this.toolbarOptions = ['ColumnChooser'];
}
} boolean
If showColumnMenu set to true, then it will enable the column menu options in each columns.
Check the
Column menufor its configuration.
<ejs-grid [dataSource]='data' showColumnMenu='true'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { ColumnMenuService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [ColumnMenuService]
})
export class AppComponent {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
}The showHider is used to manipulate column’s show/hide operation in the Grid.
Configures the sort settings.
<ejs-grid [dataSource]='data' [allowSorting]='true' [sortSettings]='sortOptions'>
<e-columns>
<e-column field='CustomerName' headerText='Customer Name' width='150'></e-column>
<e-column field='Freight' headerText='Freight' width='150' format='C2' textAlign='Right'></e-column>
</e-columns>
</ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { SortService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [SortService]
})
export class AppComponent {
public data: Object[];
public sortOptions: object;
public ngOnInit(): void {
this.data = orderData;
this.sortOptions = { columns: [{ field: 'CustomerName', direction: 'Ascending' }] };
}
}Configures the text wrap in the Grid.
<ejs-grid [dataSource]='data' allowTextWrap='true' [textWrapSettings]='wrapOption'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html'
})
export class AppComponent {
public data: Object[];
public wrapOption: Object;
public ngOnInit(): void {
this.data = orderData;
this.wrapOption = { wrapMode: 'Both' };
}
}[]
toolbar defines the ToolBar items of the Grid.
It contains built-in and custom toolbar items.
If a string value is assigned to the toolbar option, it is considered as the template for the whole Grid ToolBar.
If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Grid’s Toolbar.
The available built-in ToolBar items are:
CsvExport - Export the Grid to CSV(csvExport() method manually to make export.)
The following code example implements the custom toolbar items.
Check the
Toolbarto customize its default items.
<ejs-grid [dataSource]='data' [toolbar]='toolbarOptions'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
import { ToolbarService } from '@syncfusion/ej2-angular-grids';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
providers: [ToolbarService]
})
export class AppComponent {
public data: Object[];
public toolbarOptions: string[];
public ngOnInit(): void {
this.data = orderData;
this.toolbarOptions = ['Search','Print'];
}
} string | Function
It used to render toolbar template
string | number
Defines the Grid width.
<ejs-grid [dataSource]='data' width='700'> </ejs-grid>import { Component, OnInit } from '@angular/core';
import { orderData } from './data';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html'
})
export class AppComponent {
public data: Object[];
public ngOnInit(): void {
this.data = orderData;
}
}