StaffSVGRender constructor.
The StaffInfo to be visualized.
Visualization configuration options.
The element where the visualization should be displayed.
How it has to be rendered
Coded in semitones (0 = C, 1 = C#, ... 11 = B)
Like 3/4
Overall staff container
Horizontal factor in pixels (1 hStep/time unit)
Full score height (pixels)
Time when last bar started in quarters
Optimized scroll value
Last drawn block start time in quarters
Acting as background layer
Acting as middle plane layer
Overlay container for vertical repositioning
Overlay signature drawing area
Upper container
Highlited ones
General scale appliable to all SVG elements
Kind of scrolling if any
Current signature beginning x position
Current signature end x position
Signatures displaying mode switch
Acting as foreground layer
x positions
When to stop blinking (in quarters)
Staff container for vertical repositioning
The actual music score data to be rendered
Intermediate staff model arranged in non-overlapped blocks
Vertical SVG distance to middle staff line
Main staff drawing area
Mutex to reduce scroll handling everhead
Vertical factor in pixels (2 vStep/staff line)
Full score width (pixels)
Combines signatures change and drawing according to x position. It's used to replace overlays on horizontal scrolling according to next diagram:
current x next <= current & next include the starting point
| | |
[0 )[1 )[2 )null
Horizontal position to draw signatures
Changes the current key according to the quarter position
Quarters from beginning where change could happen
Wether it changed or not
Changes the current time signature according to the quarter position
Quarters from beginning where change could happen
Wether it changed or not
Clears and resets the visualizer object for further redraws from scratch.
Erases all graphical elements on the signature overlay
Draws a bar line if this quarter fits on the beginning of a new bar
Quarters from beginning where bar could start
Horizontal position in staff to draw the bar line, if any.
The with of the drawn bar line
Draw all notes of aStaffBlock (heads, stem, flags, dots, accidentals)
into a staff
The block containing the notes to be drawn
Horizontal position to draw the notes
Temporary storage of visual data aids
The width of the drawn notes
Draws the rests which follows a musical block in a staff
The block which indicates how much rest should be displayed till the next block
Horizontal position to draw the rests
The width of the drawn rests
Draws the signatires in the given container
Container of the signatures to be drawn
Horizontal position to start drawing it
Wether to draw the clef or not
Wether to draw the key or not
Wether to draw the time signature or not
The width of the whole signature set drawn
Draws signatures if there's a signature change on specified quarter
Quarters from beginning where signatiures could start
Horizontal position where it should be drawn
Width of the drawn signatures or 0 if proportional visualization
Draws a set of musical symbols grouped in a block into a staff
The block to be drawn
Horizontal position to draw the block
Temporary storage of visual data aids
The width of the drawn block
Generates a http string with the default color (default) or the active one
Wether the color is active (highlight) or not
The color string
Locates a SVG group to highlight the symbols it contains
The note to locate the SVG group it belongs to
The SVG Group
Generates an alpha transparency value with a slight bump to avoid quiet notes to be invisible
The MIDI velocity of the note (from 0 to 127)
A numerical value for opacity (from 0.0 = full transparent to 1.0 = full opacity)
Callback handler for horizonatal scroll events
Ignored
Verifies if a given highlighted note should stay that way
A note is active if it's literally the same as the note we are playing (aka activeNote), or if it overlaps because it's a held note.
One of the highlighted notes which are currently been played
A new active note pending to be highlighted
If it should stay highlighted or not
Redraws the entire staffInfo in a staff if no activeNote is given,
highlighting on and off the appropriate notes otherwise. Should the
staffInfo had changed adding more notes at the end, calling this
method again would complete the redrawing from the very last note it was
drawn, maintaining the active note and the scroll position as they were.
This is handy for incremental compositions.
Given the complexity of adaptation to a modified score, modifyied notes
previously drawn will be ignored, however, you can always clear() and
redraw() for a full redraw.
If specified, this Note will be painted
in the active color and there won't be an actual redrawing, but a
re-colouring of the involved note heads, accidentals, dots and ties
(activated and de-activated ones). Otherwise, all musical symbols which
were not processed yet will be drawn to complete the score.
If specified and the active note to be
highlited is not visualized in the container DIV, the later will be
scrolled so that the note is viewed in the right place. This can be
altered by StaffRenderConfig.scrollType.
The x position of the highlighted active note relative to the beginning of the SVG, or -1 if there wasn't any given active note. Useful for automatically advancing the visualization if needed.
Draws the five horizontal lines of a staff (pentagram) or scales them to the current width of the score if already drawn
The SVG container of the lines
Horizontal starting point of the drawing
Width of the pentagram
The SVG which represents the pentagram
Actuator on the horizontal scroll to show highlited note
Wether the scroll must follow active note or not
Horizontal position of the current active note
Resizes containers to fully hold staff on possible resizes
Vertical top position on highest staff component
Vertical bottom position on lowest staff component
Generated using TypeDoc
Displays a
StaffInfoas a staff on a givenDIV.Staff is scaled to fit vertically
config.noteHeightand note horizontal position can behave in two different ways: Ifconfig.pixelsPerTimeStepis greater than zero, horizontal position will be proportional to its starting time, allowing to pile several instances for different voices (parts). Otherwise, resulting staff will display notes in a compact form, using minimum horizontal space between musical symbols as regular paper staff does.Clef, key and time signature will be displayed at the leftmost side and the rest of the staff will scroll under this initial signature area accordingly. In case of proportional note positioning, given it starts at pixel zero, the signature area will blink meanwhile it collides with initial active notes. Key and time signature changes will be shown accordingly through score.