Class EasyScore

constructor

• new EasyScore(options?): EasyScore

• Parameters

  • options: EasyScoreOptions = {}

  Returns EasyScore

builder

defaults

factory

grammar

options

parser

Static DEBUG

addCommitHook

• addCommitHook(commitHook): void

• Parameters

  • commitHook: CommitHook

  Returns void

beam

• beam(notes, options?): StemmableNote[]

• Parameters

  • notes: StemmableNote[]

  • Optional options: {
        autoStem?: boolean;
        partialBeamDirections?: {
            [noteIndex: number]: PartialBeamDirection;
        };
        secondaryBeamBreaks?: number[];
    }

    • Optional autoStem?: boolean

    • Optional partialBeamDirections?: {
          [noteIndex: number]: PartialBeamDirection;
      }

      • [noteIndex: number]: PartialBeamDirection

    • Optional secondaryBeamBreaks?: number[]

  Returns StemmableNote[]

notes

• notes(line, options?): StemmableNote[]

• Parameters

  • line: string

  • options: BuilderOptions = {}

  Returns StemmableNote[]

parse

• parse(line, options?): Result

• Parameters

  • line: string

  • options: BuilderOptions = {}

  Returns Result

set

• set(defaults): EasyScore

• Set the score defaults. clef must be set appropriately to avoid errors when adding Staves.

  Parameters

  • defaults: EasyScoreDefaults

  Returns EasyScore

  this

setContext

• setContext(context): EasyScore

• Parameters

  • context: RenderContext

  Returns EasyScore

setOptions

• setOptions(options): EasyScore

• Parameters

  • options: EasyScoreOptions

  Returns EasyScore

  this

tuplet

• tuplet(notes, options?): StemmableNote[]

• Parameters

  • notes: StemmableNote[]

  • Optional options: TupletOptions

  Returns StemmableNote[]

voice

• voice(notes, options?): Voice

• Parameters

  • notes: Note[]

  • options: {
        options?: {
            softmaxFactor: number;
        };
        time?: string;
    } = {}

    • Optional options?: {
          softmaxFactor: number;
      }

      • softmaxFactor: number

    • Optional time?: string

  Returns Voice