Class DocumentBuilder

Constructors

constructor

new DocumentBuilder(): DocumentBuilder
Returns DocumentBuilder

Methods

addAnnotation

addAnnotation(text: AnnotationsType): DocumentBuilder
Parameters
- text: AnnotationsType
Returns DocumentBuilder
addAnnotation(
annotation: "dynamics" | "tempo" | Annotation,
text: string,
): DocumentBuilder
Parameters
- annotation: "dynamics" | "tempo" | Annotation
- text: string
Returns DocumentBuilder

addAnnotationTo

addAnnotationTo(
staffTabOrGroups: StaffTabOrGroups,
text: AnnotationsType,
): DocumentBuilder
Parameters
- staffTabOrGroups: StaffTabOrGroups
  staff/tab index (0=top), staff/tab name, or staff group name.
- text: AnnotationsType
Returns DocumentBuilder
addAnnotationTo(
    staffTabOrGroups: StaffTabOrGroups,
    annotation: "dynamics" | "tempo" | Annotation,
    text: string,
): DocumentBuilder
Parameters
- staffTabOrGroups: StaffTabOrGroups
  staff/tab index (0=top), staff/tab name, or staff group name.
- annotation: "dynamics" | "tempo" | Annotation
- text: string
Returns DocumentBuilder

addChord

addChord(
    voiceId: number,
    notes: (string | Note)[],
    noteLength:
        | "1n"
        | "1t"
        | "1."
        | "1.."
        | "1..."
        | "1...."
        | "1....."
        | "1......"
        | "2n"
        | "2t"
        | "2."
        | "2.."
        | "2..."
        | "2...."
        | "2....."
        | "4n"
        | "4t"
        | "4."
        | "4.."
        | "4..."
        | "4...."
        | "8n"
        | "8t"
        | "8."
        | "8.."
        | "8..."
        | "16n"
        | "16t"
        | "16."
        | "16.."
        | "32n"
        | "32t"
        | "32."
        | "64n"
        | "64t"
        | NoteLength,
    options?: NoteOptions,
): DocumentBuilder
Parameters
- voiceId: number
- notes: (string | Note)[]
- noteLength:
      | "1n"
      | "1t"
      | "1."
      | "1.."
      | "1..."
      | "1...."
      | "1....."
      | "1......"
      | "2n"
      | "2t"
      | "2."
      | "2.."
      | "2..."
      | "2...."
      | "2....."
      | "4n"
      | "4t"
      | "4."
      | "4.."
      | "4..."
      | "4...."
      | "8n"
      | "8t"
      | "8."
      | "8.."
      | "8..."
      | "16n"
      | "16t"
      | "16."
      | "16.."
      | "32n"
      | "32t"
      | "32."
      | "64n"
      | "64t"
      | NoteLength
- Optionaloptions: NoteOptions
Returns DocumentBuilder

addConnective

addConnective(
    connective: "tie" | Tie,
    tieSpan?: number | "stub" | "toMeasureEnd" | TieType,
    notAnchor?: "auto" | "above" | "center" | "below" | "stemTip" | NoteAnchor,
): DocumentBuilder
Parameters
- connective: "tie" | Tie
- OptionaltieSpan: number | "stub" | "toMeasureEnd" | TieType
- OptionalnotAnchor: "auto" | "above" | "center" | "below" | "stemTip" | NoteAnchor
Returns DocumentBuilder
addConnective(
    connective: "slur" | Slur,
    slurSpan?: number,
    notAnchor?: "auto" | "above" | "center" | "below" | "stemTip" | NoteAnchor,
): DocumentBuilder
Parameters
- connective: "slur" | Slur
- OptionalslurSpan: number
- OptionalnotAnchor: "auto" | "above" | "center" | "below" | "stemTip" | NoteAnchor
Returns DocumentBuilder
addConnective(
connective: "slide" | Slide,
notAnchor?: "auto" | "above" | "center" | "below" | "stemTip" | NoteAnchor,
): DocumentBuilder
Parameters
- connective: "slide" | Slide
- OptionalnotAnchor: "auto" | "above" | "center" | "below" | "stemTip" | NoteAnchor
Returns DocumentBuilder

addExtension

addExtension(
extensionBuilder?: (ext: ExtensionBuilder) => void,
): DocumentBuilder

