Class VexFlowGraphicalNote

constructor

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

  Parameters

  • note: Note
  • parent: GraphicalVoiceEntry
  • activeClef: ClefInstruction
  • octaveShift: OctaveEnum = OctaveEnum.NONE
  • rules: EngravingRules
  • graphicalNoteLength: Fraction = undefined

  Returns VexFlowGraphicalNote

octaveShift

vfnote

vfnoteIndex

vfpitch

Clef

• Clef(): ClefInstruction

  Gets the clef for this note

  Returns ClefInstruction

drawPitch

• drawPitch(pitch: Pitch): Pitch

  Parameters

  • pitch: Pitch

  Returns Pitch

getBeamSVGs

• getBeamSVGs(): HTMLElement[]

  Gets the SVG path elements of the beams starting on this note.

  Returns HTMLElement[]

getFlagSVG

• getFlagSVG(): HTMLElement

  Returns HTMLElement

getGlissandoSVGs

• getGlissandoSVGs(): HTMLElement[]

  Gets the SVG groups of the glissandi and slides starting at this note: each with the line, and in a TAB staff the label "sl.". A glissando across a system break has a group in each system (see VexFlowMusicSheetDrawer.drawGlissando()).

  Returns HTMLElement[]

getLedgerLineSVGs

• getLedgerLineSVGs(): HTMLElement[]

  Gets the SVG path elements of the note's ledger lines.

  Returns HTMLElement[]

getModifierSVGs

• getModifierSVGs(): HTMLElement[]

  Gets the SVG elements of the note's modifiers: the groups of a stave note's modifiers (e.g. accidentals), or the shapes of a TAB note's modifiers (e.g. a bend's curve, arrow and label).

  Returns HTMLElement[]

getNoteheadSVGs

• getNoteheadSVGs(): HTMLElement[]

  Gets the SVG elements of the note heads, e.g. the paths of a chord's heads, or the fret numbers of a TAB note (and its chord).

  Returns HTMLElement[]

getSlurSVGs

• getSlurSVGs(): HTMLElement[]

  Gets the SVG path elements of the note's slur curve.

  Returns HTMLElement[]

getStemSVG

• getStemSVG(): HTMLElement

  Gets the SVG path element of the note's stem.

  Returns HTMLElement

getSVGGElement

• getSVGGElement(): SVGGElement

  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

  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

getTieSVGs

• getTieSVGs(): HTMLElement[]

  Gets the SVG groups of the ties starting at this note, each with the tie's curve. A tie across a system break has a group in each system (see VexFlowMeasure.addStaveTie()).

  Returns HTMLElement[]

getVFNoteSVG

• getVFNoteSVG(): HTMLElement

  Returns HTMLElement

notehead

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

  Parameters

  • vfNote: StemmableNote = undefined

  Returns { line: number }

setAccidental

• setAccidental(pitch: Pitch): void

  Update the pitch of this note. Necessary in order to display accidentals correctly. This is called by VexFlowGraphicalSymbolFactory.addGraphicalAccidental.

  Parameters

  • pitch: Pitch

  Returns void

setColor

• setColor(color: string, coloringOptions?: ColoringOptions): void

  Change the color of a note (without re-rendering). See ColoringOptions for options like applyToBeams etc. For a TAB note, the note heads are its fret numbers, and its modifiers e.g. bends. This requires the SVG backend (default, instead of canvas backend).

  Parameters

  • color: string
  • coloringOptions: ColoringOptions = {}

  Returns void

setIndex

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

  Set the VexFlow StaveNote corresponding to this GraphicalNote, together with its index in the chord.

  Parameters

  • note: StemmableNote
  • index: number

  Returns void

setVisible

• setVisible(visible: boolean, visibilityOptions?: VisibilityOptions): void

  Toggle visibility of the note, making it and its stem and beams invisible for false. By default, this will also hide the note's slurs, ties and glissandi, e.g. slides (see visibilityOptions). (This only works with the default SVG backend, not with the Canvas backend/renderer) To get a GraphicalNote from a Note, use osmd.EngravingRules.GNote(note).

  Parameters

  • visible: boolean
  • visibilityOptions: VisibilityOptions = {}

  Returns void

Transpose

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

  Parameters

  • keyInstruction: KeyInstruction
  • activeClef: ClefInstruction
  • halfTones: number
  • octaveEnum: OctaveEnum

  Returns Pitch