Skip to main content

Add Annotation

Planned for 6.4.x​

ℹ️ Available currently in 6.4.0-pre-release.

Planned changes for 6.4.x are:

  • Make addAnnotation() more future compatible by adding annotation options (last argument).
  • More extensive list of known annotation kinds.
💡
See API Reference for Score.AnnotationGroup for list of annotation groups.
💡
See API Reference for Score.AnnotationKind for list of annotation kinds.
// Add annotation
builder.addAnnotation("fff");

// Some common anotations are:
// Dynamics: "ppp", "pp", "p", "mp", "mf", "f", "ff", "fff", "cresc.", "decresc.", "dim."
// Tempo: "accel.", "rit.", "a tempo"

// Add any annotation text to a given annotation group
builder.addAnnotation("accel.", { group "tempo" });

// Add fermata
builder.addAnnotation("fermata");
// Add fermata to right bar line
builder.addAnnotation("fermata", { anchor: "rightBarLine" });

// Add label examples
builder.addAnnotation("pitchLabel", "C4");
builder.addAnnotation("chordLabel", "Am");

// Add articulation examples
builder.addAnnotation("staccato");
builder.addAnnotation("accent");

// Add navigation examples
builder.addAnnotation("D.C. al Fine");
builder.addAnnotation("D.C. al Coda");
builder.addAnnotation("D.S. al Fine");
builder.addAnnotation("D.S. al Coda");
builder.addAnnotation("Coda");
builder.addAnnotation("toCoda");
builder.addAnnotation("Segno");
builder.addAnnotation("Fine");
builder.addAnnotation("startRepeat");
builder.addAnnotation("endRepeat", { repeatCount: 2 });
builder.addAnnotation("ending", { endingPassages: [1, 2]});

6.3.x and Earlier​

💡
List of known annotation kinds is minimal.
// These are the supported annotations in "dynamics" group
builder.addAnnotation("fff");
builder.addAnnotation("ff");
builder.addAnnotation("f");
builder.addAnnotation("mf");
builder.addAnnotation("m");
builder.addAnnotation("mp");
builder.addAnnotation("p");
builder.addAnnotation("pp");
builder.addAnnotation("ppp");
builder.addAnnotation("cresc.");
builder.addAnnotation("decresc.");
builder.addAnnotation("dim.");

// These are the supported annotations in "tempo" group
builder.addAnnotation("accel.");
builder.addAnnotation("rit.");
builder.addAnnotation("a tempo");

// With the group (first argument) you can add any annotation text.
builder.addAnnotation("dynamics", "Loud!");
builder.addAnnotation("tempo", "Fast!");

See also Add Fermata and Add Label.

Live Example​