Abstract Optional draw?: booleanOptional draw_Optional draw_Optional draw_Optional extend_Optional extend_Optional glyph_Optional stemOptional stem_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.
Set postformatted status.
Set preformatted status.
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).
Attach a modifier to this note.
the Modifier to add.
of the key to modify.
this
Add stroke.
Add self to the provided ModifierContext mc.
If this tickable has modifiers, set modifierContext.
this
Apply the element style to context.
Validate and return the rendering context.
Check and get ModifierContext.
Abstract drawRenders the stem onto the canvas.
Return the element attributes.
Get the boundingBox.
Return the context, such as an SVGContext or CanvasContext object.
Return the formatterMetrics.
Get the glyph associated with this note.
Get the metrics for this note.
Get ModifierContext.
Get the element style used for rendering.
Get the TickContext for this note.
Call back from registry after the element is registered.
Post formats the note.
Remove a class label (An element can have multiple class labels).
Reset the Tickable, this function will be overloaded.
Reset the specific Tuplet (if this is not provided, all tuplets are reset). Remove any prior tuplets from the tick calculation and reset the intrinsic tick value.
Optional tuplet: TupletRestore the style of context.
Set an attribute such as 'id', 'class', or 'type'.
Set the beam.
Set the center x shift.
Set the context to an SVGContext or CanvasContext object
Optional context: RenderContextSet the duration.
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.
Change the font size, while keeping everything else the same.
Optional size: string | numberSet the element & associated children style used for rendering.
Ignore the ticks.
Set spacing to the left of the notes.
Attach this note to a modifier context.
Optional mc: ModifierContextSet the play note, which is arbitrary data that can be used by an audio player.
Set the rendered status.
Set spacing to the right of the notes.
Set the target stave.
Optional direction: numberSet 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();
Set the TickContext for this note.
Attach to new tuplet.
Attach this note to voice.
Displace note by x pixels. Used by the formatter.
Set Y positions for this note. Each Y value is associated with an individual pitch/key within the note/chord.
Static getStatic plotDebug helper. Displays various note metrics for the given note.
Note implements an abstract interface for notes and chords that are rendered on a stave. Notes have some common properties: All of them have a value (e.g., pitch, fret, etc.) and a duration (quarter, half, etc.)
Some notes have stems, heads, dots, etc. Most notational elements that surround a note are called modifiers, and every note has an associated array of them. All notes also have a rendering context and belong to a stave.