Extension length example:

    addExtension(ext => ext.notes("1n", 2))          // length is 2 whole notes
    addExtension(ext => ext.measures(3).hide())      // length is 3 measures, hidden
    addExtension(ext => ext.measures(1).notes("8n")) // length is 1 measure + 1 eigth note
    addExtension(ext => ext.infinity())              // length is as long as possible

Parameters

OptionalextensionBuilder: (ext: ExtensionBuilder) => void

Returns DocumentBuilder

addFermata

addFermata(fermata?: "atNote" | "atMeasureEnd" | Fermata): DocumentBuilder
Parameters
- fermata: "atNote" | "atMeasureEnd" | Fermata = Fermata.AtNote
Returns DocumentBuilder

addFermataTo

addFermataTo(
staffTabOrGroups: StaffTabOrGroups,
fermata?: "atNote" | "atMeasureEnd" | Fermata,
): DocumentBuilder
Parameters
- staffTabOrGroups: StaffTabOrGroups
  staff/tab index (0=top), staff/tab name, or staff group name.
- fermata: "atNote" | "atMeasureEnd" | Fermata = Fermata.AtNote
Returns DocumentBuilder

addLabel

addLabel(label: "note" | "chord" | Label, text: string): DocumentBuilder
Parameters
- label: "note" | "chord" | Label
- text: string
Returns DocumentBuilder

addLabelTo

addLabelTo(
    staffTabOrGroups: StaffTabOrGroups,
    label: "note" | "chord" | Label,
    text: string,
): DocumentBuilder
Parameters
- staffTabOrGroups: StaffTabOrGroups
  staff/tab index (0=top), staff/tab name, or staff group name.
- label: "note" | "chord" | Label
- text: string
Returns DocumentBuilder

addMeasure

addMeasure(): DocumentBuilder
Returns DocumentBuilder

addNavigation

addNavigation(
    navigation:
        | "D.C. al Fine"
        | "D.C. al Coda"
        | "D.S. al Fine"
        | "D.S. al Coda"
        | "Coda"
        | "toCoda"
        | "Segno"
        | "Fine"
        | "startRepeat"
        | "endRepeat"
        | "ending"
        | Navigation,
): DocumentBuilder
Parameters
- navigation:
      | "D.C. al Fine"
      | "D.C. al Coda"
      | "D.S. al Fine"
      | "D.S. al Coda"
      | "Coda"
      | "toCoda"
      | "Segno"
      | "Fine"
      | "startRepeat"
      | "endRepeat"
      | "ending"
      | Navigation
Returns DocumentBuilder
addNavigation(
navigation: "endRepeat" | EndRepeat,
playCount: number,
): DocumentBuilder
Parameters
- navigation: "endRepeat" | EndRepeat
- playCount: number
Returns DocumentBuilder
addNavigation(
navigation: "ending" | Ending,
...passages: number[],
): DocumentBuilder
Parameters
- navigation: "ending" | Ending
- ...passages: number[]
Returns DocumentBuilder

addNavigationTo

addNavigationTo(
    staffTabOrGroups: StaffTabOrGroups,
    navigation:
        | "D.C. al Fine"
        | "D.C. al Coda"
        | "D.S. al Fine"
        | "D.S. al Coda"
        | "Coda"
        | "toCoda"
        | "Segno"
        | "Fine"
        | "startRepeat"
        | "endRepeat"
        | "ending"
        | Navigation,
): DocumentBuilder
Parameters
- staffTabOrGroups: StaffTabOrGroups
  staff/tab index (0=top), staff/tab name, or staff group name.
- navigation:
      | "D.C. al Fine"
      | "D.C. al Coda"
      | "D.S. al Fine"
      | "D.S. al Coda"
      | "Coda"
      | "toCoda"
      | "Segno"
      | "Fine"
      | "startRepeat"
      | "endRepeat"
      | "ending"
      | Navigation
Returns DocumentBuilder
addNavigationTo(
    staffTabOrGroups: StaffTabOrGroups,
    navigation: "endRepeat" | EndRepeat,
    playCount: number,
): DocumentBuilder
Parameters
- staffTabOrGroups: StaffTabOrGroups
  staff/tab index (0=top), staff/tab name, or staff group name.
