Skip to content

Commit

Permalink
documentation automatic update
Browse files Browse the repository at this point in the history
  • Loading branch information
rvilarl committed Nov 28, 2021
1 parent a8b7ed2 commit b185ed0
Show file tree
Hide file tree
Showing 10 changed files with 16 additions and 9 deletions.
1 change: 1 addition & 0 deletions docs/api/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
Binary file modified docs/api/assets/icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/api/assets/icons@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/api/assets/search.js

Large diffs are not rendered by default.

Binary file modified docs/api/assets/widgets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/api/assets/widgets@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/api/classes/Annotation.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>line: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Annotation.html" class="tsd-signature-type" data-tsd-kind="Class">Annotation</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setVerticalJustification" class="tsd-anchor"></a><h3>set<wbr/>Vertical<wbr/>Justification</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Vertical<wbr/>Justification<span class="tsd-signature-symbol">(</span>just<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../enums/AnnotationVerticalJustify.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AnnotationVerticalJustify</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Annotation.html" class="tsd-signature-type" data-tsd-kind="Class">Annotation</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set vertical position of text (above or below stave).</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>just: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../enums/AnnotationVerticalJustify.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AnnotationVerticalJustify</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>value in <code>Annotation.VerticalJustify</code>.</p>
<p>value in <code>AnnotationVerticalJustify</code>.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Annotation.html" class="tsd-signature-type" data-tsd-kind="Class">Annotation</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setWidth" class="tsd-anchor"></a><h3>set<wbr/>Width</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">set<wbr/>Width<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Annotation.html" class="tsd-signature-type" data-tsd-kind="Class">Annotation</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Modifier.html">Modifier</a>.<a href="Modifier.html#setWidth">setWidth</a></p></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set modifier widths.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>width: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Annotation.html" class="tsd-signature-type" data-tsd-kind="Class">Annotation</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setXShift" class="tsd-anchor"></a><h3>setXShift</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">setXShift<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Annotation.html" class="tsd-signature-type" data-tsd-kind="Class">Annotation</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="Modifier.html">Modifier</a>.<a href="Modifier.html#setXShift">setXShift</a></p></aside><div class="tsd-comment tsd-typography"><div class="lead">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/classes/CanvasContext.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
underlying CanvasRenderingContext2D object, part of the browser&#39;s API.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="RenderContext.html" class="tsd-signature-type" data-tsd-kind="Class">RenderContext</a><ul class="tsd-hierarchy"><li><span class="target">CanvasContext</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="CanvasContext.html#canvas" class="tsd-kind-icon">canvas</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CanvasContext.html#context2D" class="tsd-kind-icon">context2D</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CanvasContext.html#textHeight" class="tsd-kind-icon">text<wbr/>Height</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#fillStyle" class="tsd-kind-icon">fill<wbr/>Style</a></li><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="CanvasContext.html#font" class="tsd-kind-icon">font</a></li><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#strokeStyle" class="tsd-kind-icon">stroke<wbr/>Style</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="CanvasContext.html#CANVAS_BROWSER_SIZE_LIMIT" class="tsd-kind-icon">CANVAS_<wbr/>BROWSER_<wbr/>SIZE_<wbr/>LIMIT</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="CanvasContext.html#HEIGHT" class="tsd-kind-icon">HEIGHT</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="CanvasContext.html#WIDTH" class="tsd-kind-icon">WIDTH</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#add" class="tsd-kind-icon">add</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#arc" class="tsd-kind-icon">arc</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#beginPath" class="tsd-kind-icon">begin<wbr/>Path</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#bezierCurveTo" class="tsd-kind-icon">bezier<wbr/>Curve<wbr/>To</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#clear" class="tsd-kind-icon">clear</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#clearRect" class="tsd-kind-icon">clear<wbr/>Rect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#closeGroup" class="tsd-kind-icon">close<wbr/>Group</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#closePath" class="tsd-kind-icon">close<wbr/>Path</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#fill" class="tsd-kind-icon">fill</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#fillRect" class="tsd-kind-icon">fill<wbr/>Rect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#fillText" class="tsd-kind-icon">fill<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#getFont" class="tsd-kind-icon">get<wbr/>Font</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#lineTo" class="tsd-kind-icon">line<wbr/>To</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#measureText" class="tsd-kind-icon">measure<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#moveTo" class="tsd-kind-icon">move<wbr/>To</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#openGroup" class="tsd-kind-icon">open<wbr/>Group</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#quadraticCurveTo" class="tsd-kind-icon">quadratic<wbr/>Curve<wbr/>To</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#rect" class="tsd-kind-icon">rect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#resize" class="tsd-kind-icon">resize</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#restore" class="tsd-kind-icon">restore</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#save" class="tsd-kind-icon">save</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#scale" class="tsd-kind-icon">scale</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#setBackgroundFillStyle" class="tsd-kind-icon">set<wbr/>Background<wbr/>Fill<wbr/>Style</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#setFillStyle" class="tsd-kind-icon">set<wbr/>Fill<wbr/>Style</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#setFont" class="tsd-kind-icon">set<wbr/>Font</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#setLineCap" class="tsd-kind-icon">set<wbr/>Line<wbr/>Cap</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#setLineDash" class="tsd-kind-icon">set<wbr/>Line<wbr/>Dash</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#setLineWidth" class="tsd-kind-icon">set<wbr/>Line<wbr/>Width</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="CanvasContext.html#setRawFont" class="tsd-kind-icon">set<wbr/>Raw<wbr/>Font</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#setShadowBlur" class="tsd-kind-icon">set<wbr/>Shadow<wbr/>Blur</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#setShadowColor" class="tsd-kind-icon">set<wbr/>Shadow<wbr/>Color</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#setStrokeStyle" class="tsd-kind-icon">set<wbr/>Stroke<wbr/>Style</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="CanvasContext.html#stroke" class="tsd-kind-icon">stroke</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CanvasContext.html#sanitizeCanvasDims" class="tsd-kind-icon">sanitize<wbr/>Canvas<wbr/>Dims</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Canvas<wbr/>Context<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OffscreenCanvasRenderingContext2D</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CanvasContext.html" class="tsd-signature-type" data-tsd-kind="Class">CanvasContext</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="RenderContext.html">RenderContext</a>.<a href="RenderContext.html#constructor">constructor</a></p></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>context: <span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OffscreenCanvasRenderingContext2D</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CanvasContext.html" class="tsd-signature-type" data-tsd-kind="Class">CanvasContext</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="canvas" class="tsd-anchor"></a><h3>canvas</h3><div class="tsd-signature tsd-kind-icon">canvas<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OffscreenCanvas</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
<p>The HTMLCanvasElement or OffscreenCanvas that is associated with the above context.
If there was no associated <canvas> element, just store the default WIDTH / HEIGHT.</p>
If there was no associated <code>&lt;canvas&gt;</code> element, just store the default WIDTH / HEIGHT.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="context2D" class="tsd-anchor"></a><h3>context2D</h3><div class="tsd-signature tsd-kind-icon">context2D<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OffscreenCanvasRenderingContext2D</span></div><div class="tsd-comment tsd-typography"><div class="lead">
<p>The 2D rendering context from the Canvas API. Forward method calls to this object.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="textHeight" class="tsd-anchor"></a><h3>text<wbr/>Height</h3><div class="tsd-signature tsd-kind-icon">text<wbr/>Height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><div class="tsd-comment tsd-typography"><div class="lead">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/classes/Factory.html

Large diffs are not rendered by default.

16 changes: 11 additions & 5 deletions docs/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<a href="#vexflow-4-beta" id="vexflow-4-beta" style="color: inherit; text-decoration: none;">
<h1>VexFlow 4 (beta)</h1>
</a>
<p>A JavaScript / TypeScript library for rendering music notation.
Copyright (c) 2010 Mohit Muthanna Cheppudira</p>
<p>A JavaScript / TypeScript library for rendering music notation.</p>
<p>Copyright (c) 2010 Mohit Muthanna Cheppudira</p>

<a href="#sponsor-this-project" id="sponsor-this-project" style="color: inherit; text-decoration: none;">
<h2>Sponsor this Project</h2>
Expand Down Expand Up @@ -39,10 +39,16 @@ <h3>Using NPM</h3>
<a href="#using-the-html-script-tag" id="using-the-html-script-tag" style="color: inherit; text-decoration: none;">
<h3>Using the HTML <code>script</code> Tag</h3>
</a>
<p>The releases are served via <a href="https://unpkg.com">unpkg.com</a>.</p>
<p>Releases are served via CDN:</p>
<p><strong>unpkg</strong></p>
<ul>
<li>Debug version: <a href="https://unpkg.com/vexflow/releases/vexflow-debug.js">https://unpkg.com/vexflow/releases/vexflow-debug.js</a></li>
<li>Minified version: <a href="https://unpkg.com/vexflow/releases/vexflow-min.js">https://unpkg.com/vexflow/releases/vexflow-min.js</a></li>
<li>Minified: <a href="https://unpkg.com/vexflow@4.0.0/build/vexflow.js">https://unpkg.com/vexflow@4.0.0/build/vexflow.js</a></li>
<li>Debug: <a href="https://unpkg.com/vexflow@4.0.0/build/vexflow-debug.js">https://unpkg.com/vexflow@4.0.0/build/vexflow-debug.js</a></li>
</ul>
<p><strong>jsdelivr</strong></p>
<ul>
<li>Minified: <a href="https://cdn.jsdelivr.net/npm/vexflow@4.0.0/build/vexflow.js">https://cdn.jsdelivr.net/npm/vexflow@4.0.0/build/vexflow.js</a></li>
<li>Debug: <a href="https://cdn.jsdelivr.net/npm/vexflow@4.0.0/build/vexflow-debug.js">https://cdn.jsdelivr.net/npm/vexflow@4.0.0/build/vexflow-debug.js</a></li>
</ul>

<a href="#using-easyscore" id="using-easyscore" style="color: inherit; text-decoration: none;">
Expand Down

0 comments on commit b185ed0

Please sign in to comment.