Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs updated automatically by running grunt. #1633

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Docs updated automatically by running grunt. #1633

Show file tree
Hide file tree
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
24 changes: 12 additions & 12 deletions docs/api/assets/highlight.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@
--dark-hl-4: #CE9178;
--light-hl-5: #008000;
--dark-hl-5: #6A9955;
--light-hl-6: #000000;
--dark-hl-6: #D4D4D4;
--light-hl-7: #A31515;
--dark-hl-7: #CE9178;
--light-hl-8: #0000FF;
--dark-hl-8: #569CD6;
--light-hl-9: #0070C1;
--dark-hl-9: #4FC1FF;
--light-hl-10: #001080;
--dark-hl-10: #9CDCFE;
--light-hl-11: #795E26;
--dark-hl-11: #DCDCAA;
--light-hl-6: #795E26;
--dark-hl-6: #DCDCAA;
--light-hl-7: #000000;
--dark-hl-7: #D4D4D4;
--light-hl-8: #A31515;
--dark-hl-8: #CE9178;
--light-hl-9: #0000FF;
--dark-hl-9: #569CD6;
--light-hl-10: #0070C1;
--dark-hl-10: #4FC1FF;
--light-hl-11: #001080;
--dark-hl-11: #9CDCFE;
--light-hl-12: #098658;
--dark-hl-12: #B5CEA8;
--light-hl-13: #267F99;
Expand Down
6 changes: 3 additions & 3 deletions docs/api/classes/Accidental.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -847,14 +847,14 @@ <h3 class="tsd-anchor-link"><span>set<wbr/>Style</span><a href="#setStyle" aria-
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Set the element style used to render.</p>
<p>Example:</p>
<pre><code class="language-typescript"><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">setStyle</span><span class="hl-6">({ </span><span class="hl-10">fillStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">, </span><span class="hl-10">strokeStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6"> });</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">draw</span><span class="hl-6">();</span>
<pre><code class="language-typescript"><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">setStyle</span><span class="hl-7">({ </span><span class="hl-11">fillStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">, </span><span class="hl-11">strokeStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7"> });</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">draw</span><span class="hl-7">();</span>
</code><button>Copy</button></pre>
<p>Note: If the element draws additional sub-elements (ie.: Modifiers in a Stave),
the style can be applied to all of them by means of the context:</p>
<pre><code class="language-typescript"><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">setStyle</span><span class="hl-6">({ </span><span class="hl-10">fillStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">, </span><span class="hl-10">strokeStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6"> });</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">getContext</span><span class="hl-6">().</span><span class="hl-11">setFillStyle</span><span class="hl-6">(</span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">);</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">getContext</span><span class="hl-6">().</span><span class="hl-11">setStrokeStyle</span><span class="hl-6">(</span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">);</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">draw</span><span class="hl-6">();</span>
<pre><code class="language-typescript"><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">setStyle</span><span class="hl-7">({ </span><span class="hl-11">fillStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">, </span><span class="hl-11">strokeStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7"> });</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">getContext</span><span class="hl-7">().</span><span class="hl-6">setFillStyle</span><span class="hl-7">(</span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">);</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">getContext</span><span class="hl-7">().</span><span class="hl-6">setStrokeStyle</span><span class="hl-7">(</span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">);</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">draw</span><span class="hl-7">();</span>
</code><button>Copy</button></pre>
<p>or using drawWithStyle:</p>
<pre><code class="language-typescript"><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">setStyle</span><span class="hl-6">({ </span><span class="hl-10">fillStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">, </span><span class="hl-10">strokeStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6"> });</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">drawWithStyle</span><span class="hl-6">();</span>
<pre><code class="language-typescript"><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">setStyle</span><span class="hl-7">({ </span><span class="hl-11">fillStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">, </span><span class="hl-11">strokeStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7"> });</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">drawWithStyle</span><span class="hl-7">();</span>
</code><button>Copy</button></pre>
</div>
<div class="tsd-parameters">
Expand Down
6 changes: 3 additions & 3 deletions docs/api/classes/Annotation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,14 +866,14 @@ <h3 class="tsd-anchor-link"><span>set<wbr/>Style</span><a href="#setStyle" aria-
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Set the element style used to render.</p>
<p>Example:</p>
<pre><code class="language-typescript"><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">setStyle</span><span class="hl-6">({ </span><span class="hl-10">fillStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">, </span><span class="hl-10">strokeStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6"> });</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">draw</span><span class="hl-6">();</span>
<pre><code class="language-typescript"><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">setStyle</span><span class="hl-7">({ </span><span class="hl-11">fillStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">, </span><span class="hl-11">strokeStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7"> });</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">draw</span><span class="hl-7">();</span>
</code><button>Copy</button></pre>
<p>Note: If the element draws additional sub-elements (ie.: Modifiers in a Stave),
the style can be applied to all of them by means of the context:</p>
<pre><code class="language-typescript"><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">setStyle</span><span class="hl-6">({ </span><span class="hl-10">fillStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">, </span><span class="hl-10">strokeStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6"> });</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">getContext</span><span class="hl-6">().</span><span class="hl-11">setFillStyle</span><span class="hl-6">(</span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">);</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">getContext</span><span class="hl-6">().</span><span class="hl-11">setStrokeStyle</span><span class="hl-6">(</span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">);</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">draw</span><span class="hl-6">();</span>
<pre><code class="language-typescript"><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">setStyle</span><span class="hl-7">({ </span><span class="hl-11">fillStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">, </span><span class="hl-11">strokeStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7"> });</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">getContext</span><span class="hl-7">().</span><span class="hl-6">setFillStyle</span><span class="hl-7">(</span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">);</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">getContext</span><span class="hl-7">().</span><span class="hl-6">setStrokeStyle</span><span class="hl-7">(</span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">);</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">draw</span><span class="hl-7">();</span>
</code><button>Copy</button></pre>
<p>or using drawWithStyle:</p>
<pre><code class="language-typescript"><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">setStyle</span><span class="hl-6">({ </span><span class="hl-10">fillStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">, </span><span class="hl-10">strokeStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6"> });</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">drawWithStyle</span><span class="hl-6">();</span>
<pre><code class="language-typescript"><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">setStyle</span><span class="hl-7">({ </span><span class="hl-11">fillStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">, </span><span class="hl-11">strokeStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7"> });</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">drawWithStyle</span><span class="hl-7">();</span>
</code><button>Copy</button></pre>
</div>
<div class="tsd-parameters">
Expand Down
6 changes: 3 additions & 3 deletions docs/api/classes/Articulation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -853,14 +853,14 @@ <h3 class="tsd-anchor-link"><span>set<wbr/>Style</span><a href="#setStyle" aria-
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Set the element style used to render.</p>
<p>Example:</p>
<pre><code class="language-typescript"><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">setStyle</span><span class="hl-6">({ </span><span class="hl-10">fillStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">, </span><span class="hl-10">strokeStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6"> });</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">draw</span><span class="hl-6">();</span>
<pre><code class="language-typescript"><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">setStyle</span><span class="hl-7">({ </span><span class="hl-11">fillStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">, </span><span class="hl-11">strokeStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7"> });</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">draw</span><span class="hl-7">();</span>
</code><button>Copy</button></pre>
<p>Note: If the element draws additional sub-elements (ie.: Modifiers in a Stave),
the style can be applied to all of them by means of the context:</p>
<pre><code class="language-typescript"><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">setStyle</span><span class="hl-6">({ </span><span class="hl-10">fillStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">, </span><span class="hl-10">strokeStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6"> });</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">getContext</span><span class="hl-6">().</span><span class="hl-11">setFillStyle</span><span class="hl-6">(</span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">);</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">getContext</span><span class="hl-6">().</span><span class="hl-11">setStrokeStyle</span><span class="hl-6">(</span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">);</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">draw</span><span class="hl-6">();</span>
<pre><code class="language-typescript"><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">setStyle</span><span class="hl-7">({ </span><span class="hl-11">fillStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">, </span><span class="hl-11">strokeStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7"> });</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">getContext</span><span class="hl-7">().</span><span class="hl-6">setFillStyle</span><span class="hl-7">(</span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">);</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">getContext</span><span class="hl-7">().</span><span class="hl-6">setStrokeStyle</span><span class="hl-7">(</span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">);</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">draw</span><span class="hl-7">();</span>
</code><button>Copy</button></pre>
<p>or using drawWithStyle:</p>
<pre><code class="language-typescript"><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">setStyle</span><span class="hl-6">({ </span><span class="hl-10">fillStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6">, </span><span class="hl-10">strokeStyle:</span><span class="hl-6"> </span><span class="hl-7">&#39;red&#39;</span><span class="hl-6"> });</span><br/><span class="hl-10">element</span><span class="hl-6">.</span><span class="hl-11">drawWithStyle</span><span class="hl-6">();</span>
<pre><code class="language-typescript"><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">setStyle</span><span class="hl-7">({ </span><span class="hl-11">fillStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7">, </span><span class="hl-11">strokeStyle:</span><span class="hl-7"> </span><span class="hl-8">&#39;red&#39;</span><span class="hl-7"> });</span><br/><span class="hl-11">element</span><span class="hl-7">.</span><span class="hl-6">drawWithStyle</span><span class="hl-7">();</span>
</code><button>Copy</button></pre>
</div>
<div class="tsd-parameters">
Expand Down
Loading
Loading