datagrid library

The Syncfusion Flutter DataGrid is used to display and manipulate data in a tabular view. Its rich feature set includes different types of columns, selections, column sizing, etc.

To use, import package:syncfusion_flutter_datagrid/datagrid.dart.

Classes

ColumnResizeEndDetails: Holds the arguments for the SfDataGrid.onColumnResizeEnd callback.
ColumnResizeStartDetails: Holds the arguments for the SfDataGrid.onColumnResizeStart callback.
ColumnResizeUpdateDetails: Holds the arguments for the SfDataGrid.onColumnResizeUpdate callback.
ColumnSizer: Handles the sizing for all the columns in the SfDataGrid.
DataGridCell<T>: The data for a cell of a SfDataGrid.
DataGridCellDetails: A base class which provides the details for callbacks that use DataGridCellTapDetails, DataGridCellDoubleTapDetails and DataGridCellLongPressDetails.
DataGridCellDoubleTapDetails: Details for callbacks that use DataGridCellDoubleTapDetails.
DataGridCellLongPressDetails: Details for callbacks that use DataGridCellLongPressDetails.
DataGridCellTapDetails: Details for callbacks that use DataGridCellTapDetails.
DataGridCheckboxColumnSettings: Contains all the properties of the checkbox column.
DataGridColumnDragDetails: Holds the arguments of the SfDataGrid.onColumnDragging callback.
DataGridController: Controls a SfDataGrid widget.
DataGridFilterChangeDetails: Details for callbacks that use DataGridFilterChangeDetails.
DataGridRow: Row configuration and cell data for a SfDataGrid.
DataGridRowAdapter: Row configuration and widget of cell for a SfDataGrid.
DataGridSource: A datasource for obtaining the row data for the SfDataGrid.
DataGridSourceChangeNotifier: A class that can be provided the change notification to the SfDataGrid.
DataGridSwipeEndDetails: Holds the arguments for the SfDataGrid.onSwipeEnd callback.
DataGridSwipeStartDetails: Holds the arguments for the SfDataGrid.onSwipeStart callback.
DataGridSwipeUpdateDetails: Holds the arguments for the SfDataGrid.onSwipeUpdate callback.
DataPagerController: A controller for SfDataPager.
DataPagerDelegate: A delegate that provides the row count details and method to listen the page navigation in SfDataPager.
FilterCondition: Controls how the filtering should be applied in SfDataGrid.
FilterPopupMenuOptions: Controls how the filtering menu options can be customized.
GridColumn: Provides the base functionalities for all the column types in SfDataGrid.
GridHeaderCellElement: An instantiation of a GridHeaderCell widget at a particular location in the tree.
GridSummaryColumn: Column configuration for table summary row.
GridTableSummaryRow: Row configuration of table summary in SfDataGrid.
RowColumnIndex: Holds the coordinates for a cell.
RowHeightDetails: Details for callbacks that use RowHeightDetails see also:
RowSelectionManager: Processes the row selection operation in SfDataGrid.
SelectionManagerBase: Provides the base functionalities to process the selection in SfDataGrid.
SfDataGrid: A material design datagrid.
SfDataGridState: Contains the state for a SfDataGrid. This class can be used to programmatically show the refresh indicator, see the refresh method.
SfDataPager: A widget that provides the paging functionality.
SortColumnDetails: Configuration details to sort a column in SfDataGrid.
StackedHeaderCell: Column configuration for stacked header row in SfDataGrid.
StackedHeaderRow: Row configuration for stacked header in SfDataGrid. The columns for this stacked header row are provided in the StackedHeaderCell property of the StackedHeaderRow object.

Enums

CellType: Describes the possible values for cell types.
ColumnHeaderIconPosition: The position of the icon in the column headers.
ColumnResizeMode: Decides whether column resizing should be processed when resizing indicator moves or pointer stopped contacting the screen.
ColumnWidthCalculationRange: Determines how the row count should be considered when calculating the width of a column.
ColumnWidthMode: Determines how the width of the columns are adjusted.
DataGridColumnDragAction: Determine the status of the current dragging column.
DataGridRowSwipeDirection: The direction in which a row in SfDataGrid is swiped.
DataGridScrollPosition: Decides how to scroll request to the corresponding position.
DataGridSortDirection: Specifies the direction of the sort operation.
EditingGestureType: Specifies the different tap actions available for allow editing.
FilterBehavior: Determines how the filter comparison should behave.
FilterMode: Decides how the checked listbox and advanced filter options should be shown in filter popup
FilterOperator: Determines the type of the logical operator to be applied between multiple filter conditions.
FilterType: Determines the type of the filter condition which should be compared between rows.
GridLinesVisibility: Determines how border lines should be shown in SfDataGrid.
GridNavigationMode: Decides whether the navigation in the SfDataGrid should be cell wise or row wise.
GridSummaryType: Determines which summary type should be displayed for summary column.
GridTableSummaryRowPosition: Determines how table summary row should be positioned in SfDataGrid.
RowRegion: Describes the possible values for row region.
RowType: Describes the possible values for row types.
SelectionMode: Determines how the selection is applied.
SortingGestureType: Specifies the different tap actions available for applying sorting.

