Annotations inherit from Modifier
and is positioned correctly when
in a ModifierContext
.
Create a new Annotation
with the string text
.
To enable logging for this class. Set Vex.Flow.Annotation.DEBUG
to true
.
Text annotations can be positioned and justified relative to the note.
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.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
The size is 1) a string of the form '10pt' or '16px', compatible with the CSS font-size property. or 2) a number, which is interpreted as a point size (i.e. 12 == '12pt').
a CSS font-size string (e.g., '18pt', '12px', '1em').
The size is 1) a string of the form '10pt' or '16px', compatible with the CSS font-size property. or 2) a number, which is interpreted as a point size (i.e. 12 == '12pt').
the font size in px
.
the font size in pt
.
a CSS font-style string (e.g., 'italic').
a CSS font-style string (e.g., 'italic').
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.
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.
Annotations category string.
Modifiers can be positioned almost anywhere, relative to a note.
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.
Check and get note index, which is a specific note in a chord.
Check and get ModifierContext
.
Render text beside the note.
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) with the element style.
Return an attribute.
Return the element attributes.
Get the boundingBox.
Return the context.
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.
Get horizontal justification.
Get ModifierContext
.
Get attached note (StaveNote
, TabNote
, etc.)
Get position.
Return associated SVGElement.
Get spacing from next modifier.
Get the element style used for rendering.
Get modifier widths.
Get shift modifier x
Check if it has a class label (An element can have multiple class labels).
Return the rendered status.
Call back from registry after the element is registered.
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.
Subclasses can call this to initialize textFont
for the first time.
Restore the style of context
.
Set an attribute.
Set the context.
Set the element's font family, size, weight, style (e.g., Arial
, 10pt
, bold
, italic
).
is 1) a FontInfo
object or
2) a string formatted as CSS font shorthand (e.g., 'bold 10pt Arial') or
3) a string representing the font family (at least one of size
, weight
, or style
must also be provided).
a string specifying the font size and unit (e.g., '16pt'), or a number (the unit is assumed to be 'pt').
is a string (e.g., 'bold', 'normal') or a number (100, 200, ... 900).
is a string (e.g., 'italic', 'normal').
If no arguments are provided, then the font is set to the default font.
Each Element subclass may specify its own default by overriding the static TEXT_FONT
property.
Change the font size, while keeping everything else the same.
Set the element & associated children style used for rendering.
Set note index, which is a specific note in a chord.
Set horizontal justification.
Every modifier must be part of a ModifierContext
.
Set attached note.
(StaveNote
, TabNote
, etc.)
Set position.
CENTER | LEFT | RIGHT | ABOVE | BELOW
Set the rendered status.
Set spacing from next modifier.
Set the element style used to render.
Example:
element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
element.draw();
Note: If the element draws additional sub-elements (ie.: Modifiers in a Stave), the style can be applied to all of them by means of the context:
element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
element.getContext().setFillStyle('red');
element.getContext().setStrokeStyle('red');
element.draw();
or using drawWithStyle:
element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
element.drawWithStyle();
Set the text_line
for the modifier.
Set vertical position of text (above or below stave).
value in AnnotationVerticalJustify
.
Set modifier widths.
Shift modifier x
pixels in the direction of the modifier. Negative values
shift reverse.
Shift modifier down y
pixels. Negative values shift up.
Arrange annotations within a ModifierContext
Annotations are modifiers that can be attached to notes.
See
tests/annotation_tests.ts
for usage examples.