Protected
_fontProtected
_heightProtected
_textProtected
_textProtected
_widthProtected
attrsProtected
childrenProtected
depressProtected
fontProtected
lineProtected
metricsProtected
notesProtected
Optional
parentProtected
Optional
registryProtected
releaseProtected
renderedProtected
styleProtected
typeProtected
xProtected
xProtected
yProtected
yStatic
DEBUGTo enable logging for this class. Set VexFlow.PedalMarking.DEBUG
to true
.
Static
Readonly
GLYPHSGlyph data
Protected
Static
IDStatic
Readonly
typePedal type as number.
Static
Readonly
typePedal type as string.
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.
Static
CATEGORYAdds 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
.
Validate and return the rendering context.
Render the pedal marking in position on the rendering context.
Draw the bracket based pedal markings.
Draw the text based pedal markings. This defaults to the traditional "Ped" and "*"" symbols if no custom text has been provided.
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 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 element xShift
.
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).
Set an attribute such as 'id', 'class', or 'type'.
Set the context to an SVGContext or CanvasContext object
Optional
context: RenderContextSet custom text for the depress
/release
pedal markings. No text is
set if the parameter is falsy.
Optional
release: stringSet 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 the staff line to render the markings on.
Set the rendered status.
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 pedal type.
Set element width.
Set the X coordinate.
Set shift element right xShift
pixels. Negative values shift left.
Set the Y coordinate.
Shift element down yShift
pixels. Negative values shift up.
Static
createStatic
createCreate a sustain pedal marking. Returns the defaults PedalMarking. Which uses the traditional "Ped" and "*"" markings.
Static
createStatic
getStatic
measureMeasure the text using the FontInfo related with key.
Protected
Static
newIDStatic
set
PedalMarking implements different types of pedal markings. These notation elements indicate to the performer when to depress and release the a pedal.
In order to create "Sostenuto", and "una corda" markings, you must set custom text for the release/depress pedal markings.