InteractivePiano class

Renders a scrollable interactive piano.

Inheritance

Constructors

InteractivePiano({Key? key, required NoteRange noteRange, List<NotePosition> highlightedNotes = const [], Color highlightColor = Colors.red, Color naturalColor = Colors.white, Color accidentalColor = Colors.black, bool animateHighlightedNotes = false, bool useAlternativeAccidentals = false, bool hideNoteNames = false, bool hideScrollbar = false, OnNotePositionTapped? onNotePositionTapped, NotePosition? noteToScrollTo, double? keyWidth})
See individual parameters for more information. The only required parameter is noteRange. Since the widget wraps a scroll view and therefore has no "intrinsic" size, be sure to use inside a parent that specifies one.
const

Properties

accidentalColor Color
Color to render "accidental" notes (sharps and flats)—typically black.
final
animateHighlightedNotes bool
Whether to apply a repeating press animation to highlighted notes.
final
hashCode int
The hash code for this object.
no setterinherited
hideNoteNames bool
Whether to hide note names on keys.
final
hideScrollbar bool
Whether to hide the scroll bar, that appears below the keys.
final
highlightColor Color
The color with which to draw highlighted notes; blended with the color of the key.
final
highlightedNotes List<NotePosition>
The range of notes to highlight.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyWidth double?
Leave as null to have keys sized automatically to fit the width of the widget.
final
naturalColor Color
Color to render "natural" notes—typically white.
final
noteRange NoteRange
The range of notes to create interactive keys for.
final
noteToScrollTo NotePosition?
Set and change at any time (i.e. with setState) to cause the piano to scroll so that the desired note is centered.
final
onNotePositionTapped OnNotePositionTapped?
Callback for interacting with piano keys.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
useAlternativeAccidentals bool
Whether to treat tapped notes as flats instead of sharps. Affects the value passed to onNotePositionTapped.
final

Methods

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