- navigation: "endRepeat" | EndRepeat
- playCount: number
Returns DocumentBuilder
addNavigationTo(
    staffTabOrGroups: StaffTabOrGroups,
    navigation: "ending" | Ending,
    ...passages: number[],
): DocumentBuilder
Parameters
- staffTabOrGroups: StaffTabOrGroups
  staff/tab index (0=top), staff/tab name, or staff group name.
- navigation: "ending" | Ending
- ...passages: number[]
Returns DocumentBuilder

addNote

addNote(
    voiceId: number,
    note: string | Note,
    noteLength:
        | "1n"
        | "1t"
        | "1."
        | "1.."
        | "1..."
        | "1...."
        | "1....."
        | "1......"
        | "2n"
        | "2t"
        | "2."
        | "2.."
        | "2..."
        | "2...."
        | "2....."
        | "4n"
        | "4t"
        | "4."
        | "4.."
        | "4..."
        | "4...."
        | "8n"
        | "8t"
        | "8."
        | "8.."
        | "8..."
        | "16n"
        | "16t"
        | "16."
        | "16.."
        | "32n"
        | "32t"
        | "32."
        | "64n"
        | "64t"
        | NoteLength,
    options?: NoteOptions,
): DocumentBuilder
Parameters
- voiceId: number
- note: string | Note
- noteLength:
      | "1n"
      | "1t"
      | "1."
      | "1.."
      | "1..."
      | "1...."
      | "1....."
      | "1......"
      | "2n"
      | "2t"
      | "2."
      | "2.."
      | "2..."
      | "2...."
      | "2....."
      | "4n"
      | "4t"
      | "4."
      | "4.."
      | "4..."
      | "4...."
      | "8n"
      | "8t"
      | "8."
      | "8.."
      | "8..."
      | "16n"
      | "16t"
      | "16."
      | "16.."
      | "32n"
      | "32t"
      | "32."
      | "64n"
      | "64t"
      | NoteLength
- Optionaloptions: NoteOptions
Returns DocumentBuilder

addRest

addRest(
    voiceId: number,
    restLength:
        | "1n"
        | "1t"
        | "1."
        | "1.."
        | "1..."
        | "1...."
        | "1....."
        | "1......"
        | "2n"
        | "2t"
        | "2."
        | "2.."
        | "2..."
        | "2...."
        | "2....."
        | "4n"
        | "4t"
        | "4."
        | "4.."
        | "4..."
        | "4...."
        | "8n"
        | "8t"
        | "8."
        | "8.."
        | "8..."
        | "16n"
        | "16t"
        | "16."
        | "16.."
        | "32n"
        | "32t"
        | "32."
        | "64n"
        | "64t"
        | NoteLength,
    options?: RestOptions,
): DocumentBuilder
Parameters
- voiceId: number
- restLength:
      | "1n"
      | "1t"
      | "1."
      | "1.."
      | "1..."
      | "1...."
      | "1....."
      | "1......"
      | "2n"
      | "2t"
      | "2."
      | "2.."
      | "2..."
      | "2...."
      | "2....."
      | "4n"
      | "4t"
      | "4."
      | "4.."
      | "4..."
      | "4...."
      | "8n"
      | "8t"
      | "8."
      | "8.."
      | "8..."
      | "16n"
      | "16t"
      | "16."
      | "16.."
      | "32n"
      | "32t"
      | "32."
      | "64n"
      | "64t"
      | NoteLength
- Optionaloptions: RestOptions
Returns DocumentBuilder

addScaleArpeggio

addScaleArpeggio(
    scale: Scale,
    bottomNote: string,
    numOctaves: number,
): DocumentBuilder
Parameters
- scale: Scale
- bottomNote: string
- numOctaves: number
Returns DocumentBuilder

addStaffGroup

addStaffGroup(
    groupName: string,
    staffsTabsAndGroups: string | number | (string | number)[],
    verticalPosition?: "auto" | "above" | "below" | "both" | VerticalPosition,
): DocumentBuilder
Parameters
- groupName: string
  Name of staff group.
- staffsTabsAndGroups: string | number | (string | number)[]
  staff/tab index (0=top), staff/tab name, or staff group name. Single value or array.
- verticalPosition: "auto" | "above" | "below" | "both" | VerticalPosition = VerticalPosition.Auto
  Vertical position, are elements added above, below or both.
