Class Annotation

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.

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').

Modifiers can be positioned almost anywhere, relative to a note.

Adds 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).

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.

Draw the element and all its sub-elements (ie.: 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'.

Get note index, which is a specific note in a chord.

Get ModifierContext.

Get attached note (StaveNote, TabNote, etc.)

Get position.

Return associated SVGElement.

Get spacing from next modifier.

Get the element style used for rendering.

Get modifier widths.

Get shift modifier x

Check if it has a class label (An element can have multiple class labels).

Return the rendered status.

Call back from registry after the element is registered.

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 such as 'id', 'class', or 'type'.

Set the context to an SVGContext or CanvasContext object

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.

Change the font size, while keeping everything else the same.

Set the element & associated children style used for rendering.

Set note index, which is a specific note in a chord.

Every modifier must be part of a ModifierContext.

Set attached note.

Set position.

Set the rendered status.

Set spacing from next modifier.

Set the element style used to render.

Example:

element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
element.draw();
Copy

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();
Copy

or using drawWithStyle:

element.setStyle({ fillStyle: 'red', strokeStyle: 'red' });
element.drawWithStyle();
Copy

Set the text_line for the modifier.

Set modifier widths.

Shift modifier x pixels in the direction of the modifier. Negative values shift reverse.

Shift modifier down y pixels. Negative values shift up.