Optional flatOptional secondaryReturns 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').
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.
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.
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 notes in this beam.
Get the element style used for rendering.
Return upper level beam direction.
Render the element text.
Restore the style of context.
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.
Set the element & associated children style used for rendering.
Forces the direction of a partial beam (a secondary-level beam that exists on one note only of the beam group). This is useful in rhythms such as 6/8 eighth-sixteenth-eighth-sixteenth, where the direction of the beam on the first sixteenth note can help imply whether the rhythm is to be felt as three groups of eighth notes (typical) or as two groups of three-sixteenths (less common):
┌───┬──┬──┐ ┌──┬──┬──┐
│ ├─ │ ─┤ vs │ ─┤ │ ─┤
│ │ │ │ │ │ │ │
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 applyStatic generateA helper function to autimatically build beams for a voice with configuration options.
Example configuration object:
config = {
groups: [new VexFlow.Fraction(2, 8)],
stemDirection: -1,
beamRests: true,
beamMiddleOnly: true,
showStemlets: false
};
an array of notes to create the beams for
the configuration object
Optional beamset to true to only beam rests in the middle of the beat
Optional beamset to true to include rests in the beams
Optional flatOptional flatOptional groups?: Fraction[]array of Fractions that represent the beat structure to beam the notes
Optional maintainset to true to not apply new stem directions
Optional secondaryOptional showset to true to draw stemlets for rests
Optional stemset to apply the same direction to all notes
Static getStatic getStatic measureStatic set
Beamsspan over a set ofStemmableNotes.