Returns DocumentBuilder

addTuplet

addTuplet(
    voiceId: VoiceId,
    tupletRatio: TupletRatio & TupletOptions,
    tupletBuilder: (notes: TupletBuilder) => void,
): DocumentBuilder
Usage:
```
addTuplet(0, Theory.Tuplet.Triplet, notes => {
    notes.addNote("G3", Theory.NoteLength.Eighth);
    notes.addNote("B3", Theory.NoteLength.Eighth);
    notes.addNote("D4", Theory.NoteLength.Eighth);
});
```
Parameters
- voiceId: VoiceId
- tupletRatio: TupletRatio & TupletOptions
  You can also use Theory.Tuplet presets (e.g. Theory.Tuplet.Triplet).
- tupletBuilder: (notes: TupletBuilder) => void
Returns DocumentBuilder

completeRests

completeRests(voiceId?: VoiceId | VoiceId[]): DocumentBuilder
Parameters
- OptionalvoiceId: VoiceId | VoiceId[]
Returns DocumentBuilder

getDocument

getDocument(): MDocument
Returns MDocument

setHeader

setHeader(title?: string, composer?: string, arranger?: string): DocumentBuilder
Parameters
- Optionaltitle: string
- Optionalcomposer: string
- Optionalarranger: string
Returns DocumentBuilder

setKeySignature

setKeySignature(
    tonic: string,
    scaleType:
        | ScaleType
        | "Major"
        | "Natural Minor"
        | "Harmonic Minor"
        | "Ionian"
        | "Dorian"
        | "Phrygian"
        | "Lydian"
        | "Mixolydian"
        | "Aeolian"
        | "Locrian"
        | "Major Pentatonic"
        | "Minor Pentatonic"
        | "Major Hexatonic Blues"
        | "Minor Hexatonic Blues"
        | "Heptatonic Blues",
): DocumentBuilder
Parameters
- tonic: string
- scaleType:
      | ScaleType
      | "Major"
      | "Natural Minor"
      | "Harmonic Minor"
      | "Ionian"
      | "Dorian"
      | "Phrygian"
      | "Lydian"
      | "Mixolydian"
      | "Aeolian"
      | "Locrian"
      | "Major Pentatonic"
      | "Minor Pentatonic"
      | "Major Hexatonic Blues"
      | "Minor Hexatonic Blues"
      | "Heptatonic Blues"
Returns DocumentBuilder
setKeySignature(keySignature: KeySignature): DocumentBuilder
Parameters
- keySignature: KeySignature
Returns DocumentBuilder
setKeySignature(keySignature: string): DocumentBuilder
Parameters
- keySignature: string
Returns DocumentBuilder
setKeySignature(scale: Scale): DocumentBuilder
Parameters
- scale: Scale
Returns DocumentBuilder

setMeasuresPerRow

setMeasuresPerRow(measuresPerRow: number): DocumentBuilder
Parameters
- measuresPerRow: number
Returns DocumentBuilder

setScoreConfiguration

setScoreConfiguration(
    staffPreset:
        | "treble"
        | "bass"
        | "grand"
        | "guitarTreble"
        | "guitarTab"
        | "guitarCombined"
        | StaffPreset,
): DocumentBuilder
Parameters
- staffPreset:
      | "treble"
      | "bass"
      | "grand"
      | "guitarTreble"
      | "guitarTab"
      | "guitarCombined"
      | StaffPreset
Returns DocumentBuilder
setScoreConfiguration(config: ScoreConfiguration): DocumentBuilder
Parameters
- config: ScoreConfiguration
Returns DocumentBuilder

setTempo

