Class GraphicalNote

constructor

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

  Parameters

  • note: Note
  • parent: GraphicalVoiceEntry
  • rules: EngravingRules
  • graphicalNoteLength: Fraction = undefined

  Returns GraphicalNote

baseFingeringXOffset

baseStringNumberXOffset

DrawnAccidental

graphicalNoteLength

lineShift

numberOfDots

parentVoiceEntry

rules

sourceNote

staffLine

ParentMusicPage

• get ParentMusicPage(): GraphicalMusicPage

  Returns GraphicalMusicPage

ToStringShortGet

• get ToStringShortGet(): string

  Returns string

getLyricsSVGs

• getLyricsSVGs(): HTMLElement[]

  Returns HTMLElement[]

setColor

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

  Change the color of a note (without re-rendering). See ColoringOptions for options like applyToBeams etc. This requires the SVG backend (default, instead of canvas backend).

  Parameters

  • color: string
  • coloringOptions: ColoringOptions

  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 and ties (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

ToStringShort

• ToStringShort(octaveOffset?: number): string

  Parameters

  • octaveOffset: number = 0

  Returns string

Transpose

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

  Parameters

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

  Returns Pitch

StaticFromNote

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

  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