Class Flow

constructor

• new Flow(): Flow

• Returns Flow

Static Accidental

Static Annotation

Static AnnotationHorizontalJustify

Static AnnotationVerticalJustify

Static Articulation

Static BarNote

Static Barline

Static BarlineType

Static Beam

Static Bend

Static BoundingBox

Static BoundingBoxComputation

Static CanvasContext

Static ChordSymbol

Static ChordSymbolHorizontalJustify

Static ChordSymbolVerticalJustify

Static Clef

Static ClefNote

Static Crescendo

Static Curve

Static CurvePosition

Static Dot

Static EasyScore

Static Element

Static Factory

Static Font

Static FontStyle

Static FontWeight

Static Formatter

Static Fraction

Static FretHandFinger

Static GhostNote

Static Glyph

Static GlyphNote

Static GraceNote

Static GraceNoteGroup

Static GraceTabNote

Static KeyManager

Static KeySigNote

Static KeySignature

Static Modifier

Static ModifierContext

Static ModifierPosition

Static MultiMeasureRest

Static Music

Static Note

Static NoteHead

Static NoteSubGroup

Static Ornament

Static Parenthesis

Static Parser

Static PedalMarking

Static Registry

Static RenderContext

Static Renderer

Static RendererBackends

Static RendererLineEndType

Static RepeatNote

Static Repetition

Static SVGContext

Static Stave

Static StaveConnector

Static StaveHairpin

Static StaveLine

Static StaveModifier

Static StaveModifierPosition

Static StaveNote

Static StaveTempo

Static StaveText

Static StaveTie

Static Stem

Static StringNumber

Static Stroke

Static SymbolModifiers

Static SymbolTypes

Static System

Static TabNote

Static TabSlide

Static TabStave

Static TabTie

Static TextBracket

Static TextBracketPosition

Static TextDynamics

Static TextFormatter

Static TextJustification

Static TextNote

Static TickContext

Static TimeSigNote

Static TimeSignature

Static Tremolo

Static Tuning

Static Tuplet

Static Vibrato

Static VibratoBracket

Static Voice

Static VoiceMode

Static Volta

Static VoltaType

Static BUILD

• get BUILD(): {
      DATE: string;
      ID: string;
      VERSION: string;
  }

• Returns {
      DATE: string;
      ID: string;
      VERSION: string;
  }

  • DATE: string

    The date when this library was compiled.

  • ID: string

    git commit ID that this library was built from.

  • VERSION: string

    version number.

Static NOTATION_FONT_SCALE

• get NOTATION_FONT_SCALE(): number

• Returns number

• set NOTATION_FONT_SCALE(value): void

• Parameters

  • value: number

  Returns void

Static RENDER_PRECISION_PLACES

• get RENDER_PRECISION_PLACES(): number

• Returns number

• set RENDER_PRECISION_PLACES(precision): void

• Parameters

  • precision: number

  Returns void

Static RESOLUTION

• get RESOLUTION(): number

• Returns number

• set RESOLUTION(value): void

• Parameters

  • value: number

  Returns void

Static SLASH_NOTEHEAD_WIDTH

• get SLASH_NOTEHEAD_WIDTH(): number

• Returns number

• set SLASH_NOTEHEAD_WIDTH(value): void

• Parameters

  • value: number

  Returns void

Static SOFTMAX_FACTOR

• get SOFTMAX_FACTOR(): number

• Returns number

• set SOFTMAX_FACTOR(factor): void

• Parameters

  • factor: number

  Returns void

Static STAVE_LINE_DISTANCE

• get STAVE_LINE_DISTANCE(): number

• Returns number

• set STAVE_LINE_DISTANCE(value): void

• Parameters

  • value: number

  Returns void

Static STAVE_LINE_THICKNESS

• get STAVE_LINE_THICKNESS(): number

• Returns number

• set STAVE_LINE_THICKNESS(value): void

• Parameters

  • value: number

  Returns void

Static STEM_HEIGHT

• get STEM_HEIGHT(): number

• Returns number

• set STEM_HEIGHT(value): void

• Parameters

  • value: number

  Returns void

Static STEM_WIDTH

• get STEM_WIDTH(): number

• Returns number

• set STEM_WIDTH(value): void

• Parameters

  • value: number

  Returns void

Static TABLATURE_FONT_SCALE

• get TABLATURE_FONT_SCALE(): number

• Returns number

• set TABLATURE_FONT_SCALE(value): void

• Parameters

  • value: number

  Returns void

Static TIME4_4

• get TIME4_4(): {
      beat_value: number;
      num_beats: number;
      resolution: number;
  }

• Returns {
      beat_value: number;
      num_beats: number;
      resolution: number;
  }

  • beat_value: number

  • num_beats: number

  • resolution: number

Static accidentalMap

• get accidentalMap(): Record<string, {
      code: string;
      parenRightPaddingAdjustment: number;
  }>

• Returns Record<string, {
      code: string;
      parenRightPaddingAdjustment: number;
  }>

Static unicode

• get unicode(): Record<string, string>

• Returns Record<string, string>

Static clefProperties

• clefProperties(clef): {
      line_shift: number;
  }

• Parameters

  • clef: string

  Returns {
      line_shift: number;
  }

  • line_shift: number

Static durationToTicks

• durationToTicks(duration): number

• Parameters

  • duration: string

  Returns number

Static fetchMusicFont

• fetchMusicFont(fontName, fontModuleOrPath?): Promise<void>

• Used with vexflow-core which supports dynamic font loading.

  Parameters

  • fontName: string

  • Optional fontModuleOrPath: string | FontModule

  Returns Promise<void>

Static getKeySignatures

• getKeySignatures(): Record<string, {
      acc?: string;
      num: number;
  }>

• Returns Record<string, {
      acc?: string;
      num: number;
  }>

Static getMusicFont

• getMusicFont(): string[]

• Returns string[]

Static getMusicFontStack

• getMusicFontStack(): Font[]

• Returns Font[]

Static hasKeySignature

• hasKeySignature(spec): boolean

• Parameters

  • spec: string

  Returns boolean

Static keyProperties

• keyProperties(key, clef?, params?): any

• Parameters

  • key: string

  • Optional clef: string

  • Optional params: any

  Returns any

Static keySignature

• keySignature(spec): {
      line: number;
      type: string;
  }[]

• Parameters

  • spec: string

  Returns {
      line: number;
      type: string;
  }[]

Static setMusicFont

• setMusicFont(...fontNames): Font[]

• Examples:

  Vex.Flow.setMusicFont('Petaluma');
  Vex.Flow.setMusicFont('Bravura', 'Gonville');
  Copy

  CASE 1: You are using vexflow.js, which includes all music fonts (Bravura, Gonville, Petaluma, Custom). In this case, calling this method is optional, since VexFlow already defaults to a music font stack of: 'Bravura', 'Gonville', 'Custom'.

  CASE 2: You are using vexflow-bravura.js or vexflow-petaluma.js or vexflow-gonville.js, which includes a single music font. Calling this method is unnecessary.

  CASE 3: You are using the light weight vexflow-core.js to take advantage of lazy loading for fonts. In this case, the default music font stack is empty. Example:

  await Vex.Flow.fetchMusicFont('Petaluma');
  Vex.Flow.setMusicFont('Petaluma');
  ... (do VexFlow stuff) ...
  Copy

  See demos/fonts/ for more examples.

  Parameters

  • Rest ...fontNames: string[]

  Returns Font[]

  an array of Font objects corresponding to the provided fontNames.