setTempo(beatsPerMinute: number): DocumentBuilder
Parameters
- beatsPerMinute: number
Returns DocumentBuilder
setTempo(
    beatsPerMinute: number,
    beatLength:
        | "1n"
        | "1t"
        | "1."
        | "1.."
        | "1..."
        | "1...."
        | "1....."
        | "1......"
        | "2n"
        | "2t"
        | "2."
        | "2.."
        | "2..."
        | "2...."
        | "2....."
        | "4n"
        | "4t"
        | "4."
        | "4.."
        | "4..."
        | "4...."
        | "8n"
        | "8t"
        | "8."
        | "8.."
        | "8..."
        | "16n"
        | "16t"
        | "16."
        | "16.."
        | "32n"
        | "32t"
        | "32."
        | "64n"
        | "64t"
        | NoteLength,
): DocumentBuilder
Parameters
- beatsPerMinute: number
- beatLength:
      | "1n"
      | "1t"
      | "1."
      | "1.."
      | "1..."
      | "1...."
      | "1....."
      | "1......"
      | "2n"
      | "2t"
      | "2."
      | "2.."
      | "2..."
      | "2...."
      | "2....."
      | "4n"
      | "4t"
      | "4."
      | "4.."
      | "4..."
      | "4...."
      | "8n"
      | "8t"
      | "8."
      | "8.."
      | "8..."
      | "16n"
      | "16t"
      | "16."
      | "16.."
      | "32n"
      | "32t"
      | "32."
      | "64n"
      | "64t"
      | NoteLength
Returns DocumentBuilder
setTempo(
    beatsPerMinute: number,
    beatLength:
        | "1n"
        | "1t"
        | "1."
        | "1.."
        | "1..."
        | "1...."
        | "1....."
        | "1......"
        | "2n"
        | "2t"
        | "2."
        | "2.."
        | "2..."
        | "2...."
        | "2....."
        | "4n"
        | "4t"
        | "4."
        | "4.."
        | "4..."
        | "4...."
        | "8n"
        | "8t"
        | "8."
        | "8.."
        | "8..."
        | "16n"
        | "16t"
        | "16."
        | "16.."
        | "32n"
        | "32t"
        | "32."
        | "64n"
        | "64t"
        | NoteLength,
    dotted: number | boolean,
): DocumentBuilder
Parameters
- beatsPerMinute: number
- beatLength:
      | "1n"
      | "1t"
      | "1."
      | "1.."
      | "1..."
      | "1...."
      | "1....."
      | "1......"
      | "2n"
      | "2t"
      | "2."
      | "2.."
      | "2..."
      | "2...."
      | "2....."
      | "4n"
      | "4t"
      | "4."
      | "4.."
      | "4..."
      | "4...."
      | "8n"
      | "8t"
      | "8."
      | "8.."
      | "8..."
      | "16n"
      | "16t"
      | "16."
      | "16.."
      | "32n"
      | "32t"
      | "32."
      | "64n"
      | "64t"
      | NoteLength
- dotted: number | boolean
Returns DocumentBuilder
Deprecated
- Use dotted beatLength instead (e.g. "4..")

setTimeSignature

setTimeSignature(
timeSignature: TimeSignatureString | TimeSignature,
): DocumentBuilder
Parameters
- timeSignature: TimeSignatureString | TimeSignature
Returns DocumentBuilder

Class DocumentBuilder

Index

Constructors

Methods

Constructors

constructor

Returns DocumentBuilder

Methods

addAnnotation

Parameters

Returns DocumentBuilder

Parameters

Returns DocumentBuilder

addAnnotationTo

Parameters

Returns DocumentBuilder

Parameters

Returns DocumentBuilder

addChord

Parameters

Returns DocumentBuilder

addConnective

Parameters

Returns DocumentBuilder

Parameters

Returns DocumentBuilder

Parameters

Returns DocumentBuilder

addExtension

Parameters

Returns DocumentBuilder

addFermata

Parameters

Returns DocumentBuilder

addFermataTo

Parameters

Returns DocumentBuilder

addLabel

Parameters

Returns DocumentBuilder

addLabelTo

Parameters

Returns DocumentBuilder

addMeasure

Returns DocumentBuilder

addNavigation

Parameters

Returns DocumentBuilder

Parameters

Returns DocumentBuilder

Parameters

Returns DocumentBuilder

addNavigationTo

Parameters

Returns DocumentBuilder

Parameters

Returns DocumentBuilder

Parameters

Returns DocumentBuilder

addNote

Parameters

Returns DocumentBuilder

addRest

Parameters

Returns DocumentBuilder

addScaleArpeggio

Parameters

Returns DocumentBuilder

addStaffGroup

Parameters

Returns DocumentBuilder

addTuplet

Parameters

Returns DocumentBuilder

completeRests

Parameters

Returns DocumentBuilder

endRow

Returns DocumentBuilder

endSection