Skip to content
This repository was archived by the owner on Aug 12, 2025. It is now read-only.

documentation of options #4

Open
kepper wants to merge 1 commit into
base: master
Choose a base branch
from
Open

documentation of options #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,19 @@ $ gulp
(new Continuo({el: "#html_id", meiString: '<mei><!-- MEI data --></mei>'})).render();
```

## Options

The object passed to the constructor allows various options:

* **el**: ID of the HTML element where the score shall be rendered; prepended by '#'
* **mei**: URL of the MEI file to be loaded
* **meiString**: The content of the MEI file as string
* **verovioToolkit**: A reference to the Verovio toolkit. In Verovio's tutorials, this is usually the variable *vrvToolkit*
* **verovioOptions**: Custom options for Verovio.
* **omas**: *undocumented*
* **paginate**: *undocumented*
* **showPageCtrls**: Decides whether page controls shall be rendered. *boolean*, default: *true*

## Based on
* [Music Encoding Initiative](http://music-encoding.org)
* [Verovio](http://www.verovio.org/)
Expand Down