Static DEBUGStatic Readonly HorizontalStatic Readonly HorizontalStatic Readonly VerticalStatic Readonly VerticalStatic Readonly glyphsStatic Readonly symbolReturns 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.
The offset is specified in em. Scale this value by the font size in pixels.
Static CATEGORYModifiers category string. Every modifier has a different category.
The ModifierContext uses this to determine the type and order of the modifiers.
Static PositionModifiers can be positioned almost anywhere, relative to a note.
Static PositionStatic minStatic spacingStatic subscriptStatic superStatic superscriptAdds 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).
Add a glyph block.
Add a glyph for each character in 'text'. If the glyph is not available, use text from the font.
e.g. addGlyphOrText('(+5#11)') will use text for the '5' and '11', and glyphs for everything else.
Add a glyph block with superscript modifier.
Add a line of the given width, used as a continuation of the previous symbol in analysis, or lyrics, etc.
Add a symbol to this chord, could be text, glyph or line.
Add a text block.
Add a text block with subscript modifier.
Add a text block with superscript modifier.
Apply the element style to context.
Validate and return the rendering context.
Check and get ModifierContext.
Return the element attributes.
Get the boundingBox.
Return the context, such as an SVGContext or CanvasContext object.
Get ModifierContext.
Get the element style used for rendering.
ChordSymbol allows multiple blocks so we can mix glyphs and font text. Each block can have its own vertical orientation.
Call back from registry after the element is registered.
Remove a class label (An element can have multiple class labels).
Render the element text.
Restore the style of context.
Set an attribute such as 'id', 'class', or 'type'.
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.
Change the font size, while keeping everything else the same.
Optional size: string | numberSet the element & associated children style used for rendering.
Set horizontal justification.
Set note index, which is a specific note in a chord.
Every modifier must be part of a ModifierContext.
Set attached note.
(StaveNote, TabNote, etc.)
Set position.
CENTER | LEFT | RIGHT | ABOVE | BELOW
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();
Set element text.
Set the textLine for the modifier.
Set vertical position of text (above or below stave).
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.
Static formatEstimate the width of the whole chord symbol, based on the sum of the widths of the individual blocks. Estimate how many lines above/below the staff we need.
Static getStatic measureStatic set
ChordSymbol is a modifier that creates a chord symbol above/below a chord. As a modifier, it is attached to an existing note.