@tspro/web-music-score 3.2.0 → 4.0.1

package/dist/react-ui/index.d.ts

@@ -1,10 +1,10 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
-import { c as Scale, S as ScaleType } from '../scale-ebJm37q1.js';
-import { b as PitchNotation, G as GuitarNoteLabel, N as Note } from '../note-BFa43I86.js';
-import { H as Handedness } from '../guitar-C2Cp71NZ.js';
-import { D as DivRect, M as MDocument, i as ScoreEventListener, W as MRenderer, X as MPlaybackButtons } from '../interface-BlNl69uT.js';
-import '../tempo-DgqDEsn0.js';
+import { c as Scale, S as ScaleType } from '../scale-B2Icbetz.js';
+import { b as PitchNotation, G as GuitarNoteLabel, N as Note } from '../note-eA2xPPiG.js';
+import { H as Handedness } from '../guitar-CaZJDA05.js';
+import { D as DivRect, M as MDocument, l as ScoreEventListener, n as MRenderer, o as MPlaybackButtons } from '../music-objects-Dc3kR-XF.js';
+import '../tempo-Dt8aHpol.js';
 import '@tspro/ts-utils-lib';
 
 interface CircleOfFifthsProps {
@@ -12,61 +12,167 @@ interface CircleOfFifthsProps {
     scale: Scale;
     onScaleChange: (scale: Scale) => void;
 }
+/**
+ * Circle of fifths react component.
+ * <pre>
+ *   // Using with React TSX/JSX
+ *   import * as ScoreUI from "@tspro/web-music-score/react-ui";
+ *   import * as Theory from "@tspro/web-music-score/theory";
+ *
+ *   // Render function of react component.
+ *   render() {
+ *       const curScale = Theory.getScale("C Major");
+ *
+ *       const onChangeScale = (newScale: Theory.Scale) => {
+ *           console.log("New scale is " + newScale.getScaleName());
+ *       }
+ *
+ *       return &lt;&gt;
+ *          &lt;ScoreUI.CircleOfFifths
+ *              style={{ position: "relative", padding: "0.5em" }}
+ *              scale={curScale}
+ *              onScaleChange={onChangeScale} /&gt;
+ *      &lt;/&gt;;
+ *   }
+ * </pre>
+ */
 declare class CircleOfFifths extends React.Component<CircleOfFifthsProps, {}> {
     constructor(props: CircleOfFifthsProps);
     onScaleChange(tonic: string, scaleType: ScaleType): void;
     render(): react_jsx_runtime.JSX.Element;
 }
 
+/** Fret position props. */
 declare class FretPosition {
     readonly guitarCtx: GuitarContext;
     readonly stringId: number;
     readonly fretId: number;
     readonly chromaticId: number;
+    /** Note of this fret position. */
     readonly note: Note;
+    /** Is note of this fret position a scale note? */
     readonly isScaleNote: boolean;
+    /** Is note of this fret position a scale root note? */
     readonly isScaleRootNote: boolean;
+    /** Is note circle/text of this fret position visible? */
     isVisible: boolean;
+    /** Text (e.g. note name) of this fret position. */
     text: string;
+    /** Text color. */
     textColor: string;
+    /** Fill color of note circle. */
     fillColor: string | undefined;
+    /** Border color of note circle. */
     borderColor: string | undefined;
+    /** Is barre? (Reserved for future) */
     isBarre: boolean;
+    /**
+     * Create new fret position object instance.
+     * @param guitarCtx - Guitar context.
+     * @param stringId - String index in range [0, 5].
+     * @param fretId - Fret index, 0 = open string fret position.
+     * @param chromaticId - Chromatic id.
+     */
     constructor(guitarCtx: GuitarContext, stringId: number, fretId: number, chromaticId: number);
+    /** Chromatic class getter. */
     get chromaticClass(): number;
+    /** Show note circle/text of this fret position. */
     show(): void;
+    /** Hide note circle/text of this fret position. */
     hide(): void;
+    /** Set default note name. */
     setDefaultText(): void;
+    /** Set default fill color of note circle. */
     setDefaultFillColor(): void;
+    /** Set default border color of note circle. */
     setDefaultBorderColor(showBorder?: boolean): void;
 }
+/** Guitar context class. */
 declare class GuitarContext {
     readonly tuningName: string;
     readonly scale: Scale;
     readonly handedness: Handedness;
     readonly pitchNotation: PitchNotation;
     readonly guitarNoteLabel: GuitarNoteLabel;
+    /** Maximum fret index value. */
     readonly maxFretId: number;
     private readonly fretPositionTable;
     private readonly tuningStrings;
+    /**
+     * Create new guitar context object instance.
+     * @param tuningName - Tuning name (e.g. "Standard").
+     * @param scale - Scale.
+     * @param handedness - Handedness.
+     * @param pitchNotation - Pitch notation.
+     * @param guitarNoteLabel - Guitar note label type.
+     */
     constructor(tuningName: string, scale: Scale, handedness: Handedness, pitchNotation: PitchNotation, guitarNoteLabel: GuitarNoteLabel);
+    /**
+     * Get fret position object.
+     * @param stringId - String index in range [0,5].
+     * @param fretId - Fret index, 0 = open string fret position.
+     * @returns - Fret position object.
+     */
     getFretPosition(stringId: number, fretId: number): Readonly<FretPosition>;
+    /**
+     * Get tuning value (Note) of given string.
+     * @param stringId - STring index in range [0, 5].
+     * @returns - Note of given string played unfretted.
+     */
     getStringTuning(stringId: number): Note;
+    /**
+     * Get tuning overview (e.g. "E2 - A2 - D3 - G3 - B3 - E4").
+     * @returns - Tuning overview string.
+     */
     getTuningOverview(): string;
+    /**
+     * Create copy of this guitar context with new tuning name.
+     * @param tuningName - New tuning name.
+     * @returns - Guitar context.
+     */
     alterTuningName(tuningName: string): GuitarContext;
+    /**
+     * Create copy of this guitar context with new scale.
+     * @param scale - New scale.
+     * @returns - Guitar context.
+     */
     alterScale(scale: Scale): GuitarContext;
+    /**
+     * Create copy of this guitar context with handedness.
+     * @param handedness - New handedness.
+     * @returns - Guitar context.
+     */
     alterHandedness(handedness: Handedness): GuitarContext;
+    /**
+     * Create copy of this guitar context with new pitch notation.
+     * @param pitchNotation - New pitch notation.
+     * @returns - Guitar context.
+     */
     alterPitchNotation(pitchNotation: PitchNotation): GuitarContext;
+    /**
+     * Create copy of this guitar context with new guitar note label type.
+     * @param guitarNoteLabel - New guitar note label type.
+     * @returns - Guitar context.
+     */
     alterGuitarNoteLabel(guitarNoteLabel: GuitarNoteLabel): GuitarContext;
 }
 
+/** Data for fret position. */
 declare class FretPositionData {
     readonly fretPosition: Readonly<FretPosition>;
     readonly cellRect: DivRect;
     readonly noteRect: DivRect;
+    /**
+     * Create new fret position data instance.
+     * @param fretPosition - Fret position.
+     * @param cellRect - Rect of fret position cell (space around string and between fret and next fret).
+     * @param noteRect - Rect to display note name in circle.
+     */
     constructor(fretPosition: Readonly<FretPosition>, cellRect: DivRect, noteRect: DivRect);
 }
+/** Update fret position function type. */
 type UpdateFretPositionFunc = (fretPosition: FretPosition) => void;
+/** Click fret position function type. */
 type ClickFretPositionFunc = (fretPosition: FretPosition) => void;
 interface GuitarViewProps {
     style?: React.CSSProperties;
@@ -79,6 +185,35 @@ interface GuitarViewState {
     height: number;
     table: FretPositionData[][];
 }
+/**
+ * Guitar (neck) view react component.
+ * <pre>
+ *   // Using with React TSX/JSX
+ *   import * as ScoreUI from "@tspro/web-music-score/react-ui";
+ *   import * as Theory from "@tspro/web-music-score/theory";
+ *
+ *   // Render function of react component.
+ *   render() {
+ *       const guitarCtx = new ScoreUI.GuitarContext(
+ *           "Standard",                     // Tuning name.
+ *           Theory.getScale("C Major"),     // Scale.
+ *           Theory.DefaultHandedness,       // Guitar handedness.
+ *           Theory.DefaultPitchNotation,    // Pitch notation.
+ *           Theory.DefaultGuitarNoteLabel); // Guitar note label type.
+ *
+ *       const onUpdateFretPosition: ScoreUI.UpdateFretPositionFunc = (fretPos) => { }
+ *       const onClickFretPosition: ScoreUI.ClickFretPositionFunc = (fretPos) => { }
+ *
+ *       return &lt;&gt;
+ *           &lt;ScoreUI.GuitarView
+ *               style={{ position: "relative", width: 640 }}
+ *               guitarContext={guitarCtx}
+ *               onUpdateFretPosition={onUpdateFretPosition}
+ *               onClickFretPosition={onClickFretPosition} /&gt;
+ *      &lt;/&gt;;
+ *   }
+ * </pre>
+ */
 declare class GuitarView extends React.Component<GuitarViewProps, GuitarViewState> {
     state: GuitarViewState;
     constructor(props: GuitarViewProps);
@@ -98,11 +233,21 @@ interface MusicScoreViewProps {
     onScoreEvent?: ScoreEventListener;
 }
 /**
- * Usage:
+ * Music score view react component.
+ * <pre>
+ *   // Using with React TSX/JSX
+ *   import * as Score from "@tspro/web-music-score/react";
+ *   import * as Pieces from "@tspro/web-music-score/pieces";
  *
- *  import * as Score from "\@tspro/web-music-score";
+ *   // Render function of react component.
+ *   render() {
+ *       const doc = Pieces.createFrereJacques();
  *
- *  \<Score.MusicScoreView doc=\{doc\} /\>
+ *       return &lt;&gt;
+ *          &lt;Score.MusicScoreView doc=\{doc\} /&gt;
+ *       &lt;/&gt;;
+ *   }
+ * </pre>
  */
 declare class MusicScoreView extends React.Component<MusicScoreViewProps, {}> {
     renderer: MRenderer;
@@ -128,19 +273,23 @@ interface PlaybackButtonsState {
 }
 /**
  * Usage:
+ * <pre>
+ *   // Using with React TSX/JSX
+ *   import * as Score from "\@tspro/web-music-score/score";
+ *   import * as Pieces from "@tspro/web-music-score/pieces";
  *
- *  import * as Score from "\@tspro/web-music-score";
- *
- *  \<Score.PlaybackButtons doc=\{doc\} /\>
- *
- * To set custom play, pause and stop labels:
- *
- *  \<Score.PlaybackButtons doc=\{doc\} playLabel="⏵" pauseLabel="⏸" stopLabel="⏹" /\>
+ *   // Create sample musicdocument.
+ *   const doc = Pieces.createFrereJacques();
  *
- * To use different button layout.
+ *   // Create default playback buttons
+ *   &lt;Score.PlaybackButtons doc={doc} /&gt;
  *
- *  \<Score.PlaybackButtons doc=\{doc\} buttonLayout=\{Score.PlaybackButtonsLayout.PlayStopSingle\} /\>
+ *   // Create playback buttons with custom play, pause and stop labels:
+ *   &lt;Score.PlaybackButtons doc={doc} playLabel="⏵" pauseLabel="⏸" stopLabel="⏹" /&gt;
  *
+ *   // Create playback buttons with different button layout.
+ *   &lt;Score.PlaybackButtons doc={doc} buttonLayout={Score.PlaybackButtonsLayout.PlayStopSingle} /&gt;
+ * </pre>
  */
 declare class PlaybackButtons extends React.Component<PlaybackButtonsProps, PlaybackButtonsState> {
     state: PlaybackButtonsState;

package/dist/react-ui/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v3.2.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -200,34 +200,54 @@ var DefaultColors = {
   TextColor: "white"
 };
 var FretPosition = class {
+  /**
+   * Create new fret position object instance.
+   * @param guitarCtx - Guitar context.
+   * @param stringId - String index in range [0, 5].
+   * @param fretId - Fret index, 0 = open string fret position.
+   * @param chromaticId - Chromatic id.
+   */
   constructor(guitarCtx, stringId, fretId, chromaticId) {
     this.guitarCtx = guitarCtx;
     this.stringId = stringId;
     this.fretId = fretId;
     this.chromaticId = chromaticId;
+    /** Note of this fret position. */
     __publicField(this, "note");
+    /** Is note of this fret position a scale note? */
     __publicField(this, "isScaleNote");
+    /** Is note of this fret position a scale root note? */
     __publicField(this, "isScaleRootNote");
+    /** Is note circle/text of this fret position visible? */
     __publicField(this, "isVisible", false);
+    /** Text (e.g. note name) of this fret position. */
     __publicField(this, "text", "");
+    /** Text color. */
     __publicField(this, "textColor", DefaultColors.TextColor);
+    /** Fill color of note circle. */
     __publicField(this, "fillColor");
+    /** Border color of note circle. */
     __publicField(this, "borderColor");
+    /** Is barre? (Reserved for future) */
     __publicField(this, "isBarre", false);
     let { scale } = guitarCtx;
     this.note = scale.getPreferredChromaticNote(chromaticId);
     this.isScaleNote = scale.isScaleNote(this.note);
     this.isScaleRootNote = scale.isScaleRootNote(this.note);
   }
+  /** Chromatic class getter. */
   get chromaticClass() {
     return import_theory3.Note.getChromaticClass(this.chromaticId);
   }
+  /** Show note circle/text of this fret position. */
   show() {
     this.isVisible = true;
   }
+  /** Hide note circle/text of this fret position. */
   hide() {
     this.isVisible = false;
   }
+  /** Set default note name. */
   setDefaultText() {
     let { pitchNotation, scale, guitarNoteLabel } = this.guitarCtx;
     switch (guitarNoteLabel) {
@@ -242,20 +262,31 @@ var FretPosition = class {
         break;
     }
   }
+  /** Set default fill color of note circle. */
   setDefaultFillColor() {
     this.fillColor = this.isScaleRootNote ? DefaultColors.ScaleRootNoteColor : this.isScaleNote ? DefaultColors.ScaleNoteColor : DefaultColors.NonScaleNoteColor;
   }
+  /** Set default border color of note circle. */
   setDefaultBorderColor(showBorder = false) {
     this.borderColor = showBorder ? DefaultColors.DefaultBorderColor : void 0;
   }
 };
 var GuitarContext = class _GuitarContext {
+  /**
+   * Create new guitar context object instance.
+   * @param tuningName - Tuning name (e.g. "Standard").
+   * @param scale - Scale.
+   * @param handedness - Handedness.
+   * @param pitchNotation - Pitch notation.
+   * @param guitarNoteLabel - Guitar note label type.
+   */
   constructor(tuningName, scale, handedness, pitchNotation, guitarNoteLabel) {
     this.tuningName = tuningName;
     this.scale = scale;
     this.handedness = handedness;
     this.pitchNotation = pitchNotation;
     this.guitarNoteLabel = guitarNoteLabel;
+    /** Maximum fret index value. */
     __publicField(this, "maxFretId");
     __publicField(this, "fretPositionTable");
     __publicField(this, "tuningStrings");
@@ -270,6 +301,12 @@ var GuitarContext = class _GuitarContext {
       }
     }
   }
+  /**
+   * Get fret position object.
+   * @param stringId - String index in range [0,5].
+   * @param fretId - Fret index, 0 = open string fret position.
+   * @returns - Fret position object.
+   */
   getFretPosition(stringId, fretId) {
     if (!import_ts_utils_lib2.Utils.Is.isInteger(stringId) || stringId < 0 || stringId > 5) {
       throw new import_core.MusicError(import_core.MusicErrorType.InvalidArg, `Invalid stringId: + ${stringId}`);
@@ -279,24 +316,58 @@ var GuitarContext = class _GuitarContext {
       return this.fretPositionTable[stringId][fretId];
     }
   }
+  /**
+   * Get tuning value (Note) of given string.
+   * @param stringId - STring index in range [0, 5].
+   * @returns - Note of given string played unfretted.
+   */
   getStringTuning(stringId) {
     return this.tuningStrings[stringId];
   }
+  /**
+   * Get tuning overview (e.g. "E2 - A2 - D3 - G3 - B3 - E4").
+   * @returns - Tuning overview string.
+   */
   getTuningOverview() {
     return this.tuningStrings.slice().reverse().map((note) => note.format(this.pitchNotation, import_theory2.SymbolSet.Unicode)).join(" - ");
   }
+  /**
+   * Create copy of this guitar context with new tuning name.
+   * @param tuningName - New tuning name.
+   * @returns - Guitar context.
+   */
   alterTuningName(tuningName) {
     return tuningName === this.tuningName ? this : new _GuitarContext(tuningName, this.scale, this.handedness, this.pitchNotation, this.guitarNoteLabel);
   }
+  /**
+   * Create copy of this guitar context with new scale.
+   * @param scale - New scale.
+   * @returns - Guitar context.
+   */
   alterScale(scale) {
     return import_theory3.Scale.equals(scale, this.scale) ? this : new _GuitarContext(this.tuningName, scale, this.handedness, this.pitchNotation, this.guitarNoteLabel);
   }
+  /**
+   * Create copy of this guitar context with handedness.
+   * @param handedness - New handedness.
+   * @returns - Guitar context.
+   */
   alterHandedness(handedness) {
     return handedness === this.handedness ? this : new _GuitarContext(this.tuningName, this.scale, handedness, this.pitchNotation, this.guitarNoteLabel);
   }
+  /**
+   * Create copy of this guitar context with new pitch notation.
+   * @param pitchNotation - New pitch notation.
+   * @returns - Guitar context.
+   */
   alterPitchNotation(pitchNotation) {
     return pitchNotation === this.pitchNotation ? this : new _GuitarContext(this.tuningName, this.scale, this.handedness, pitchNotation, this.guitarNoteLabel);
   }
+  /**
+   * Create copy of this guitar context with new guitar note label type.
+   * @param guitarNoteLabel - New guitar note label type.
+   * @returns - Guitar context.
+   */
   alterGuitarNoteLabel(guitarNoteLabel) {
     return guitarNoteLabel === this.guitarNoteLabel ? this : new _GuitarContext(this.tuningName, this.scale, this.handedness, this.pitchNotation, guitarNoteLabel);
   }
@@ -370,6 +441,12 @@ var Fret = class _Fret {
   }
 };
 var FretPositionData = class {
+  /**
+   * Create new fret position data instance.
+   * @param fretPosition - Fret position.
+   * @param cellRect - Rect of fret position cell (space around string and between fret and next fret).
+   * @param noteRect - Rect to display note name in circle.
+   */
   constructor(fretPosition, cellRect, noteRect) {
     this.fretPosition = fretPosition;
     this.cellRect = cellRect;

package/dist/react-ui/index.mjs

@@ -1,7 +1,7 @@
-/* WebMusicScore v3.2.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-LCTM7BID.mjs";
+} from "../chunk-YFPLOHP2.mjs";
 
 // src/react-ui/circle-of-fifths.tsx
 import * as React from "react";
@@ -159,34 +159,54 @@ var DefaultColors = {
   TextColor: "white"
 };
 var FretPosition = class {
+  /**
+   * Create new fret position object instance.
+   * @param guitarCtx - Guitar context.
+   * @param stringId - String index in range [0, 5].
+   * @param fretId - Fret index, 0 = open string fret position.
+   * @param chromaticId - Chromatic id.
+   */
   constructor(guitarCtx, stringId, fretId, chromaticId) {
     this.guitarCtx = guitarCtx;
     this.stringId = stringId;
     this.fretId = fretId;
     this.chromaticId = chromaticId;
+    /** Note of this fret position. */
     __publicField(this, "note");
+    /** Is note of this fret position a scale note? */
     __publicField(this, "isScaleNote");
+    /** Is note of this fret position a scale root note? */
     __publicField(this, "isScaleRootNote");
+    /** Is note circle/text of this fret position visible? */
     __publicField(this, "isVisible", false);
+    /** Text (e.g. note name) of this fret position. */
     __publicField(this, "text", "");
+    /** Text color. */
     __publicField(this, "textColor", DefaultColors.TextColor);
+    /** Fill color of note circle. */
     __publicField(this, "fillColor");
+    /** Border color of note circle. */
     __publicField(this, "borderColor");
+    /** Is barre? (Reserved for future) */
     __publicField(this, "isBarre", false);
     let { scale } = guitarCtx;
     this.note = scale.getPreferredChromaticNote(chromaticId);
     this.isScaleNote = scale.isScaleNote(this.note);
     this.isScaleRootNote = scale.isScaleRootNote(this.note);
   }
+  /** Chromatic class getter. */
   get chromaticClass() {
     return Note2.getChromaticClass(this.chromaticId);
   }
+  /** Show note circle/text of this fret position. */
   show() {
     this.isVisible = true;
   }
+  /** Hide note circle/text of this fret position. */
   hide() {
     this.isVisible = false;
   }
+  /** Set default note name. */
   setDefaultText() {
     let { pitchNotation, scale, guitarNoteLabel } = this.guitarCtx;
     switch (guitarNoteLabel) {
@@ -201,20 +221,31 @@ var FretPosition = class {
         break;
     }
   }
+  /** Set default fill color of note circle. */
   setDefaultFillColor() {
     this.fillColor = this.isScaleRootNote ? DefaultColors.ScaleRootNoteColor : this.isScaleNote ? DefaultColors.ScaleNoteColor : DefaultColors.NonScaleNoteColor;
   }
+  /** Set default border color of note circle. */
   setDefaultBorderColor(showBorder = false) {
     this.borderColor = showBorder ? DefaultColors.DefaultBorderColor : void 0;
   }
 };
 var GuitarContext = class _GuitarContext {
+  /**
+   * Create new guitar context object instance.
+   * @param tuningName - Tuning name (e.g. "Standard").
+   * @param scale - Scale.
+   * @param handedness - Handedness.
+   * @param pitchNotation - Pitch notation.
+   * @param guitarNoteLabel - Guitar note label type.
+   */
   constructor(tuningName, scale, handedness, pitchNotation, guitarNoteLabel) {
     this.tuningName = tuningName;
     this.scale = scale;
     this.handedness = handedness;
     this.pitchNotation = pitchNotation;
     this.guitarNoteLabel = guitarNoteLabel;
+    /** Maximum fret index value. */
     __publicField(this, "maxFretId");
     __publicField(this, "fretPositionTable");
     __publicField(this, "tuningStrings");
@@ -229,6 +260,12 @@ var GuitarContext = class _GuitarContext {
       }
     }
   }
+  /**
+   * Get fret position object.
+   * @param stringId - String index in range [0,5].
+   * @param fretId - Fret index, 0 = open string fret position.
+   * @returns - Fret position object.
+   */
   getFretPosition(stringId, fretId) {
     if (!Utils2.Is.isInteger(stringId) || stringId < 0 || stringId > 5) {
       throw new MusicError(MusicErrorType.InvalidArg, `Invalid stringId: + ${stringId}`);
@@ -238,24 +275,58 @@ var GuitarContext = class _GuitarContext {
       return this.fretPositionTable[stringId][fretId];
     }
   }
+  /**
+   * Get tuning value (Note) of given string.
+   * @param stringId - STring index in range [0, 5].
+   * @returns - Note of given string played unfretted.
+   */
   getStringTuning(stringId) {
     return this.tuningStrings[stringId];
   }
+  /**
+   * Get tuning overview (e.g. "E2 - A2 - D3 - G3 - B3 - E4").
+   * @returns - Tuning overview string.
+   */
   getTuningOverview() {
     return this.tuningStrings.slice().reverse().map((note) => note.format(this.pitchNotation, SymbolSet2.Unicode)).join(" - ");
   }
+  /**
+   * Create copy of this guitar context with new tuning name.
+   * @param tuningName - New tuning name.
+   * @returns - Guitar context.
+   */
   alterTuningName(tuningName) {
     return tuningName === this.tuningName ? this : new _GuitarContext(tuningName, this.scale, this.handedness, this.pitchNotation, this.guitarNoteLabel);
   }
+  /**
+   * Create copy of this guitar context with new scale.
+   * @param scale - New scale.
+   * @returns - Guitar context.
+   */
   alterScale(scale) {
     return Scale2.equals(scale, this.scale) ? this : new _GuitarContext(this.tuningName, scale, this.handedness, this.pitchNotation, this.guitarNoteLabel);
   }
+  /**
+   * Create copy of this guitar context with handedness.
+   * @param handedness - New handedness.
+   * @returns - Guitar context.
+   */
   alterHandedness(handedness) {
     return handedness === this.handedness ? this : new _GuitarContext(this.tuningName, this.scale, handedness, this.pitchNotation, this.guitarNoteLabel);
   }
+  /**
+   * Create copy of this guitar context with new pitch notation.
+   * @param pitchNotation - New pitch notation.
+   * @returns - Guitar context.
+   */
   alterPitchNotation(pitchNotation) {
     return pitchNotation === this.pitchNotation ? this : new _GuitarContext(this.tuningName, this.scale, this.handedness, pitchNotation, this.guitarNoteLabel);
   }
+  /**
+   * Create copy of this guitar context with new guitar note label type.
+   * @param guitarNoteLabel - New guitar note label type.
+   * @returns - Guitar context.
+   */
   alterGuitarNoteLabel(guitarNoteLabel) {
     return guitarNoteLabel === this.guitarNoteLabel ? this : new _GuitarContext(this.tuningName, this.scale, this.handedness, this.pitchNotation, guitarNoteLabel);
   }
@@ -329,6 +400,12 @@ var Fret = class _Fret {
   }
 };
 var FretPositionData = class {
+  /**
+   * Create new fret position data instance.
+   * @param fretPosition - Fret position.
+   * @param cellRect - Rect of fret position cell (space around string and between fret and next fret).
+   * @param noteRect - Rect to display note name in circle.
+   */
   constructor(fretPosition, cellRect, noteRect) {
     this.fretPosition = fretPosition;
     this.cellRect = cellRect;