Static
TEXT_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 for the text font.
Provide a CSS compatible font string (e.g., 'bold 16px Arial') that will be applied to text (not glyphs).
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-weight string (e.g., 'bold'). As in CSS, font-weight is always returned as a string, even if it was set as a number.
Static
CATEGORYStatic
PositionStatic
glyphsAdds 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 rendering context.
Return the element attributes.
Get the boundingBox.
Return the context, such as an SVGContext or CanvasContext object.
Returns {line, num (=getIsNumeric), glyph} -- but these can also be accessed directly w/ getters and setters.
Get the element style used for rendering.
Returns a new TimeSignatureGlyph (a Glyph subclass that knows how to draw both top and bottom digits along with plus signs etc.)
Call back from registry after the element is registered.
Return TimeSignatureInfo given a string, consisting of line (number), num (boolean: same as TimeSignature.getIsNumeric()), and glyph (a Glyph or TimeSignatureGlyph object).
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).
Restore the style of context
.
Set an attribute such as 'id', 'class', or 'type'.
Set the context to an SVGContext or CanvasContext object
Optional
context: RenderContextSet 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.
Optional
font: string | FontInfois 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).
Optional
size: string | numbera string specifying the font size and unit (e.g., '16pt'), or a number (the unit is assumed to be 'pt').
Optional
weight: string | numberis a string (e.g., 'bold', 'normal') or a number (100, 200, ... 900).
Optional
style: stringis 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.
Optional
size: string | numberSet the Glyph object used to draw the time signature, and update the width of the TimeSignature to match. The Glyph must define width in its metrics.
Set the element & associated children style used for rendering.
Set the rendered status.
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 a new time signature specification without changing customPadding, etc.
The getter for this is getTimeSpec
not getTimeSig
.
A TimeSignature is a StaveModifier that can make its appropriate Glyphs directly from a provided "timeSpec" such as "4/4", "C|" (cut time), or even something more advanced such as "3/4(6/8)" or "2/4+5/8".