Functions

setSwipeOffsetInDataGridSwipeStartDetailsArgs(DataGridConfiguration dataGridConfiguration, DataGridSwipeStartDetails swipeStartDetails) → void: Sets the dataGridConfiguration instance to the DataGridSwipeStartDetails class

Typedefs

CellSubmit = void Function(): The signature of DataGridSource.canSubmitCell and DataGridSource.onCellSubmit methods.
ColumnDragFeedbackBuilderCallback = Widget Function(BuildContext context, GridColumn column): Signature for SfDataGrid. columnDragFeedbackBuilder callback.
ColumnResizeEndCallback = void Function(ColumnResizeEndDetails details): Signature for the SfDataGrid.onColumnResizeEnd callback.
ColumnResizeStartCallback = bool Function(ColumnResizeStartDetails details): Signature for the SfDataGrid.onColumnResizeStart callback.
ColumnResizeUpdateCallback = bool Function(ColumnResizeUpdateDetails details): Signature for the SfDataGrid.onColumnResizeUpdate callback.
CurrentCellActivatedCallback = void Function(RowColumnIndex newRowColumnIndex, RowColumnIndex oldRowColumnIndex): Signature for SfDataGrid.onCurrentCellActivated callback.
CurrentCellActivatingCallback = bool Function(RowColumnIndex newRowColumnIndex, RowColumnIndex oldRowColumnIndex): Signature for SfDataGrid.onCurrentCellActivating callback.
DataGridCellDoubleTapCallback = void Function(DataGridCellDoubleTapDetails details): Signature for SfDataGrid.onCellDoubleTap callback.
DataGridCellLongPressCallback = void Function(DataGridCellLongPressDetails details): Signature for SfDataGrid.onCellLongPress callback.
DataGridCellTapCallback = void Function(DataGridCellTapDetails details): Signature for SfDataGrid.onCellTap and SfDataGrid.onCellSecondaryTap callbacks.
DataGridColumnDraggingCallback = bool Function(DataGridColumnDragDetails details): Signature for SfDataGrid.onColumnDragging callback.
DataGridFilterChangedCallback = void Function(DataGridFilterChangeDetails details): Signature for the SfDataGrid.onFilterChanged callback.
DataGridFilterChangingCallback = bool Function(DataGridFilterChangeDetails details): Signature for the SfDataGrid.onFilterChanging callback.
DataGridSwipeActionsBuilder = Widget? Function(BuildContext context, DataGridRow dataGridRow, int rowIndex): Holds the arguments for the SfDataGrid.startSwipeActionsBuilder callback.
DataGridSwipeEndCallback = void Function(DataGridSwipeEndDetails swipeEndDetails): Signature for the SfDataGrid.onSwipeEnd callback.
DataGridSwipeStartCallback = bool Function(DataGridSwipeStartDetails swipeStartDetails): Signature for the SfDataGrid.onSwipeStart callback.
DataGridSwipeUpdateCallback = bool Function(DataGridSwipeUpdateDetails swipeUpdateDetails): Signature for the SfDataGrid.onSwipeUpdate callback.
DataPagerItemBuilderCallback<Widget> = Widget? Function(String text): Signature for the SfDataPager.pageItemBuilder callback.
LoadMoreRows = Future<void> Function(): The signature of DataGridSource.handleLoadMoreRows function.
LoadMoreViewBuilder = Widget? Function(BuildContext context, LoadMoreRows loadMoreRows): Signature for the SfDataGrid.loadMoreViewBuilder function.
PageNavigationEnd = void Function(int pageIndex): Signature for the SfDataPager.onPageNavigationEnd callback.
PageNavigationStart = void Function(int pageIndex): Signature for the builder callback used by SfDataPager.onPageNavigationStart.
QueryRowHeightCallback = double Function(RowHeightDetails details): Signature for SfDataGrid.onQueryRowHeight callback
SelectionChangedCallback = void Function(List<DataGridRow> addedRows, List<DataGridRow> removedRows): Signature for SfDataGrid.onSelectionChanged callback.
SelectionChangingCallback = bool Function(List<DataGridRow> addedRows, List<DataGridRow> removedRows): Signature for SfDataGrid.onSelectionChanging callback.

datagrid library

Classes

Enums

Functions

Typedefs

syncfusion_flutter_datagrid package

datagrid library