web-music-score 6.0.0-pre.3 → 6.0.0-pre.4

package/dist/{music-objects-DLmp5uL6.d.ts → music-objects-ChAdqdR8.d.ts}

@@ -1251,6 +1251,7 @@ declare class RenderContext {
     private canvas?;
     private ctx?;
     private mdoc?;
+    private paint;
     private cursorRect?;
     private mousePos?;
     private curStaffPos?;
@@ -1269,6 +1270,8 @@ declare class RenderContext {
     private forceDraw;
     private onImageLoaded;
     setDocument(mdoc?: MDocument): void;
+    setPaint(paint?: Paint): void;
+    getPaint(): Paint;
     setCanvas(canvas: HTMLCanvasElement): void;
     setScoreEventListener(fn: ScoreEventListener): void;
     needMouseInput(): boolean;
@@ -1298,7 +1301,7 @@ declare class RenderContext {
     getRestRect(restSize: number): AnchoredRect;
     drawRest(restSize: number, x: number, y: number): void;
     drawFlag(rect: Rect | AnchoredRect, dir: "up" | "down"): void;
-    color(color: string): RenderContext;
+    color(color: string | ColorKey): RenderContext;
     lineColor(color: string): RenderContext;
     fillColor(color: string): RenderContext;
     lineWidth(lineWidth?: number): RenderContext;
@@ -1639,6 +1642,67 @@ declare class ScoreObjectEvent extends ScoreEvent {
 /** Score event listener type. */
 type ScoreEventListener = (event: ScoreEvent) => void;
 
+/** Color keys. */
+type ColorKey = "hilight.staffpos" | "hilight.object" | "play.cursor" | "background" | "header.title" | "header.composer" | "header.arranger" | "rowgroup.instrument" | "rowgroup.frame" | "staff.frame" | "staff.note" | "staff.rest" | "staff.lyrics" | "staff.connective" | "staff.signature.clef" | "staff.signature.key" | "staff.signature.time" | "staff.signature.tempo" | "staff.signature.measurenum" | "staff.element.fermata" | "staff.element.annotation" | "staff.element.navigation" | "staff.element.label" | "tab.frame" | "tab.note" | "tab.rest" | "tab.lyrics" | "tab.connective" | "tab.tuning" | "tab.signature.clef" | "tab.signature.key" | "tab.signature.time" | "tab.signature.tempo" | "tab.signature.measurenum" | "tab.element.fermata" | "tab.element.annotation" | "tab.element.navigation" | "tab.element.label";
+/** Function to typecheck a valid ColorKey variable. */
+declare function colorKey(colorKey: ColorKey): ColorKey;
+/** Color key parts. */
+type ColorKeyPart = "background" | "header" | "title" | "composer" | "arranger" | "rowgroup" | "instrument" | "frame" | "staff" | "tab" | "note" | "rest" | "lyrics" | "connective" | "signature" | "clef" | "key" | "time" | "tempo" | "measurenum" | "tuning" | "element" | "fermata" | "annotation" | "navigation" | "label";
+/**
+ * Paint class for coloring music scores.
+ */
+declare class Paint {
+    static readonly default: Paint;
+    colors: Record<ColorKey, string>;
+    /**
+     * Set color of any score document element. Use combination of color key parts to set color of specific elements.
+     * ```ts
+     * setColor("all", "red");                          // Set color of everything except background.
+     * setColor("staff", "red");                        // Set color of all staff elements.
+     * setColor(["staff", "signature"], "red");         // Set color of all staff signature elements.
+     * setColor(["staff", "signature", "key"], "red");  // Set color of staff key signature.
+     * setColor(["staff", "signature", "time"], "red"); // Set color of staff time signature.
+     * setColor("staff.signature.time", "red");         // Set color of staff time signature.
+     * // etc.
+     * ```
+     *
+     * @param colorKeyOrParts - Color key parts to set color for.
+     * @param color - Color (HTML color code e.g. "green", "#AA6644", etc.)
+     */
+    setColor(colorKeyOrParts: ColorKey | ColorKeyPart | ColorKeyPart[] | "all", color: string): void;
+    /**
+     * Get color.
+     * @param colorKeyOrColor - ColorKey or color.
+     * @returns - Color value (e.g. "white" or "#FFFFFF").
+     */
+    getColor(colorKeyOrColor: ColorKey | string): string;
+    /**
+     * Get color code.
+     * @param colorKeyOrColor - ColorKey or color.
+     * @returns - Color code (e.g. "#FFFFFF").
+     */
+    getColorCode(colorKeyOrColor: ColorKey | string): string;
+    /**
+     * Get color RGBA.
+     * @param colorKeyOrColor - ColorKey or color.
+     * @returns - Color RGBA (e.g. [1, 1, 1, 1]).
+     */
+    getColorRGBA(colorKeyOrColor: ColorKey | string): [number, number, number, number];
+    /**
+     * Convert color name to color code.
+     * @param colorName - Color name (e.g. "white").
+     * @returns - Color code (e.g. "#FFFFFF")
+     */
+    static colorNameToCode(colorName: string): string;
+    /**
+     * Convert color name ro RGBA.
+     * @param colorName - Color name (e.g. "white").
+     * @param alpha - Alpha value 0..1 (default is 1).
+     * @returns - RGBA (e.g. [1, 1, 1, 1]).
+     */
+    static colorNameToRGBA(colorName: string, alpha?: number): [number, number, number, number];
+}
+
 /** Music player class. */
 declare class MPlayer {
     private static currentlyPlaying;
@@ -1676,6 +1740,12 @@ declare class MRenderContext {
      * Create new render context instance.
      */
     constructor();
+    /**
+     * Set Paint for this render context.
+     * @param paint - Paint.
+     * @returns - This render context instance.
+     */
+    setPaint(paint?: Paint): this;
     /**
      * Attach music document to this render context.
      * @param doc - Music document.
@@ -2395,4 +2465,4 @@ declare class MExtensionLine extends MusicInterface {
     getMusicObject(): ObjExtensionLine;
 }
 
-export { MTabSignature as $, type AnnotationText as A, MHeader as B, Connective as C, MImage as D, MMeasure as E, Fermata as F, MBarLineRight as G, MBarLineLeft as H, MStaffBarLine as I, MNoteGroup as J, MStaffNoteGroup as K, type LyricsOptions as L, MDocument as M, type NoteOptions as N, MTabNoteGroup as O, MRest as P, MStaffRest as Q, type RestOptions as R, StaffPreset as S, type TupletOptions as T, MRhythmColumn as U, type VoiceId as V, MScoreRow as W, MScoreRowGroup as X, MStaff as Y, MTab as Z, MStaffSignature as _, type ScoreConfiguration as a, MTabRhythm as a0, MSpecialText as a1, MText as a2, MLyrics as a3, MExtensionLine as a4, Clef as a5, type BaseConfig as a6, type StaffConfig as a7, type TabConfig as a8, getVoiceIds as a9, isVoiceId as aa, validateVoiceId as ab, type StringNumber as ac, getStringNumbers as ad, isStringNumber as ae, validateStringNumber as af, getVerseNumbers as ag, isVerseNumber as ah, validateVerseNumber as ai, Stem as aj, Arpeggio as ak, type StaffTabOrGroup as al, LyricsAlign as am, LyricsHyphen as an, DynamicsAnnotation as ao, TempoAnnotation as ap, PlayState as aq, type PlayStateChangeListener as ar, type MeasureOptions as b, type VerseNumber as c, type StaffTabOrGroups as d, Navigation as e, Annotation as f, Label as g, TieType as h, NoteAnchor as i, VerticalPosition as j, type ScoreEventType as k, ScoreEvent as l, ScoreStaffPosEvent as m, ScoreObjectEvent as n, type ScoreEventListener as o, MPlayer as p, MRenderContext as q, MPlaybackButtons as r, MusicInterface as s, MAccidental as t, MConnective as u, MArpeggio as v, MBeamGroup as w, MStaffBeamGroup as x, MEnding as y, MFermata as z };
+export { MTabSignature as $, type AnnotationText as A, MHeader as B, Connective as C, MImage as D, MMeasure as E, Fermata as F, MBarLineRight as G, MBarLineLeft as H, MStaffBarLine as I, MNoteGroup as J, MStaffNoteGroup as K, type LyricsOptions as L, MDocument as M, type NoteOptions as N, MTabNoteGroup as O, MRest as P, MStaffRest as Q, type RestOptions as R, StaffPreset as S, type TupletOptions as T, MRhythmColumn as U, type VoiceId as V, MScoreRow as W, MScoreRowGroup as X, MStaff as Y, MTab as Z, MStaffSignature as _, type ScoreConfiguration as a, MTabRhythm as a0, MSpecialText as a1, MText as a2, MLyrics as a3, MExtensionLine as a4, type ColorKey as a5, colorKey as a6, type ColorKeyPart as a7, Paint as a8, Clef as a9, type BaseConfig as aa, type StaffConfig as ab, type TabConfig as ac, getVoiceIds as ad, isVoiceId as ae, validateVoiceId as af, type StringNumber as ag, getStringNumbers as ah, isStringNumber as ai, validateStringNumber as aj, getVerseNumbers as ak, isVerseNumber as al, validateVerseNumber as am, Stem as an, Arpeggio as ao, type StaffTabOrGroup as ap, LyricsAlign as aq, LyricsHyphen as ar, DynamicsAnnotation as as, TempoAnnotation as at, PlayState as au, type PlayStateChangeListener as av, type MeasureOptions as b, type VerseNumber as c, type StaffTabOrGroups as d, Navigation as e, Annotation as f, Label as g, TieType as h, NoteAnchor as i, VerticalPosition as j, type ScoreEventType as k, ScoreEvent as l, ScoreStaffPosEvent as m, ScoreObjectEvent as n, type ScoreEventListener as o, MPlayer as p, MRenderContext as q, MPlaybackButtons as r, MusicInterface as s, MAccidental as t, MConnective as u, MArpeggio as v, MBeamGroup as w, MStaffBeamGroup as x, MEnding as y, MFermata as z };

package/dist/pieces/index.d.ts

@@ -1,4 +1,4 @@
-import { M as MDocument } from '../music-objects-DLmp5uL6.js';
+import { M as MDocument } from '../music-objects-ChAdqdR8.js';
 import '../note-RVXvpfyV.js';
 import '../tempo-D-JF-8b_.js';
 import '@tspro/ts-utils-lib';

package/dist/pieces/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v6.0.0-pre.3 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
+/* WebMusicScore v6.0.0-pre.4 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
 "use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;

package/dist/pieces/index.mjs

@@ -1,5 +1,5 @@
-/* WebMusicScore v6.0.0-pre.3 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
-import "../chunk-QJ3X3GQ6.mjs";
+/* WebMusicScore v6.0.0-pre.4 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
+import "../chunk-GNFDJFUO.mjs";
 
 // src/pieces/andante-diabelli.ts
 import { DocumentBuilder } from "web-music-score/score";

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

@@ -1,12 +1,13 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
-import { M as MDocument, o as ScoreEventListener, r as MPlaybackButtons } from '../music-objects-DLmp5uL6.js';
+import { M as MDocument, a8 as Paint, o as ScoreEventListener, r as MPlaybackButtons } from '../music-objects-ChAdqdR8.js';
 import '../note-RVXvpfyV.js';
 import '../tempo-D-JF-8b_.js';
 import '@tspro/ts-utils-lib';
 
 interface MusicScoreViewProps {
     doc: MDocument;
+    paint?: Paint;
     onScoreEvent?: ScoreEventListener;
 }
 /**

package/dist/react-ui/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v6.0.0-pre.3 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
+/* WebMusicScore v6.0.0-pre.4 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -47,6 +47,8 @@ var MusicScoreView = class extends React.Component {
     super(props);
     __publicField(this, "ctx");
     this.ctx = new import_score.MRenderContext();
+    if (props.paint)
+      this.ctx.setPaint(props.paint);
     this.ctx.setDocument(props.doc);
     if (props.onScoreEvent) {
       this.ctx.setScoreEventListener(props.onScoreEvent);

package/dist/react-ui/index.mjs

@@ -1,7 +1,7 @@
-/* WebMusicScore v6.0.0-pre.3 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
+/* WebMusicScore v6.0.0-pre.4 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
 import {
   __publicField
-} from "../chunk-QJ3X3GQ6.mjs";
+} from "../chunk-GNFDJFUO.mjs";
 
 // src/react-ui/music-score-view.tsx
 import * as React from "react";
@@ -12,6 +12,8 @@ var MusicScoreView = class extends React.Component {
     super(props);
     __publicField(this, "ctx");
     this.ctx = new MRenderContext();
+    if (props.paint)
+      this.ctx.setPaint(props.paint);
     this.ctx.setDocument(props.doc);
     if (props.onScoreEvent) {
       this.ctx.setScoreEventListener(props.onScoreEvent);

package/dist/score/index.d.ts

@@ -1,58 +1,10 @@
-import { N as NoteOptions, R as RestOptions, S as StaffPreset, a as ScoreConfiguration, M as MDocument, b as MeasureOptions, V as VoiceId, T as TupletOptions, c as VerseNumber, L as LyricsOptions, d as StaffTabOrGroups, F as Fermata, e as Navigation, A as AnnotationText, f as Annotation, g as Label, C as Connective, h as TieType, i as NoteAnchor, j as VerticalPosition } from '../music-objects-DLmp5uL6.js';
-export { ak as Arpeggio, a6 as BaseConfig, a5 as Clef, ao as DynamicsAnnotation, am as LyricsAlign, an as LyricsHyphen, t as MAccidental, v as MArpeggio, H as MBarLineLeft, G as MBarLineRight, w as MBeamGroup, u as MConnective, y as MEnding, a4 as MExtensionLine, z as MFermata, B as MHeader, D as MImage, a3 as MLyrics, E as MMeasure, J as MNoteGroup, r as MPlaybackButtons, p as MPlayer, q as MRenderContext, P as MRest, U as MRhythmColumn, W as MScoreRow, X as MScoreRowGroup, a1 as MSpecialText, Y as MStaff, I as MStaffBarLine, x as MStaffBeamGroup, K as MStaffNoteGroup, Q as MStaffRest, _ as MStaffSignature, Z as MTab, O as MTabNoteGroup, a0 as MTabRhythm, $ as MTabSignature, a2 as MText, s as MusicInterface, aq as PlayState, ar as PlayStateChangeListener, l as ScoreEvent, o as ScoreEventListener, k as ScoreEventType, n as ScoreObjectEvent, m as ScoreStaffPosEvent, a7 as StaffConfig, al as StaffTabOrGroup, aj as Stem, ac as StringNumber, a8 as TabConfig, ap as TempoAnnotation, ad as getStringNumbers, ag as getVerseNumbers, a9 as getVoiceIds, ae as isStringNumber, ah as isVerseNumber, aa as isVoiceId, af as validateStringNumber, ai as validateVerseNumber, ab as validateVoiceId } from '../music-objects-DLmp5uL6.js';
+import { N as NoteOptions, R as RestOptions, S as StaffPreset, a as ScoreConfiguration, M as MDocument, b as MeasureOptions, V as VoiceId, T as TupletOptions, c as VerseNumber, L as LyricsOptions, d as StaffTabOrGroups, F as Fermata, e as Navigation, A as AnnotationText, f as Annotation, g as Label, C as Connective, h as TieType, i as NoteAnchor, j as VerticalPosition } from '../music-objects-ChAdqdR8.js';
+export { ao as Arpeggio, aa as BaseConfig, a9 as Clef, a5 as ColorKey, a7 as ColorKeyPart, as as DynamicsAnnotation, aq as LyricsAlign, ar as LyricsHyphen, t as MAccidental, v as MArpeggio, H as MBarLineLeft, G as MBarLineRight, w as MBeamGroup, u as MConnective, y as MEnding, a4 as MExtensionLine, z as MFermata, B as MHeader, D as MImage, a3 as MLyrics, E as MMeasure, J as MNoteGroup, r as MPlaybackButtons, p as MPlayer, q as MRenderContext, P as MRest, U as MRhythmColumn, W as MScoreRow, X as MScoreRowGroup, a1 as MSpecialText, Y as MStaff, I as MStaffBarLine, x as MStaffBeamGroup, K as MStaffNoteGroup, Q as MStaffRest, _ as MStaffSignature, Z as MTab, O as MTabNoteGroup, a0 as MTabRhythm, $ as MTabSignature, a2 as MText, s as MusicInterface, a8 as Paint, au as PlayState, av as PlayStateChangeListener, l as ScoreEvent, o as ScoreEventListener, k as ScoreEventType, n as ScoreObjectEvent, m as ScoreStaffPosEvent, ab as StaffConfig, ap as StaffTabOrGroup, an as Stem, ag as StringNumber, ac as TabConfig, at as TempoAnnotation, a6 as colorKey, ah as getStringNumbers, ak as getVerseNumbers, ad as getVoiceIds, ai as isStringNumber, al as isVerseNumber, ae as isVoiceId, aj as validateStringNumber, am as validateVerseNumber, af as validateVoiceId } from '../music-objects-ChAdqdR8.js';
 import { N as Note } from '../note-RVXvpfyV.js';
 import { S as ScaleType, c as Scale } from '../scale-B1M10_fu.js';
 import { N as NoteLength, h as NoteLengthStr, K as KeySignature, a as TimeSignature, T as TimeSignatures, B as BeamGrouping, k as TupletRatio } from '../tempo-D-JF-8b_.js';
 import '@tspro/ts-utils-lib';
 
-/**
- * Color attributes.
- * ```
- * Attribute hierarchy is:
- *  + background
- *  + header
- *      + title
- *      + composer
- *      + arranger
- *  + rowgroup
- *      + instrument
- *      + frame
- *  + staff|tab
- *      + frame
- *      + note
- *      + rest
- *      + connective
- *      + signature
- *          + clef (staff only)
- *          + key (staff only)
- *          + time
- *          + tempo
- *          + measurenum
- *      + tuning (tab only)
- *      + element
- *          + fermata
- *          + annotation
- *          + navigation
- *          + label
- * ```
- */
-type ColorAttr = "background" | "header" | "title" | "composer" | "arranger" | "rowgroup" | "instrument" | "frame" | "staff" | "tab" | "frame" | "note" | "rest" | "connective" | "signature" | "clef" | "key" | "time" | "tempo" | "measurenum" | "tuning" | "element" | "fermata" | "annotation" | "navigation" | "label";
-/**
- * Set color of any score document element. Use combination of color attributes to set color of specific elements.
- * ```ts
- * setColor("red", "staff");                        // Set color of all staff elements to red.
- * setColor("red", "staff", "signature");           // Set color of all signature elements of staff to red.
- * setColor("red", "staff", "key", "signature");    // Set color of key signature of staff to red.
- * setColor("green", "staff", "time", "signature"); // Set color of time signature of staff to green.
- * // etc.
- * ```
- * See {@link ColorAttr} for attribute hierarchy tree.
- *
- * @param color - Color (HTML color code e.g. "green", "#AA6644", etc.)
- * @param colorAttrs - Any number of color attributes.
- */
-declare function setColor(color: string, ...colorAttrs: ColorAttr[]): void;
-
 /** Tuplet builder type. */
 type TupletBuilder = {
     /**
@@ -463,4 +415,4 @@ declare class DocumentBuilder {
     addScaleArpeggio(scale: Scale, bottomNote: string, numOctaves: number): DocumentBuilder;
 }
 
-export { Annotation, AnnotationText, type ColorAttr, Connective, DocumentBuilder, type ExtensionBuilder, Fermata, Label, LyricsOptions, MDocument, MeasureOptions, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, StaffTabOrGroups, TieType, type TupletBuilder, TupletOptions, VerseNumber, VerticalPosition, VoiceId, setColor };
+export { Annotation, AnnotationText, Connective, DocumentBuilder, type ExtensionBuilder, Fermata, Label, LyricsOptions, MDocument, MeasureOptions, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, StaffTabOrGroups, TieType, type TupletBuilder, TupletOptions, VerseNumber, VerticalPosition, VoiceId };