Optional options: { Static CURRENT_Static MUSIC_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 CATEGORYAdds 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.
Get the element style used for rendering.
Call back from registry after the element is registered.
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 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();
Static getStatic getStatic loadOptional category: stringStatic lookupPass a key of the form glyphs.{category}.{code}.{key} to Font.lookupMetric(). If the initial lookup fails,
try again with the path glyphs.{category}.{key}. If the second lookup fails, return the defaultValue.
any metric path under 'glyphs', so 'stem.up' could resolve to glyphs.stem.up.shiftX, glyphs.stem.up.shiftY, etc.
Static lookupStatic renderRenders glyphs from the default font stack.
Canvas or SVG context
x coordinate
y coordinate
the point size of the font
the glyph code in font.getGlyphs()
Optional options: { Optional category?: stringOptional scale?: numberStatic render
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.