@tspro/web-music-score 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [3.1.0] - 2025-09-09
+## Added
+- Staff/TabConfig.name.
+- DocumentBuilder.addStaffGroup().
+- DocumentBuilder.addFermataTo(), .addNavigationTo(), .addAnnotationTo() and .addLabelTo().
+
+## [3.0.1] - 2025-09-03
+## Fixed
+- Draw arpeggio curly arrow also to guitar tab.
+
 ## [3.0.0] - 2025-08-31
 Major update and brought some important changes.
 ### ** Breaking Changes **

package/README.md

@@ -1,5 +1,9 @@
 # WebMusicScore
 
+Typedoc API Reference, Examples and Demos can be found [here](https://pahkasoft.github.io). The API Reference is not commented but is mostly self explanatory and gives idea of full API.
+
+## About
+
 This library allows you to view and play music scores (notation) in the browser.
 
 I'm not a professional musician. I began learning classical guitar on my own, 
@@ -88,9 +92,6 @@ and `Pieces` as corresponding subpath modules (excluding `react-ui` and `audio-c
 
 ## API
 
-Typedoc API reference is available [here](https://pahkasoft.github.io).
-It is not commented but is mostly self explanatory and gives idea of full API.
-
 Following is the main interface explained.
 
 ### Create DocumentBuilder
@@ -324,26 +325,6 @@ builder.addFermata(Score.Fermata.AtMeasureEnd);
 - `Score.Fermata.AtNote`: Adds fermata anchored to previously added note, chord or rest.
 - `Score.Fermata.AtMeasureEnd`: Adds fermata at the end of measure.
 
-### Add Connective (tie, slur)
-
-```js
-// Add tie
-builder.addConnective(connective: Score.Connetive.Tie, span?: Score.ConnectiveSpan, noteAnchor?: Score.NoteAnchor);
-
-// Add slur
-builder.addConnective(connective: Score.Connetive.Slur, span?: Score.ConnectiveSpan, noteAnchor?: Score.NoteAnchor);
-
-// Add slide
-builder.addConnective(connective: Score.Connetive.Slide, noteAnchor?: Score.NoteAnchor);
-```
-
-- `span` describes how many notes the connective is across.
-  It is integer >= 2 (for tie it can be also `Score.TieType.Stub|ToMeasureEnd`).
-  Default value is 2.
-- `noteAnchor` describes the attach point of connective to note.
-  It can be `Score.NoteAnchor.Auto|Above|Center|Below|StemTip`.
-  Default value is `Score.NoteAnchor.Auto`.
-
 ### Add Navigation
 
 Add navigational element to measure.
@@ -404,6 +385,47 @@ builder.addAnnotation(Score.Annotation.Tempo, "accel.");
 * `Score.Annotation.Dynamics`: `text` could be for example `"fff"`, `"cresc."`, `"dim."`, etc.
 * `Score.Annotation.Tempo`: `text` could be for example `"accel."`, `"rit."`, `"a tempo"`, etc.
 
+### Add Elements To Certain Staff Or Tab
+
+There are alternatives to these functions:
+- `addFermata` => `addFermataTo`
+- `addNavigation` => `addNavigationTo`
+- `addAnnotation` => `addAnnotationTo`
+- `addLabel` => `addLabelTo`.
+
+First argument of these alterate functions is:
+
+ `staffTabOrGroup: number | string | (number | string)[]`.
+
+It can be one of following things:
+- `number`: staff/tab index, 0=top staff/tab, etc.
+- `string`: staff/tab name.
+- `string`: staff group name.
+- Or an array of the above.
+
+```js
+// Example: add label to top staff/tab.
+builder.addLabelTo(0, Score.Label.Chord, "Am");
+```
+
+#### Staff Group
+```js
+builder.addStaffGroup(groupName: string, staffsTabsAndGroups: number | string | (number | string)[], verticalPosition: Score.VerticalPosition);
+```
+
+Arguments are:
+- `groupName`: Name of new staff group.
+- `staffsTabsAndGroups`: single value or an array of staves, tabs and groups (index or name).
+- `verticalPosition` (optional): Can be `Score.VerticalPosition.Above`/`Below`/`Both`/`Auto` (default).
+
+```js
+// Example: create staff group to add elements below top staff/tab.
+// Add staff group
+builder.addStaffGroup("grp1", [0], Score.VertocalPosition.Below);
+// Use group
+builder.addLabelTo("grp1", Score.Label.Note, "C");
+```
+
 ### Add Extension
 
 Adds extension line to element, for example to previously added annotation.
@@ -419,6 +441,26 @@ builder.addAnnotation(Score.Annotation.Tempo, "accel.").addExtension(Theory.Note
 
 `visible` sets visibility of extension line, visible by default (if omitted).
 
+### Add Connective (tie, slur, slide)
+
+```js
+// Add tie
+builder.addConnective(connective: Score.Connetive.Tie, span?: Score.ConnectiveSpan, noteAnchor?: Score.NoteAnchor);
+
+// Add slur
+builder.addConnective(connective: Score.Connetive.Slur, span?: Score.ConnectiveSpan, noteAnchor?: Score.NoteAnchor);
+
+// Add slide
+builder.addConnective(connective: Score.Connetive.Slide, noteAnchor?: Score.NoteAnchor);
+```
+
+- `span` describes how many notes the connective is across.
+  It is integer >= 2 (for tie it can be also `Score.TieType.Stub|ToMeasureEnd`).
+  Default value is 2.
+- `noteAnchor` describes the attach point of connective to note.
+  It can be `Score.NoteAnchor.Auto|Above|Center|Below|StemTip`.
+  Default value is `Score.NoteAnchor.Auto`.
+
 ### Guitar Tab
 
 This library has preliminary guitar tabs rendering. 

package/dist/audio/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v3.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;

package/dist/audio/index.mjs

@@ -1,7 +1,7 @@
-/* WebMusicScore v3.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-ZWFAOHYM.mjs";
+} from "../chunk-B4J3KED2.mjs";
 
 // src/audio/index.ts
 import { Note, PitchNotation, SymbolSet } from "@tspro/web-music-score/theory";

package/dist/audio-cg/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v3.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;

package/dist/audio-cg/index.mjs

@@ -1,7 +1,7 @@
-/* WebMusicScore v3.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-ZWFAOHYM.mjs";
+} from "../chunk-B4J3KED2.mjs";
 
 // src/audio-cg/index.ts
 import * as Tone from "tone";

package/dist/{chunk-ZWFAOHYM.mjs → chunk-B4J3KED2.mjs}

@@ -1,4 +1,4 @@
-/* WebMusicScore v3.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -6,4 +6,4 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 export {
   __publicField
 };
-//# sourceMappingURL=chunk-ZWFAOHYM.mjs.map
+//# sourceMappingURL=chunk-B4J3KED2.mjs.map

package/dist/core/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v3.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 "use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -61,7 +61,7 @@ function init() {
     return;
   }
   initialized = true;
-  console.log("%cWebMusicScore v3.0.0 (cjs) initialized.", "background: black; color: white; padding: 2px;");
+  console.log("%cWebMusicScore v3.1.0 (cjs) initialized.", "background: black; color: white; padding: 2px;");
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/core/index.mjs

@@ -1,7 +1,7 @@
-/* WebMusicScore v3.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-ZWFAOHYM.mjs";
+} from "../chunk-B4J3KED2.mjs";
 
 // src/core/error.ts
 var MusicErrorType = /* @__PURE__ */ ((MusicErrorType2) => {
@@ -35,7 +35,7 @@ function init() {
     return;
   }
   initialized = true;
-  console.log("%cWebMusicScore v3.0.0 (esm) initialized.", "background: black; color: white; padding: 2px;");
+  console.log("%cWebMusicScore v3.1.0 (esm) initialized.", "background: black; color: white; padding: 2px;");
 }
 export {
   MusicError,