Browse Source

commment (jsdoc)

sschmidTU 4 years ago
parent
commit
ba35ae1a45
1 changed files with 4 additions and 0 deletions
  1. 4 0
      src/OpenSheetMusicDisplay/OSMDOptions.ts

+ 4 - 0
src/OpenSheetMusicDisplay/OSMDOptions.ts

@@ -4,6 +4,10 @@ import { FontStyles } from "../Common/Enums/FontStyles";
 /** Possible options for the OpenSheetMusicDisplay constructor and osmd.setOptions(). None are mandatory.
 /** Possible options for the OpenSheetMusicDisplay constructor and osmd.setOptions(). None are mandatory.
  *  Note that after using setOptions(), you have to call osmd.render() again to make changes visible.
  *  Note that after using setOptions(), you have to call osmd.render() again to make changes visible.
  *  Example: osmd.setOptions({defaultColorRest: "#AAAAAA", drawSubtitle: false}); osmd.render();
  *  Example: osmd.setOptions({defaultColorRest: "#AAAAAA", drawSubtitle: false}); osmd.render();
+ * 
+ *  Note that some additional, usually more small scale options are available in EngravingRules,
+ *  though not all of them are meant to be manipulated.
+ *  The OSMDOptions are the main options we support.
  */
  */
 export interface IOSMDOptions {
 export interface IOSMDOptions {
     /** Whether to let Vexflow align rests to preceding or following notes (Vexflow option). Default false (0).
     /** Whether to let Vexflow align rests to preceding or following notes (Vexflow option). Default false (0).