Optional options: StaveOptionsReadonly optionsStatic 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 defaultStatic rightAdds 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.
Optional position: numberApply the element style to context.
Validate and return the rendering context.
Return the element attributes.
Get the boundingBox.
Get the current configuration for the Stave.
An array of configuration objects.
Return the context, such as an SVGContext or CanvasContext object.
Get default style for ledger lines.
Optional position: numberOptional category: stringarray of StaveModifiers that match the provided position and category.
Get the element style used for rendering.
Restore the style of context.
Configure properties of the lines in the Stave
RuntimeError "StaveConfigError" When the specified line number is out of range of the number of lines specified in the constructor.
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.
RuntimeError "StaveConfigError" When the lines_configuration array does not have exactly the same number of elements as the num_lines configuration object set in the constructor.
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 to an SVGContext or CanvasContext object
Optional context: RenderContextSet default style for ledger lines.
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.
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.
Set the element & associated children style used for rendering.
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).
Static format
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.