PerformanceHud class

Floating window that shows the metrics collected by PerformanceMonitorStore.

Mount it above the Navigator so it stays visible on every page. The window can be dragged anywhere on screen, and only the window itself is interactive, so the rest of the screen keeps receiving gestures.

Colors and wording come from PerformanceTheme; see that class for how to restyle or translate the window.

Inheritance

Constructors

PerformanceHud({required Widget child, required PerformanceMonitorStore store, required PerformanceHudController controller, VoidCallback? onOpenDashboard, VoidCallback? onHidden, Key? key})
Creates the floating window that wraps child.
const

Properties

child → Widget
The app content the window floats above.
final
controller → PerformanceHudController
Visibility, expansion, and position of the window.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onHidden → VoidCallback?
Called right after the user closes the window.
final
onOpenDashboard → VoidCallback?
Called when the user taps the details button.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
store → PerformanceMonitorStore
Store to read the live metrics from.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<PerformanceHud>
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

Operators

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