Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Accidentals category string.
Modifiers can be positioned almost anywhere, relative to a note.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the context.
+Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Render accidental onto canvas.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get note index, which is a specific note in a chord.
@@ -104,11 +114,13 @@If called, draws parenthesis around accidental.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Annotation.html b/docs/api/classes/Annotation.html
index a2229017da..d81e6832e3 100644
--- a/docs/api/classes/Annotation.html
+++ b/docs/api/classes/Annotation.html
@@ -14,9 +14,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Annotations category string.
Modifiers can be positioned almost anywhere, relative to a note.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the context.
+Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Render text beside the note.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get note index, which is a specific note in a chord.
@@ -102,11 +112,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Articulation.html b/docs/api/classes/Articulation.html
index 3ab8bdb2d4..b7e8225b11 100644
--- a/docs/api/classes/Articulation.html
+++ b/docs/api/classes/Articulation.html
@@ -20,9 +20,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Articulations category string.
Modifiers can be positioned almost anywhere, relative to a note.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the context.
+Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Render articulation in position next to note.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get note index, which is a specific note in a chord.
@@ -106,13 +116,15 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set if articulation should be rendered between lines.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/BarNote.html b/docs/api/classes/BarNote.html
index a0a09e0c6b..5caccb8534 100644
--- a/docs/api/classes/BarNote.html
+++ b/docs/api/classes/BarNote.html
@@ -12,9 +12,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Set preformatted status.
Set preformatted status.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Attach a modifier to this note.
@@ -64,7 +71,7 @@Check and get the beam.
Validate and return the context.
+Validate and return the rendering context.
Check and get ModifierContext.
Render note to stave.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Get the absolute X position of this note's tick context. This
excludes x_shift, so you'll need to factor it in if you're
looking for the post-formatted x-position.
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Return the center x shift.
Return the context.
+Return the context, such as an SVGContext or CanvasContext object.
Accessor to duration.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return the formatterMetrics.
@@ -149,7 +159,7 @@Get the tuplet.
Return the intrinsic ticks.
+Return a list of Tuplets.
Get the type of bar note.
Reset the text font to the style indicated by the static TEXT_FONT property.
Subclasses can call this to initialize textFont for the first time.
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the center x shift.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the duration.
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Barline.html b/docs/api/classes/Barline.html
index 4f9cdcb2f7..84f61df4cf 100644
--- a/docs/api/classes/Barline.html
+++ b/docs/api/classes/Barline.html
@@ -2,9 +2,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
a CSS font-weight string (e.g., 'bold'). As in CSS, font-weight is always returned as a string, even if it was set as a number.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Validate and return the context.
+Validate and return the rendering context.
Draw an element.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return associated SVGElement.
@@ -55,7 +65,14 @@Return the rendered status.
Runs setYShift() for the Glyph object so that it matches the position of line for
+the Stave provided. A customShift can also be given (measured in the same units
+as setYShift not in lines) and this will be added after all other positions are
+calculated from the Stave.
Note that this routine only sets the yShift; it does not actually "place" (meaning +draw) the Glyph on the Stave. Call .draw() afterwards to do that.
+Remove a class label (An element can have multiple class labels).
Reset the text font to the style indicated by the static TEXT_FONT property.
@@ -63,11 +80,13 @@
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Beam.html b/docs/api/classes/Beam.html
index 8cac44d4e3..df0934f267 100644
--- a/docs/api/classes/Beam.html
+++ b/docs/api/classes/Beam.html
@@ -4,9 +4,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
a CSS font-weight string (e.g., 'bold'). As in CSS, font-weight is always returned as a string, even if it was set as a number.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Create new stems for the notes in the beam, so that each stem @@ -40,14 +47,14 @@
Calculate the best possible slope for the provided notes.
Validate and return the context.
+Validate and return the rendering context.
Render the beam to the canvas context
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get the notes in this beam.
@@ -94,11 +104,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Bend.html b/docs/api/classes/Bend.html
index 9de9851f93..b81eca7ca4 100644
--- a/docs/api/classes/Bend.html
+++ b/docs/api/classes/Bend.html
@@ -13,9 +13,10 @@
Default text font.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Modifiers can be positioned almost anywhere, relative to a note.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the context.
+Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Draw the bend on the rendering context.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get note index, which is a specific note in a chord.
@@ -99,11 +109,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/ChordSymbol.html b/docs/api/classes/ChordSymbol.html
index 889e205696..e361c0bfb6 100644
--- a/docs/api/classes/ChordSymbol.html
+++ b/docs/api/classes/ChordSymbol.html
@@ -2,9 +2,10 @@
ChordSymbol is a modifier that creates a chord symbol above/below a chord. As a modifier, it is attached to an existing note.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Add a glyph block.
@@ -61,7 +68,7 @@Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the context.
+Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Render text and glyphs above/below the note.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get note index, which is a specific note in a chord.
@@ -118,9 +128,9 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the chord symbol's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Every clef name is associated with a glyph code from the font file and a default stave line number.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Validate and return the context.
+Validate and return the rendering context.
Render clef.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return associated SVGElement.
@@ -70,7 +80,14 @@Return the rendered status.
Runs setYShift() for the Glyph object so that it matches the position of line for
+the Stave provided. A customShift can also be given (measured in the same units
+as setYShift not in lines) and this will be added after all other positions are
+calculated from the Stave.
Note that this routine only sets the yShift; it does not actually "place" (meaning +draw) the Glyph on the Stave. Call .draw() afterwards to do that.
+Remove a class label (An element can have multiple class labels).
Reset the text font to the style indicated by the static TEXT_FONT property.
@@ -78,11 +95,13 @@
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/ClefNote.html b/docs/api/classes/ClefNote.html
index d3953fb75f..8d610fa00d 100644
--- a/docs/api/classes/ClefNote.html
+++ b/docs/api/classes/ClefNote.html
@@ -7,9 +7,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Set preformatted status.
Set preformatted status.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Attach a modifier to this note.
@@ -59,7 +66,7 @@Check and get the beam.
Validate and return the context.
+Validate and return the rendering context.
Check and get ModifierContext.
Render clef note.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Get the absolute X position of this note's tick context. This
excludes x_shift, so you'll need to factor it in if you're
looking for the post-formatted x-position.
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get associated clef.
Return the context.
+Return the context, such as an SVGContext or CanvasContext object.
Accessor to duration.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return the formatterMetrics.
@@ -146,7 +156,7 @@Get the tuplet.
Return the intrinsic ticks.
+Return a list of Tuplets.
Return the voice that this note belongs in.
Reset the text font to the style indicated by the static TEXT_FONT property.
Subclasses can call this to initialize textFont for the first time.
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the center x shift.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the duration.
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Crescendo.html b/docs/api/classes/Crescendo.html
index f8f6286be3..abe7e2a679 100644
--- a/docs/api/classes/Crescendo.html
+++ b/docs/api/classes/Crescendo.html
@@ -5,9 +5,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Set preformatted status.
Crescendo category string.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Attach a modifier to this note.
@@ -59,7 +66,7 @@Check and get the beam.
Validate and return the context.
+Validate and return the rendering context.
Check and get ModifierContext.
Draw an element.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Get the absolute X position of this note's tick context. This
excludes x_shift, so you'll need to factor it in if you're
looking for the post-formatted x-position.
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Return the center x shift.
Return the context.
+Return the context, such as an SVGContext or CanvasContext object.
Accessor to duration.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return the formatterMetrics.
@@ -144,7 +154,7 @@Get the tuplet.
Return the intrinsic ticks.
+Return a list of Tuplets.
Return the voice that this note belongs in.
Reset the text font to the style indicated by the static TEXT_FONT property.
Subclasses can call this to initialize textFont for the first time.
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the center x shift.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the duration.
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Curve.html b/docs/api/classes/Curve.html
index 5ecbfae169..97028b6287 100644
--- a/docs/api/classes/Curve.html
+++ b/docs/api/classes/Curve.html
@@ -2,9 +2,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
a CSS font-weight string (e.g., 'bold'). As in CSS, font-weight is always returned as a string, even if it was set as a number.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Validate and return the context.
+Validate and return the rendering context.
Draw an element.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return associated SVGElement.
@@ -64,11 +74,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Dot.html b/docs/api/classes/Dot.html
index 2bc8f96df8..f1ec5644db 100644
--- a/docs/api/classes/Dot.html
+++ b/docs/api/classes/Dot.html
@@ -2,9 +2,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Modifiers can be positioned almost anywhere, relative to a note.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the context.
+Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Render the modifier onto the canvas.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get note index, which is a specific note in a chord.
@@ -86,11 +96,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Element.html b/docs/api/classes/Element.html
index c7f56e95ed..efd8d2ff3b 100644
--- a/docs/api/classes/Element.html
+++ b/docs/api/classes/Element.html
@@ -1,13 +1,18 @@
Element implements a generic base class for VexFlow, with implementations of general functions and properties that can be inherited by all VexFlow elements.
+The Element is an abstract class that needs to be subclassed to work. It handles +style and text-font properties for the Element and any child elements, along with +working with the Registry to create unique ids, but does not have any tools for +formatting x or y positions or connections to a Stave.
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
a CSS font-weight string (e.g., 'bold'). As in CSS, font-weight is always returned as a string, even if it was set as a number.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Validate and return the context.
+Validate and return the rendering context.
Draw an element.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return associated SVGElement.
@@ -66,11 +80,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/FretHandFinger.html b/docs/api/classes/FretHandFinger.html
index 4d927b65bc..195eb0187f 100644
--- a/docs/api/classes/FretHandFinger.html
+++ b/docs/api/classes/FretHandFinger.html
@@ -2,9 +2,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Modifiers can be positioned almost anywhere, relative to a note.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the context.
+Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Render the modifier onto the canvas.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get note index, which is a specific note in a chord.
@@ -86,11 +96,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/GhostNote.html b/docs/api/classes/GhostNote.html
index 3ef56c463f..57671e2c0c 100644
--- a/docs/api/classes/GhostNote.html
+++ b/docs/api/classes/GhostNote.html
@@ -5,9 +5,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Set preformatted status.
Set preformatted status.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Attach a modifier to this note.
@@ -57,7 +64,7 @@Check and get the beam.
Validate and return the context.
+Validate and return the rendering context.
Check and get ModifierContext.
Renders the stem onto the canvas.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Get the absolute X position of this note's tick context. This
excludes x_shift, so you'll need to factor it in if you're
looking for the post-formatted x-position.
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Return the center x shift.
Return the context.
+Return the context, such as an SVGContext or CanvasContext object.
Accessor to duration.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return the formatterMetrics.
@@ -144,7 +154,7 @@Get the tuplet.
Return the intrinsic ticks.
+Return a list of Tuplets.
Return the voice that this note belongs in.
Reset the text font to the style indicated by the static TEXT_FONT property.
Subclasses can call this to initialize textFont for the first time.
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the center x shift.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the duration.
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Glyph.html b/docs/api/classes/Glyph.html
index c71acd9080..428ba30a7a 100644
--- a/docs/api/classes/Glyph.html
+++ b/docs/api/classes/Glyph.html
@@ -3,9 +3,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
a CSS font-weight string (e.g., 'bold'). As in CSS, font-weight is always returned as a string, even if it was set as a number.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Validate and return the context.
+Validate and return the rendering context.
Draw an element.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return associated SVGElement.
@@ -64,11 +74,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/GlyphNote.html b/docs/api/classes/GlyphNote.html
index a0ebd2c05d..a194654cb2 100644
--- a/docs/api/classes/GlyphNote.html
+++ b/docs/api/classes/GlyphNote.html
@@ -5,9 +5,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Set preformatted status.
Set preformatted status.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Attach a modifier to this note.
@@ -57,7 +64,7 @@Check and get the beam.
Validate and return the context.
+Validate and return the rendering context.
Check and get ModifierContext.
Draw an element.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Get the absolute X position of this note's tick context. This
excludes x_shift, so you'll need to factor it in if you're
looking for the post-formatted x-position.
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Return the center x shift.
Return the context.
+Return the context, such as an SVGContext or CanvasContext object.
Accessor to duration.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return the formatterMetrics.
@@ -142,7 +152,7 @@Get the tuplet.
Return the intrinsic ticks.
+Return a list of Tuplets.
Return the voice that this note belongs in.
Reset the text font to the style indicated by the static TEXT_FONT property.
Subclasses can call this to initialize textFont for the first time.
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the center x shift.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the duration.
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/GraceNote.html b/docs/api/classes/GraceNote.html
index d81cd0d497..450d007e36 100644
--- a/docs/api/classes/GraceNote.html
+++ b/docs/api/classes/GraceNote.html
@@ -5,9 +5,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Set preformatted status.
Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Attach a modifier to this note.
@@ -60,7 +67,7 @@Check and get the beam.
Validate and return the context.
+Validate and return the rendering context.
Check and get ModifierContext.
Renders the stem onto the canvas.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Get the absolute X position of this note's tick context. This
excludes x_shift, so you'll need to factor it in if you're
looking for the post-formatted x-position.
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Return the center x shift.
Return the context.
+Return the context, such as an SVGContext or CanvasContext object.
Accessor to duration.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return the formatterMetrics.
@@ -153,7 +163,7 @@Get the tuplet.
Return the intrinsic ticks.
+Return a list of Tuplets.
Return the voice that this note belongs in.
Reset the text font to the style indicated by the static TEXT_FONT property.
Subclasses can call this to initialize textFont for the first time.
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the center x shift.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the duration.
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/GraceNoteGroup.html b/docs/api/classes/GraceNoteGroup.html
index 2e82a7f385..2a3d139c50 100644
--- a/docs/api/classes/GraceNoteGroup.html
+++ b/docs/api/classes/GraceNoteGroup.html
@@ -4,9 +4,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Modifiers can be positioned almost anywhere, relative to a note.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the context.
+Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Render the modifier onto the canvas.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get note index, which is a specific note in a chord.
@@ -88,11 +98,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/GraceTabNote.html b/docs/api/classes/GraceTabNote.html
index 0e8de558fa..033b5c96a5 100644
--- a/docs/api/classes/GraceTabNote.html
+++ b/docs/api/classes/GraceTabNote.html
@@ -5,9 +5,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Set preformatted status.
Set preformatted status.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Attach a modifier to this note.
@@ -57,7 +64,7 @@Check and get the beam.
Validate and return the context.
+Validate and return the rendering context.
Check and get ModifierContext.
Renders the stem onto the canvas.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Get the absolute X position of this note's tick context. This
excludes x_shift, so you'll need to factor it in if you're
looking for the post-formatted x-position.
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Return the center x shift.
Return the context.
+Return the context, such as an SVGContext or CanvasContext object.
Accessor to duration.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return the formatterMetrics.
@@ -144,7 +154,7 @@Get the tuplet.
Return the intrinsic ticks.
+Return a list of Tuplets.
Return the voice that this note belongs in.
Reset the text font to the style indicated by the static TEXT_FONT property.
Subclasses can call this to initialize textFont for the first time.
Reset the specific Tuplet if this is not provided, all tuplets are reset. +
Reset the specific Tuplet (if this is not provided, all tuplets are reset). Remove any prior tuplets from the tick calculation and reset the intrinsic tick value.
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the beam.
Set the center x shift.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the duration.
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/KeySigNote.html b/docs/api/classes/KeySigNote.html
index faba5622ce..bb7d6369e7 100644
--- a/docs/api/classes/KeySigNote.html
+++ b/docs/api/classes/KeySigNote.html
@@ -5,9 +5,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
Set preformatted status.
Set preformatted status.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Attach a modifier to this note.
@@ -57,7 +64,7 @@Check and get the beam.
Validate and return the context.
+Validate and return the rendering context.
Check and get ModifierContext.
Draw an element.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Get the absolute X position of this note's tick context. This
excludes x_shift, so you'll need to factor it in if you're
looking for the post-formatted x-position.
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Return the center x shift.
Return the context.
+Return the context, such as an SVGContext or CanvasContext object.
Accessor to duration.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return the formatterMetrics.
@@ -142,7 +152,7 @@Get the tuplet.
Return the intrinsic ticks.
+Return a list of Tuplets.
Return the voice that this note belongs in.
Reset the text font to the style indicated by the static TEXT_FONT property.
Subclasses can call this to initialize textFont for the first time.
Reset the specific Tuplet if this is not provided, all tuplets are reset. +
Reset the specific Tuplet (if this is not provided, all tuplets are reset). Remove any prior tuplets from the tick calculation and reset the intrinsic tick value.
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the beam.
Set the center x shift.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the duration.
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/KeySignature.html b/docs/api/classes/KeySignature.html
index 4befad54e6..df41d8b2f3 100644
--- a/docs/api/classes/KeySignature.html
+++ b/docs/api/classes/KeySignature.html
@@ -2,9 +2,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
a CSS font-weight string (e.g., 'bold'). As in CSS, font-weight is always returned as a string, even if it was set as a number.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Validate and return the context.
+Validate and return the rendering context.
Draw an element.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Return the Glyph objects making up this KeySignature.
@@ -57,7 +67,14 @@Return the rendered status.
Call back from registry after the element is registered.
-Runs setYShift() for the Glyph object so that it matches the position of line for
+the Stave provided. A customShift can also be given (measured in the same units
+as setYShift not in lines) and this will be added after all other positions are
+calculated from the Stave.
Note that this routine only sets the yShift; it does not actually "place" (meaning +draw) the Glyph on the Stave. Call .draw() afterwards to do that.
+Remove a class label (An element can have multiple class labels).
Reset the text font to the style indicated by the static TEXT_FONT property.
@@ -65,11 +82,13 @@
Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/Modifier.html b/docs/api/classes/Modifier.html
index d87aa9d8ce..6f4e2d18dd 100644
--- a/docs/api/classes/Modifier.html
+++ b/docs/api/classes/Modifier.html
@@ -11,9 +11,10 @@
Default font for text. This is not related to music engraving. Instead, see Flow.setMusicFont(...fontNames)
to customize the font for musical symbols placed on the score.
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
+Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied +to text (not glyphs).
Return a copy of the current FontInfo object.
ModifierContext uses this to determine the type and order of the modifiers.
Modifiers can be positioned almost anywhere, relative to a note.
-Adds a child Element to the Element, which lets it inherit the +same style as the parent when setGroupStyle() is called.
+Examples of children are noteheads and stems. Modifiers such +as Accidentals are generally not set as children.
+Note that StaveNote calls setGroupStyle() when setStyle() is called.
+Add a class label (An element can have multiple class labels).
Apply the element style to context.
Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the context.
+Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Render the modifier onto the canvas.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) -with the element style.
+with the element's style (seegetStyle() and setStyle())
Return an attribute.
+Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the boundingBox.
Return the context.
-a CSS font-size string (e.g., '18pt', '12px', '1em'). +
Return the context, such as an SVGContext or CanvasContext object.
+Get the css string describing this Element's text font. e.g., +'bold 10pt Arial'.
+a CSS font-size string (e.g., '18pt', '12px', '1em'). See Element.fontSizeInPixels or Element.fontSizeInPoints if you need to get a number for calculation purposes.
Get note index, which is a specific note in a chord.
@@ -98,11 +108,13 @@Restore the style of context.
Set an attribute.
+Set an attribute such as 'id', 'class', or 'type'.
Set the context.
+Set the context to an SVGContext or CanvasContext object
Set the element's font family, size, weight, style (e.g., Arial, 10pt, bold, italic).
Set the element's text font family, size, weight, style
+(e.g., Arial, 10pt, bold, italic).
This attribute does not determine the font used for musical Glyphs like treble clefs.
is 1) a FontInfo object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
diff --git a/docs/api/classes/ModifierContext.html b/docs/api/classes/ModifierContext.html
index 5eee277f49..2c9353266a 100644
--- a/docs/api/classes/ModifierContext.html
+++ b/docs/api/classes/ModifierContext.html
@@ -2,4 +2,6 @@
this.members maps CATEGORY strings to arrays of Tickable | Modifier | StaveNote | TabNote. Here we add a new member to this.members, and create a new array if needed.
this
-Get the width of the entire
+
Returns the CSS compatible font string.
+Returns the CSS compatible font string for the text font.