Class GraphicalNote

The graphical counterpart of a Note

Hierarchy

GraphicalObject
- GraphicalNote
  - VexFlowGraphicalNote

Constructors

constructor

new GraphicalNote(note: Note, parent: GraphicalVoiceEntry, rules: EngravingRules, graphicalNoteLength?: Fraction): GraphicalNote

Overrides GraphicalObject.constructor
- Defined in MusicalScore/Graphical/GraphicalNote.ts:18
Parameters
- note: Note
- parent: GraphicalVoiceEntry
- rules: EngravingRules
- graphicalNoteLength: Fraction = undefined
Returns GraphicalNote

Properties

DrawnAccidental

DrawnAccidental: AccidentalEnum = AccidentalEnum.NONE

baseFingeringXOffset

baseFingeringXOffset: number

baseStringNumberXOffset

baseStringNumberXOffset: number

Protected boundingBox

boundingBox: BoundingBox

graphicalNoteLength

graphicalNoteLength: Fraction

lineShift

lineShift: number = 0

numberOfDots

numberOfDots: number

parentVoiceEntry

parentVoiceEntry: GraphicalVoiceEntry

rules

rules: EngravingRules

sourceNote

sourceNote: Note

staffLine

staffLine: number

Accessors

ParentMusicPage

get ParentMusicPage(): GraphicalMusicPage

- Defined in MusicalScore/Graphical/GraphicalNote.ts:65
Returns GraphicalMusicPage

PositionAndShape

get PositionAndShape(): BoundingBox
set PositionAndShape(value: BoundingBox): void

Inherited from GraphicalObject.PositionAndShape
- Defined in MusicalScore/Graphical/GraphicalObject.ts:8
Returns BoundingBox
Inherited from GraphicalObject.PositionAndShape
- Defined in MusicalScore/Graphical/GraphicalObject.ts:12
Parameters
- value: BoundingBox
Returns void

ToStringShortGet

get ToStringShortGet(): string

- Defined in MusicalScore/Graphical/GraphicalNote.ts:78
Returns string

Methods

ToStringShort

ToStringShort(octaveOffset?: number): string

- Defined in MusicalScore/Graphical/GraphicalNote.ts:75
Parameters
- octaveOffset: number = 0
Returns string

Transpose

Transpose(keyInstruction: KeyInstruction, activeClef: ClefInstruction, halfTones: number, octaveEnum: OctaveEnum): Pitch

- Defined in MusicalScore/Graphical/GraphicalNote.ts:45
Parameters
- keyInstruction: KeyInstruction
- activeClef: ClefInstruction
- halfTones: number
- octaveEnum: OctaveEnum
Returns Pitch

Private calculateNumberOfNeededDots

calculateNumberOfNeededDots(fraction: Fraction): number

- Defined in MusicalScore/Graphical/GraphicalNote.ts:58
Return the number of dots needed to represent the given fraction.

Parameters
- fraction: Fraction
Returns number

isInstanceOfClass

isInstanceOfClass(className: string): boolean

Inherited from GraphicalObject.isInstanceOfClass
- Defined in MusicalScore/Interfaces/AClassHierarchyTrackable.ts:5
Parameters
- className: string
Returns boolean

Static FromNote

FromNote(note: Note, rules: EngravingRules): GraphicalNote

- Defined in MusicalScore/Graphical/GraphicalNote.ts:71
Get a GraphicalNote from a Note. Use osmd.rules as the second parameter (instance reference). Also more easily available via osmd.rules.GNote(note).

Parameters
- note: Note
- rules: EngravingRules
Returns GraphicalNote

Generated using TypeDoc