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.
Add a class label (An element can have multiple class labels).
Add a clef to the stave.
Example:
stave.addClef('treble')
clef (treble|bass|...) see Clef.types
Add a key signature to the stave.
Example:
stave.addKeySignature('Db');
new key specification [A-G][b|#]?
Add a time signature to the stave
Example:
stave.addTimeSignature('4/4');
time signature specification (C\||C|\d\/\d)
Apply the element style to context
.
Validate and return the context.
All drawing functions below need the context to be set.
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.
Get element category string.
Get the current configuration for the Stave.
An array of configuration objects.
Return the context.
Get default style for ledger lines.
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.
Gets the pixels to shift from the beginning of the stave following the modifier at the provided index
The index from which to determine the shift
The amount of pixels shifted
array of StaveModifiers that match the provided position and category.
Get the element style used for rendering.
the y for the center of a staff line
Check if it has a class label (An element can have multiple class labels).
Return the rendered status.
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.
Configure properties of the lines in the Stave
The index of the line to configure.
An configuration object for the specified line.
Set the staff line configuration array for all of the lines at once.
An array of line configuration objects. These objects are of the same format as the single one passed in to setLineConfiguration(). The caller can set null for any line config entry if it is desired that the default be used
Set the context.
Set default style for ledger lines.
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 rendered status.
Coda & Segno Symbol functions
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();
Use the modifier's getCategory()
as a key for the order
array.
The retrieved value is used to sort modifiers from left to right (0 to to 3).
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.