Optionaloptions: StaveOptionsProtected_fontProtected_heightProtected_textProtected_textProtected_widthProtectedattrsProtectedboundsProtectedchildrenProtectedclefProtecteddefaultProtected OptionalendProtectedendXProtectedfontProtectedformattedProtectedmeasureProtectedmetricsProtected ReadonlymodifiersReadonlyoptionsProtected OptionalparentProtected OptionalregistryProtectedrenderedProtectedshouldProtectedstartXProtectedstyleProtectedxProtectedxProtectedyProtectedyProtected StaticIDReturns 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).
Return a copy of the current FontInfo object.
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').
Set the font style.
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.
Set the font weight.
StaticCATEGORYStaticdefaultStaticrightAdds a child 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).
Add a clef to the stave.
Example:
stave.addClef('treble')
clef (treble|bass|...) see Clef.types
Optionalsize: stringOptionalannotation: stringOptionalposition: numberOptionalsize: stringOptionalannotation: stringOptionalcustomPadding: numberAdd a key signature to the stave.
Example:
stave.addKeySignature('Db');
new key specification [A-G][b|#]? or [flats|sharps]_[1-14]?
OptionalcancelKeySpec: stringOptionalposition: numberOptionalposition: numberAdd a time signature to the stave
Example:
stave.addTimeSignature('4/4');
time signature specification (C\||C|\d/\d)
OptionalcustomPadding: numberOptionalposition: numberApply the element style to context.
Validate and return the rendering context.
All drawing functions below need the context to be set.
Draw pointer rect. This allows mouse interaction with the element
Draw the element and all its sub-elements (i.e.: Modifiers in a Stave)
with the element's style (see getStyle() and setStyle())
Return an attribute, such as 'id', 'type' or 'class'.
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.
Get the css string describing this Element's text font. e.g., 'bold 10pt Arial'.
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 the text height.
Return the measure number of this Stave.
Optionalposition: numberOptionalcategory: stringarray of StaveModifiers that match the provided position and category.
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
Get the element style used for rendering.
Return associated SVGElement.
Get element text.
Get the text metrics.
Get element width.
Get the X coordinate.
Get shift element xShift.
Get the Y coordinate.
the y for the center of a staff line
Get shift element yShift.
Check if it has a class label (An element can have multiple class labels).
Return the rendered status.
Measure the text using the textFont.
Remove a class label (An element can have multiple class labels).
Set an attribute such as 'id', 'class', or 'type'.
Optionalsize: stringOptionalannotation: stringOptionalposition: numberConfigure 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 to an SVGContext or CanvasContext object
Optionalcontext: RenderContextOptionalsize: stringOptionalannotation: stringOptionalcancelKeySpec: stringOptionalcustomPadding: numberSet 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.
Optionalfont: 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).
Optionalsize: string | numbera string specifying the font size and unit (e.g., '16pt'), or a number (the unit is assumed to be 'pt').
Optionalweight: string | numberis a string (e.g., 'bold', 'normal') or a number (100, 200, ... 900).
Optionalstyle: 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.
Optionalsize: string | numberSet the element & associated children style used for rendering.
OptionalcancelKeySpec: stringOptionalposition: numberSet the measure number of this Stave.
Set the rendered status.
Coda & Segno Symbol functions
Set the element style used to render.
Example:
element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
element.drawWithStyle();
Note: If the element draws additional sub-elements (i.e.: 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.drawWithStyle();
or using drawWithStyle:
element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
element.drawWithStyle();
Set element text.
OptionalcustomPadding: numberOptionalposition: numberSet element width.
Set the X coordinate.
Set shift element right xShift pixels. Negative values shift left.
Set the Y coordinate.
Shift element down yShift pixels. Negative values shift up.
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).
StaticformatStaticgetStaticmeasureMeasure the text using the FontInfo related with key.
Protected StaticnewIDStaticset
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 handles style and font properties for the Element and any child elements, along with working with the Registry to create unique ids.
The
textis a series of unicode characters (including SMuFL codes). ThetextFontproperty contains information required to style the text (i.e., font family, size, weight, and style). This font family is a comma separated list of fonts. The methodmeasureTextcalculates thetextMetrics,boundingBox,heightandwidthof thetext. The methodrenderText(...)will render the text using the provided context and coordinates, takingxShiftandyShiftinto account.