OpenSheetMusicDisplay
    Preparing search index...

    Class Note

    Represents a single pitch with a duration (length)

    Index

    Constructors

    Properties

    CustomNoteheadVFCode: string

    Custom notehead vexflow code. E.g. "vb" = quarter, "v1d" = whole, "v53" = half, etc. - see tables.js Set this before render() (e.g. after load, before first render).

    displayOctaveUnpitched: number
    displayStepUnpitched: NoteEnum
    DotsXml: number
    halfTone: number

    The transposed (!!!) HalfTone of this note.

    IsGraceNote: boolean
    IsWholeMeasureRest: boolean
    NoteToGraphicalNoteObjectId: number

    Used by GraphicalNote.FromNote(note) and osmd.rules.GNote(note) to get a GraphicalNote from a Note. Note that we don't want the data model (Note) to be dependent on the graphical implementation (GraphicalNote), and have (potentially circular) import dependencies of graphical parts, which also applies to other non-graphical classes. That's why we don't save a GraphicalNote reference directly in Note.

    state: NoteState
    StringInstruction: TechnicalInstruction
    TransposedPitch: Pitch

    The transposed pitch, if the score is transposed, otherwise undefined.

    TremoloInfo: TremoloInfo

    The number of tremolo strokes this note has (16th tremolo = 2 strokes). Could be a Tremolo object in future when there is more data like tremolo between two notes.

    Accessors

    Methods

    • Note: May be dangerous to use if ParentStaffEntry.VerticalContainerParent etc is not set. better calculate this directly when you have access to the note's measure. whole rest: length = measure length. (4/4 in a 4/4 time signature, 3/4 in a 3/4 time signature, 1/4 in a 1/4 time signature, etc.)

      Returns boolean