PlutoGrid class

PlutoGrid is a widget that receives columns and rows and is expressed as a grid-type UI.

PlutoGrid supports movement and editing with the keyboard, Through various settings, it can be transformed and used in various UIs.

Pop-ups such as date selection, time selection, and option selection used inside PlutoGrid are created with the API provided outside of PlutoGrid. Also, the popup to set the filter or column inside the grid is implemented through the setting of PlutoGrid.

Inheritance

Constructors

PlutoGrid({Key? key, required List<PlutoColumn> columns, required List<PlutoRow> rows, List<PlutoColumnGroup>? columnGroups, PlutoOnLoadedEventCallback? onLoaded, PlutoOnChangedEventCallback? onChanged, PlutoOnSelectedEventCallback? onSelected, PlutoOnSortedEventCallback? onSorted, PlutoOnRowCheckedEventCallback? onRowChecked, PlutoOnRowDoubleTapEventCallback? onRowDoubleTap, PlutoOnRowSecondaryTapEventCallback? onRowSecondaryTap, PlutoOnRowsMovedEventCallback? onRowsMoved, PlutoOnColumnsMovedEventCallback? onColumnsMoved, CreateHeaderCallBack? createHeader, CreateFooterCallBack? createFooter, Widget? noRowsWidget, PlutoRowColorCallback? rowColorCallback, PlutoColumnMenuDelegate? columnMenuDelegate, PlutoGridConfiguration configuration = const PlutoGridConfiguration(), PlutoChangeNotifierFilterResolver? notifierFilterResolver, PlutoGridMode mode = PlutoGridMode.normal}): const

Properties

columnGroups → List<PlutoColumnGroup>?: columnGroups can be expressed in UI by grouping columns.
final
columnMenuDelegate → PlutoColumnMenuDelegate?: Column menu can be customized.
final
columns → List<PlutoColumn>: The PlutoColumn column is delivered as a list and can be added or deleted after grid creation.
final
configuration → PlutoGridConfiguration: In configuration, you can change the style and settings or text used in PlutoGrid.
final
createFooter → CreateFooterCallBack?: createFooter is equivalent to createHeader. However, it is located at the bottom of the grid.
final
createHeader → CreateHeaderCallBack?: createHeader is a user-definable area located above the upper column area of PlutoGrid.
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
mode → PlutoGridMode: Execution mode of PlutoGrid.
final
noRowsWidget → Widget?: Widget to be shown if there are no rows.
final
notifierFilterResolver → PlutoChangeNotifierFilterResolver?: final
onChanged → PlutoOnChangedEventCallback?: onChanged is called when the cell value changes.
final
onColumnsMoved → PlutoOnColumnsMovedEventCallback?: Callback for receiving events when the column is moved by dragging the column or frozen it to the left or right.
final
onLoaded → PlutoOnLoadedEventCallback?: PlutoGrid completes setting and passes PlutoGridStateManager to event.
final
onRowChecked → PlutoOnRowCheckedEventCallback?: onRowChecked can receive the check status change of the checkbox when PlutoColumn.enableRowChecked is enabled.
final
onRowDoubleTap → PlutoOnRowDoubleTapEventCallback?: onRowDoubleTap is called when a row is tapped twice in a row.
final
onRowSecondaryTap → PlutoOnRowSecondaryTapEventCallback?: onRowSecondaryTap is called when a mouse right-click event occurs.
final
onRowsMoved → PlutoOnRowsMovedEventCallback?: onRowsMoved is called after the row is dragged and moved if PlutoColumn.enableRowDrag is enabled.
final
onSelected → PlutoOnSelectedEventCallback?: onSelected can receive a response only if PlutoGrid.mode is set to PlutoGridMode.select .
final
onSorted → PlutoOnSortedEventCallback?: onSorted is a callback that is called when column sorting is changed.
final
rowColorCallback → PlutoRowColorCallback?: rowColorCallback can change the row background color dynamically according to the state.
final
rows → List<PlutoRow>: rows contains a call to the PlutoGridStateManager.initializeRows method that handles necessary settings when creating a grid or when a new row is added.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → PlutoGridState: Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object.
inherited
toStringShort() → String: A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

initializeDateFormat() → dynamic: initializeDateFormat should be called when you need to set date format when changing locale.
setDefaultLocale(String locale) → dynamic: setDefaultLocale sets locale when Intl package is used in PlutoGrid.