a unique id of the cursor's HTMLElement in the document. Should be constant between re-renders and backend changes, but different between different OSMD objects on the same page.
The desired zIndex (layer) of the cursor when no background color is set. When a background color is set, using a negative zIndex would make the cursor invisible.
Hides and removes the cursor element, deletes object variables.
returns voices under the current Cursor position. Without instrument argument, all voices are returned.
Hide the cursor.
Initialize the cursor. Necessary before using functions like show() and next().
Go to next entry / note / vertical position.
Go to previous entry / note / vertical position.
reset cursor to start position (start of sheet or osmd.Sheet.SelectionStart if set).
Make the cursor visible.
Moves the cursor to the current position of the iterator (visually), e.g. after next().
Check if there was a change in current page, and attach cursor element to the corresponding HTMLElement (div). This is only necessary if using PageFormat (multiple pages).
updates cursor style (visually), e.g. cursor.cursorOptions.type or .color.
Generated using TypeDoc
A cursor which can iterate through the music sheet.