NodeFlowMinimap<T> class

A minimap widget that provides an overview of the entire node flow graph.

The minimap shows a bird's-eye view of all nodes in the graph along with a viewport indicator showing the currently visible area. Users can interact with the minimap to navigate the graph by clicking or dragging.

Features:

  • Displays all nodes as simplified rectangles
  • Shows current viewport bounds as a highlighted region
  • Interactive navigation: click to jump, drag to pan
  • Customizable appearance (colors, size, border radius)
  • Reactive updates via MobX when graph changes

Example:

NodeFlowMinimap<MyData>(
  controller: controller,
  size: Size(200, 150),
  backgroundColor: Colors.white,
  nodeColor: Colors.blue,
  viewportColor: Colors.green,
  interactive: true,
)

The minimap is typically placed in a corner of the editor as an overlay. See MinimapOverlay for automatic positioning.

Inheritance
Available extensions

Constructors

NodeFlowMinimap({Key? key, required NodeFlowController<T> controller, Size size = const Size(200, 150), Color? backgroundColor, Color? nodeColor, Color? viewportColor, double borderRadius = 4.0, EdgeInsets padding = const EdgeInsets.all(4.0), bool showViewport = true, bool interactive = true})
const

Properties

backgroundColor Color?
Background color of the minimap.
final
borderRadius double
Border radius for the minimap widget corners.
final
controller NodeFlowController<T>
The controller managing the node flow graph.
final
hashCode int
The hash code for this object.
no setterinherited
interactive bool
Whether the minimap responds to user interaction.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
nodeColor Color?
Color used to draw nodes in the minimap.
final
padding EdgeInsets
Internal padding between minimap edge and content.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showViewport bool
Whether to show the viewport indicator rectangle.
final
size Size
The size of the minimap widget in pixels.
final
viewportColor Color?
Color used for the viewport indicator.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<NodeFlowMinimap<T>>
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, int wrapWidth = 65}) 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
withAnnotationLayer(NodeFlowController<T> controller) Widget

Available on Widget, provided by the AnnotationLayerSupport extension

Wraps this widget with an annotation layer.

Operators

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