StaffSVGVisualizer constructor.
The NoteSequence to be visualized.
The element where the visualization should be displayed.
(optional) Visualization configuration options.
Clears and resets the visualizer object for further redraws from scratch.
Redraws the entire noteSequence in a staff if no activeNote is given,
highlighting on and off the appropriate notes otherwise. Should the
noteSequence 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
adaption to a modified score, modifyied notes previously drawn will be
ignored (you can always clear() and redraw() for a full redraw).
Please have in mind mm.Player does not have this incremental capability
so, once the player had started, it will go on ignoring the changes.
(Optional) 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.
(Optional) If specified and the active note to be
highlighted is not visualized in the container DIV, the latter will be
scrolled so that the note is viewed in the right place. This can be
altered by AdvancedVisualizerConfig.scrollType.
The x position of the highlighted active note relative to the beginning of the DIV, or -1 if there wasn't any given active note. Useful for automatically advancing the visualization if needed.
Generated using TypeDoc
Displays a
NoteSecuenceas a staff on a given SVG. Staff is scaled to fit verticallyconfig.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.
New configuration features have been introduced through
StaffSVGVisualizerConfigover basicVisualizerConfig.When connected to a player, the visualizer can also highlight the notes being currently played.
You can find more info at:
https://github.com/rogerpasky/staffrender-magentaviewer