Create a new articulation.
entry in VexFlow.articulationCodes in tables.ts or Glyph code.
Notes default positions (see https://w3c.github.io/smufl/latest/tables/articulation.html):
Protected_fontProtected_heightProtected_textProtected_textProtected_widthProtectedarticulationProtectedattrsProtectedchildrenProtectedfontProtectedheightProtected OptionalindexProtectedmetricsProtected OptionalmodifierProtected OptionalnoteProtected OptionalparentProtectedpositionProtected OptionalregistryProtectedrenderedProtectedshouldProtectedspacingProtectedstyleProtectedtextReadonlytypeArticulation code provided to the constructor.
ProtectedxProtectedxProtectedyProtectedyStaticDEBUGTo enable logging for this class. Set VexFlow.Articulation.DEBUG to true.
Protected StaticIDProtected Static ReadonlyINITIAL_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).
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.
StaticCATEGORYArticulations category string.
StaticPositionModifiers can be positioned almost anywhere, relative to a note.
StaticPositionAdds 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).
Apply the element style to context.
Used in draw() to check and get the attached note (StaveNote, TabNote, etc.).
Also verifies that the index is valid.
Validate and return the rendering context.
Check and get note index, which is a specific note in a chord.
Check and get ModifierContext.
Render articulation in position next to note.
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.
Return the context, such as an SVGContext or CanvasContext object.
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.
Get note index, which is a specific note in a chord.
Get ModifierContext.
Get attached note (StaveNote, TabNote, etc.)
Get position.
Get spacing from next modifier.
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 modifier x
Get the Y coordinate.
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).
ProtectedresetCalled when position changes.
Set an attribute such as 'id', 'class', or 'type'.
Set if articulation should be rendered between lines.
Set the context to an SVGContext or CanvasContext object
Optionalcontext: 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.
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.
Set note index, which is a specific note in a chord.
Set position.
CENTER | LEFT | RIGHT | ABOVE | BELOW
Set the rendered status.
Set spacing from next modifier.
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.
Set the textLine for the modifier.
Set element width.
Set the X coordinate.
Shift modifier x pixels in the direction of the modifier. Negative values
shift reverse.
Set the Y coordinate.
Shift modifier down y pixels. Negative values shift up.
StaticeasyStaticformatFIXME: Most of the complex formatting logic (ie: snapping to space) is actually done in .render(). But that logic belongs in this method.
Unfortunately, this isn't possible because, by this point, stem lengths have not yet been finalized. Finalized stem lengths are required to determine the initial position of any stem-side articulation.
This indicates that all objects should have their stave set before being formatted. It can't be an optional if you want accurate vertical positioning. Consistently positioned articulations that play nice with other modifiers won't be possible until we stop relying on render-time formatting.
Ideally, when this function has completed, the vertical articulation positions should be ready to render without further adjustment. But the current state is far from this ideal.
StaticgetStaticmeasureMeasure the text using the FontInfo related with key.
Protected StaticnewIDStaticset
Articulations and Accents are modifiers that can be attached to notes. The complete list of articulations is available in
tables.tsunderVexFlow.articulationCodes.See
tests/articulation_tests.tsfor usage examples.