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.
Provide a CSS compatible font string (e.g., 'bold 16px Arial').
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').
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-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.
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.
Add a class label (An element can have multiple class labels).
Create new stems for the notes in the beam, so that each stem extends into the beams.
Apply the element style to context
.
Set which note indices
to break the secondary beam at.
Calculate a slope and y-shift for flat beams.
Calculate the best possible slope for the provided notes.
Validate and return the context.
Render the beam to the canvas context
Draw the element and all its sub-elements (ie.: Modifiers in a Stave) with the element style.
Return an attribute.
Return the element attributes.
Get the max number of beams in the set of notes.
Get the x coordinates for the beam lines of specific duration
.
Return the Beam y offset.
Get the boundingBox.
Get element category string.
Return the context.
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 notes in this beam.
Return the y coordinate for linear function.
Get the direction of the beam
Get the element style used for rendering.
Check if it has a class label (An element can have multiple class labels).
Return the rendered status.
Return upper level beam direction.
Post-format the beam. This can only be called after
the notes in the beam have both x
and y
values. ie: they've
been formatted and have staves.
Pre-format the beam.
Remove a class label (An element can have multiple class labels).
Reset the text font to the style indicated by the static TEXT_FONT
property.
Subclasses can call this to initialize textFont
for the first time.
Restore the style of context
.
Set an attribute.
Set the context.
Set the element's font family, size, weight, style (e.g., Arial
, 10pt
, bold
, italic
).
is 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).
a string specifying the font size and unit (e.g., '16pt'), or a number (the unit is assumed to be 'pt').
is a string (e.g., 'bold', 'normal') or a number (100, 200, ... 900).
is 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.
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 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();
Restore the default direction of a partial beam (a secondary-level beam that does not connect to any other notes).
A helper function to automatically build basic beams for a voice. For more
complex auto-beaming use Beam.generateBeams()
.
the voice to generate the beams for
a stem direction to apply to the entire voice
an array of Fraction
representing beat groupings for the beam
A helper function to autimatically build beams for a voice with configuration options.
Example configuration object:
config = {
groups: [new Vex.Flow.Fraction(2, 8)],
stem_direction: -1,
beam_rests: true,
beam_middle_only: true,
show_stemlets: false
};
an array of notes to create the beams for
the configuration object
set to true
to only beam rests in the middle of the beat
set to true
to include rests in the beams
array of Fractions
that represent the beat structure to beam the notes
set to true
to not apply new stem directions
set to true
to draw stemlets for rests
set to apply the same direction to all notes
Get the default beam groups for a provided time signature. Attempt to guess if the time signature is not found in table. Currently this is fairly naive.
Beams
span over a set ofStemmableNotes
.