Create new document builder instance.
Add annotation text to column of last added note/chord/rest in current measure.
Known annotation text (e.g. "pp").
Add annotation text to column of last added note/chord/rest in current measure.
Annotation type (e.g. "tempo" or Annotation.Tempo).
Annotation text (unrestricted).
Add annotation text to column of last added note/chord/rest in current measure to given staff/tab/group.
staff/tab index (0=top), staff/tab name, or staff group name.
Known annotation text (e.g. "pp").
Add annotation text to column of last added note/chord/rest in current measure to given staff/tab/group.
staff/tab index (0=top), staff/tab name, or staff group name.
Annotation type (e.g. "tempo" or Annotation.Tempo).
Annotation text (unrestricted).
Voice id to add chord to.
Array of notes, each instance of Note or string (e.g. "D4").
Note length (e.g. "4n").
Optionaloptions: NoteOptionsNote options.
Add tie starting from last added note/chord.
Connective type ("tie" or Connective.Tie).
OptionaltieSpan: number | "stub" | "toMeasureEnd" | TieTypeHow many notes across this tie spans.
OptionalnotAnchor: "auto" | "above" | "center" | "below" | "stemTip" | NoteAnchorAnchor point for note and this tie.
Add slur starting from last added note/chord.
Connective type ("slur" or Connective.Slur).
OptionalslurSpan: numberHow many notes across this slur spans.
OptionalnotAnchor: "auto" | "above" | "center" | "below" | "stemTip" | NoteAnchorAnchor point for note and this slur.
Add slide starting from last added note/chord.
Connective type ("slide" or Connective.Slide).
OptionalnotAnchor: "auto" | "above" | "center" | "below" | "stemTip" | NoteAnchorAnchor point for note and this slide.
Add extension line to previously added annotation or label element.
// 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
OptionalextensionBuilder: (ext: ExtensionBuilder) => voidExtension builder function used to build exstension.
Add fermata to current measure.
Fermata type (e.g. "atNote" or Fermata.AtrNote).
Add Fermata to current measure to given staff/tab/group.
staff/tab index (0=top), staff/tab name, or staff group name.
Fermata type (e.g. "atNote" or Fermata.AtrNote).
Add label text to column of last added note/chord/rest in current measure.
Label type (e.g. "chord" or Label.Chord).
label text (e.g. "Am").
Add label text to column of last added note/chord/rest in current measure to given staff/tab/group.
staff/tab index (0=top), staff/tab name, or staff group name.
Label type (e.g. "chord" or Label.Chord).
label text (e.g. "Am").
Add navigation element to current measure.
Navigation element (e.g. "D.S. al Fine" or Navigation.DS_al_Fine).
Add end repeat navigation element to current measure.
End repeat navigation element ("endRepeat" or Navigation.EndRepeat).
Number of times to play the ended repeat section.
Add ending navigation element to current measure.
Ending navigation element ("ending" or Navigation.Ending).
Passage numbers for measure marked by this ending is played.
Add navigation element to current measure to given staff/tab/group.
staff/tab index (0=top), staff/tab name, or staff group name.
Add end repeat navigation element to current measure to given staff/tab/group.
staff/tab index (0=top), staff/tab name, or staff group name.
Add ending navigation element to current measure to given staff/tab/group.
staff/tab index (0=top), staff/tab name, or staff group name.
Add note o current measure.
Voice id to add note to.
Note instance of Note or string (e.g. "D4").
Note length (e.g. "4n").
Optionaloptions: NoteOptionsNote options.
Voice id to add rest to.
Rest length (e.g. "4n").
Optionaloptions: RestOptionsRest options.
Add notes of given scale in ascending order.
Scale.
Scale starts from note >= bottom note.
Number of octaves to add.
Add staff group.
Name of staff group.
staff/tab index (0=top), staff/tab name, or staff group name. Single value or array.
Vertical position, are elements added above, below or both.
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);
});
Voice id to add tuplet to.
You can also use Theory.Tuplet presets (e.g. Theory.Tuplet.Triplet).
Tuplet builder function to build tuplet.
Add rests to fill current measure.
End current score row. Next measure will start new row.
Add section end. Adds certain bar line at the end of measure.
Add song end. Adds certain bar line at the end of measure.
Set header texts.
Optionaltitle: stringTitle of this docmument/musical piece.
Optionalcomposer: stringComposer of this document/musical piece.
Optionalarranger: stringArranger of this document/musical piece.
Set key signature for current measure and forward.
Tonic note (e.g. "C").
Scale type (e.g. string "Major" or ScaleType.Major).
Set key signature for current measure and forward.
KeySignature object instance.
Set key signature for current measure and forward.
Key signature string (e.g. "C Major").
Set key signature for current measure and forward.
Scale object instance.
Automatically limit number of measures per score row.
Number of measures per row. Must be integer >=1 or Infinity.
Use staff preset values to set score confguration. This call will request new score row.
Staff preset (e.g. "treble").
Use staff preset values to set score confguration. This call will request new score row.
Score configuration (e.g. { type: "staff", clef: "G", isOctavewDown: true }).
Set tempo.
Tempo beats per minute.
Set tempo.
Tempo beats per minute.
Length of one beat.
Tempo beats per minute.
Length of one beat.
Dot count of length of one beat.
Set time signature for current measure and forward.
TimeSignature object instance.
Set time signature for current measure and forward.
TimeSignatures enum value or string (e.g. "3/4").
OptionalbeamGrouping: "2-3" | "3-2" | "2-2-3" | "3-2-2" | BeamGroupingBeam grouping (e.g. "3-2" for time signature "5/8").
Set time signature for current measure and forward.
Beat count of time signature (e.g. 3 in "3/4").
Beat size of time signature (e.g. 4 in "3/4").
OptionalbeamGrouping: "2-3" | "3-2" | "2-2-3" | "3-2-2" | BeamGroupingBeam grouping (e.g. "3-2" for time signature "5/8").
Document builder class.
// Example let doc = new Score.DocumentBuilder() .addScoreConfiguration({ type: "staff", clef: "G", isOctavewDown: true }) .setMeasuresPerRow(4) .addMeasure() .addNote(1, "C3", "4n") .addChord(1, ["C3", "E3", "G3"], "4n").addLabel("chord", "C") .addRest(1, "4n") // etc. .getDEocument();