KeySignature class final

A key signature.


See also:

Implemented types
Annotations
  • @immutable

Constructors

KeySignature(List<Note> _notes)
Creates a new KeySignature from _notes.
const
KeySignature.fromDistance(int distance)
Creates a new KeySignature from fifths distance.
factory

Properties

accidental Accidental
The main Accidental of this KeySignature.
no setter
clean KeySignature
Returns a new KeySignature without cancellation Accidental.naturals.
no setter
distance int?
The fifths distance of this KeySignature.
no setter
hashCode int
The hash code for this object.
no setteroverride
isCanonical bool
Whether this KeySignature is canonical (has an associated Key).
no setter
keys Map<TonalMode, Key>
Returns a Map with the keys defined by this KeySignature, or empty when KeySignature.isCanonical returns false.
no setter
notes List<Note>
The set of Note that define this KeySignature, which may include cancellation Accidental.naturals.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

compareTo(KeySignature other) int
Compares this object to another object.
override
incrementBy(int distance) KeySignature?
Returns a new KeySignature incrementing its fifths distance.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
override
operator |(KeySignature other) KeySignature
The consecutive union of two KeySignatures (as if divided by a barline), including cancellation Accidental.naturals when needed.

Constants

empty → const KeySignature
An empty KeySignature.