Class VexFlowGraphicalNote

The VexFlow version of a GraphicalNote.

Hierarchy

GraphicalNote
- VexFlowGraphicalNote

Constructors

constructor

new VexFlowGraphicalNote(note: Note, parent: GraphicalVoiceEntry, activeClef: ClefInstruction, octaveShift?: OctaveEnum, rules: EngravingRules, graphicalNoteLength?: Fraction): VexFlowGraphicalNote

Overrides GraphicalNote.constructor
- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:18
Parameters
- note: Note
- parent: GraphicalVoiceEntry
- activeClef: ClefInstruction
- octaveShift: OctaveEnum = OctaveEnum.NONE
- rules: EngravingRules
- graphicalNoteLength: Fraction = undefined
Returns VexFlowGraphicalNote

Properties

DrawnAccidental

DrawnAccidental: AccidentalEnum = AccidentalEnum.NONE

baseFingeringXOffset

baseFingeringXOffset: number

baseStringNumberXOffset

baseStringNumberXOffset: number

Protected boundingBox

boundingBox: BoundingBox

Private clef

clef: ClefInstruction

graphicalNoteLength

graphicalNoteLength: Fraction

lineShift

lineShift: number = 0

numberOfDots

numberOfDots: number

octaveShift

octaveShift: OctaveEnum

parentVoiceEntry

parentVoiceEntry: GraphicalVoiceEntry

rules

rules: EngravingRules

sourceNote

sourceNote: Note

staffLine

staffLine: number

vfnote

vfnote: [StemmableNote, number]

vfnoteIndex

vfnoteIndex: number

vfpitch

vfpitch: [string, string, ClefInstruction]

Accessors

ParentMusicPage

get ParentMusicPage(): GraphicalMusicPage

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

PositionAndShape

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

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

ToStringShortGet

get ToStringShortGet(): string

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

Methods

Clef

Clef(): ClefInstruction

- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:101
Gets the clef for this note

Returns ClefInstruction

ToStringShort

ToStringShort(octaveOffset?: number): string

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

Transpose

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

Overrides GraphicalNote.Transpose
- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:67
Parameters
- keyInstruction: KeyInstruction
- activeClef: ClefInstruction
- halfTones: number
- octaveEnum: OctaveEnum
Returns Pitch

drawPitch

drawPitch(pitch: Pitch): Pitch

- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:63
Parameters
- pitch: Pitch
Returns Pitch

getBeamSVGs

getBeamSVGs(): HTMLElement[]

- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:135
Gets the SVG path elements of the beams starting on this note.

Returns HTMLElement[]

getSVGGElement

getSVGGElement(): SVGGElement

- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:120
Gets the SVGGElement containing this note, given the SVGRenderer is used. This is for low-level rendering hacks and should be used with caution.

Returns SVGGElement

getSVGId

getSVGId(): string

- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:109
Gets the id of the SVGGElement containing this note, given the SVGRenderer is used. This is for low-level rendering hacks and should be used with caution.

Returns string

getStemSVG

getStemSVG(): HTMLElement

- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:128
Gets the SVG path element of the note's stem.

Returns HTMLElement

isInstanceOfClass

isInstanceOfClass(className: string): boolean

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

notehead

notehead(vfNote?: StemmableNote): { line: number }

- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:85
Parameters
- vfNote: StemmableNote = undefined
Returns { line: number }
- line: number

setAccidental

setAccidental(pitch: Pitch): void

- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:46
Update the pitch of this note. Necessary in order to display accidentals correctly. This is called by VexFlowGraphicalSymbolFactory.addGraphicalAccidental.

Parameters
- pitch: Pitch
Returns void

setIndex

setIndex(note: StemmableNote, index: number): void

- Defined in MusicalScore/Graphical/VexFlow/VexFlowGraphicalNote.ts:80
Set the VexFlow StaveNote corresponding to this GraphicalNote, together with its index in the chord.

Parameters
- note: StemmableNote
- index: number
Returns void

Static FromNote

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

Inherited from GraphicalNote.FromNote
- 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