Protected_fontProtected_heightProtected_textProtected_textProtected_widthProtectedalignProtectedattrsProtected OptionalbeamProtectedcenterXShiftProtectedchildrenProtectedcustomProtectedcustomProtecteddurationProtectedfontProtectedformatterProtectedignoreProtectedintrinsicProtectedjustificationProtectedleftProtectedlineProtectedmetricsProtected OptionalmodifierProtectedmodifiersProtectednoteProtected OptionalparentProtected OptionalplayProtected OptionalregistryProtectedrenderedProtectedrightProtectedsmoothProtected OptionalstaveProtectedstyleProtected OptionalsubscriptProtected OptionalsuperscriptProtected OptionaltickProtectedtickProtectedticksProtected OptionaltupletProtectedtupletProtected OptionalvoiceProtectedxProtectedxProtectedyProtectedysProtectedyProtected StaticIDStatic ReadonlyJustificationReturns 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.
Set postformatted status.
Set preformatted status.
StaticCATEGORYStaticGLYPHSGlyph data.
Adds 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).
Attach a modifier to this note.
the Modifier to add.
of the key to modify.
this
Add self to the provided ModifierContext mc.
If this tickable has modifiers, set modifierContext.
this
Apply the element style to context.
Apply a tick multiplier.
Check and get the beam.
Validate and return the rendering context.
Check and get ModifierContext.
Check and get the target stave.
Renders the TextNote.
TextNote has to be assigned to a Stave before rendering by means of setStave.
Draw the element and all its sub-elements (i.e.: Modifiers in a Stave)
with the element's style (see getStyle() and setStyle())
Get the absolute X position of this note's tick context. This
excludes xShift, so you'll need to factor it in if you're
looking for the post-formatted x-position.
Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the beam.
Get the boundingBox.
Return the center x shift.
Return the context, such as an SVGContext or CanvasContext object.
Accessor to duration.
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.
Return the formatterMetrics.
Get the glyph associated with this note.
Get the glyph width.
Get the text height.
Return the intrinsic ticks.
Get spacing to the left of the notes.
Return the Stave line on which the TextNote is placed.
Get the stave line number for rest.
Get the stave line number for the note.
OptionalisTopNote: booleanGet the metrics for this note.
Get ModifierContext.
Get the list of associated modifiers.
Accessor to note type.
Get the play note, which is arbitrary data that can be used by an audio player.
Get spacing to the right of the notes.
Get the target stave.
Get the direction of the stem.
Get the top and bottom y values of the stem.
Get the element style used for rendering.
Return associated SVGElement.
Get element text.
Get the text metrics.
Get the TickContext for this note.
Get the tick multiplier.
Return the ticks.
Get the x coordinate to the left of the note.
Get the x coordinate to the right of the note.
Get the tuplet.
Return a list of Tuplets.
Return the voice that this note belongs in.
Get width of note. Used by the formatter for positioning.
Get x position of this tick context.
Get shift element xShift.
Get the Y coordinate.
Get the Y position of the space above the stave onto which text can be rendered.
Get Y positions for this note. Each Y value is associated with an individual pitch/key within the note/chord.
Get shift element yShift.
Check it has a beam.
Check if it has a class label (An element can have multiple class labels).
Accessor to hasStem.
Accessor to isDotted.
Return the rendered status.
true if this note is a type of rest.
Rests don't have pitches, but take up space in the score. Subclasses should override this default implementation.
Measure the text using the textFont.
Postformat the Tickable.
Pre-render formatting.
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.
Optionaltuplet: TupletSet an attribute such as 'id', 'class', or 'type'.
Set the center x shift.
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.
Ignore the ticks.
Set the intrinsic ticks.
Set spacing to the left of the notes.
Set the Stave line on which the note should be placed.
Set 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 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 element width.
Set the X coordinate.
Set shift element right xShift pixels. Negative values shift left.
Set the Y coordinate.
Set Y positions for this note. Each Y value is associated with an individual pitch/key within the note/chord.
Shift element down yShift pixels. Negative values shift up.
True if this note has no duration (e.g., bar notes, spacers, etc.).
StaticgetStaticgetStaticmeasureMeasure the text using the FontInfo related with key.
Protected StaticnewIDProtected StaticparseOptionaldurationString: stringProtected StaticparseStaticplotDebug helper. Displays various note metrics for the given note.
Staticset
TextNoteis a notation element that is positioned in time. Generally meant for objects that sit above/below the staff and inline with each other.TextNotehas to be assigned to aStavebefore rendering by means ofsetStave. Examples of this would be such as dynamics, lyrics, chord changes, etc.