Protected_fontProtected_heightProtected_textProtected_textProtected_widthProtectedattrsProtectedchildrenProtected OptionalexpProtectedfontProtected ReadonlylargestProtectedmetricsProtectedmodeProtectedoptionsProtected OptionalparentProtectedpreProtected OptionalregistryProtectedrenderedProtectedresolutionProtectedsmallestProtected OptionalstaveProtectedstyleProtected ReadonlytickablesProtected ReadonlyticksProtected ReadonlytimeProtected ReadonlytotalProtectedxProtectedxProtectedyProtectedyProtected StaticIDReturns 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.
StaticCATEGORYStaticModeModes allow the addition of ticks in three different ways:
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).
Apply the element style to context.
Validate and return the rendering context.
Render the voice onto the canvas context and an optional stave.
If stave is omitted, it is expected that the notes have staves
already set.
This method also calculates the voice's boundingBox while drawing the notes. Note the similarities with this.getBoundingBox().
Optionalstave: StaveDraw the element and all its sub-elements (i.e.: Modifiers in a Stave)
with the element's style (see getStyle() and setStyle())
Get the actual tick resolution for the voice.
Return an attribute, such as 'id', 'type' or 'class'.
Return the element attributes.
Get the bounding box for the voice.
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 largest width of all the tickables.
Get the voice mode (Voice.Mode.SOFT, STRICT, or FULL)
Get the resolution multiplier for the voice.
Get the tick count for the shortest tickable
Get the element style used for rendering.
Return associated SVGElement.
Get element text.
Get the text metrics.
Get the tickables in the voice.
Get the total ticks used in the voice by all the tickables.
Get the total ticks in the voice.
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).
Determine if the voice is complete according to the voice mode.
Return the rendered status.
Measure the text using the textFont.
Preformat the voice by applying the voice's stave to each note.
ProtectedreCalculate the sum of the exponents of all the ticks in this voice to use as the denominator of softmax. (It is not the sum of the softmax(t) over all tickables)
Note that the "exp" of "expTicksUsed" stands for "expontential" ticks used, not "expected" ticks used.
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
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 the voice mode.
value from VoiceMode or Voice.Mode
Set the rendered status.
We use softmax to layout the tickables proportional to the exponent of their duration. The softmax factor is used to determine the 'linearness' of the layout.
The softmax of all the tickables in this voice should sum to 1.
Set the voice mode to strict or soft.
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.
Shift element down yShift pixels. Negative values shift up.
Get the softmax-scaled value of a tick duration. 'tickValue' is a number.
StaticgetStaticmeasureMeasure the text using the FontInfo related with key.
Protected StaticnewIDStaticset
Voiceis mainly a container object to groupTickablesfor formatting.