@tspro/web-music-score 5.2.0 → 5.4.0

package/dist/score/index.d.ts

@@ -1,10 +1,236 @@
-import { N as NoteOptions, R as RestOptions, S as StaffPreset, a as ScoreConfiguration, M as MDocument, V as VoiceId, T as TupletOptions, b as VerseNumber, L as LyricsOptions, c as StaffTabOrGroups, F as Fermata, d as Navigation, A as AnnotationText, e as Annotation, f as Label, C as Connective, g as TieType, h as NoteAnchor, i as VerticalPosition } from '../music-objects-CwPOlqFi.js';
-export { ad as Arpeggio, a5 as BaseConfig, a4 as Clef, D as DivRect, ah as DynamicsAnnotation, af as LyricsAlign, ag as LyricsHyphen, s as MAccidental, u as MArpeggio, H as MBarLineLeft, G as MBarLineRight, v as MBeamGroup, t as MConnective, x as MEnding, a3 as MExtensionLine, y as MFermata, z as MHeader, B as MImage, a2 as MLyrics, E as MMeasure, J as MNoteGroup, q as MPlaybackButtons, o as MPlayer, p as MRenderer, P as MRest, U as MRhythmColumn, W as MScoreRow, a0 as MSpecialText, X as MStaff, w as MStaffBeamGroup, K as MStaffNoteGroup, Q as MStaffRest, Z as MStaffSignature, I as MStaffTabBarLine, Y as MTab, O as MTabNoteGroup, $ as MTabRhythm, _ as MTabSignature, a1 as MText, r as MusicInterface, aj as PlayState, ak as PlayStateChangeListener, k as ScoreEvent, n as ScoreEventListener, j as ScoreEventType, m as ScoreObjectEvent, l as ScoreStaffPosEvent, a6 as StaffConfig, ae as StaffTabOrGroup, ac as Stem, a9 as StringNumber, a7 as TabConfig, ai as TempoAnnotation, aa as getStringNumbers, ab as getVerseNumbers, a8 as getVoiceIds } from '../music-objects-CwPOlqFi.js';
-import { N as Note } from '../note-CgCIBwvR.js';
-import { S as ScaleType, c as Scale } from '../scale-CBW4eTz7.js';
-import { N as NoteLength, i as NoteLengthStr, K as KeySignature, b as TimeSignature, T as TimeSignatures, B as BeamGrouping, k as TupletRatio } from '../tempo-DMt3iwz9.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-3Esbz7ij.js';
+export { ak as Arpeggio, a6 as BaseConfig, a5 as Clef, ao as DynamicsAnnotation, am as LyricsAlign, an as LyricsHyphen, u as MAccidental, w as MArpeggio, I as MBarLineLeft, H as MBarLineRight, x as MBeamGroup, v as MConnective, z as MEnding, a4 as MExtensionLine, B as MFermata, D as MHeader, E as MImage, a3 as MLyrics, G as MMeasure, K as MNoteGroup, s as MPlaybackButtons, p as MPlayer, q as MRenderContext, r as MRenderer, Q as MRest, W as MRhythmColumn, X as MScoreRow, a1 as MSpecialText, Y as MStaff, y as MStaffBeamGroup, O as MStaffNoteGroup, U as MStaffRest, _ as MStaffSignature, J as MStaffTabBarLine, Z as MTab, P as MTabNoteGroup, a0 as MTabRhythm, $ as MTabSignature, a2 as MText, t 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-3Esbz7ij.js';
+import { N as Note } from '../note-CJuq5aBy.js';
+import { S as ScaleType, c as Scale } from '../scale-DulPFco_.js';
+import { N as NoteLength, i as NoteLengthStr, K as KeySignature, b as TimeSignature, T as TimeSignatures, B as BeamGrouping, l as TupletRatio } from '../tempo-BnUjm25M.js';
 import '@tspro/ts-utils-lib';
 
+/**
+ * @deprecated - Will be removed in `v6.0.0`. Use `AnchoredRect` from `@tspro/ts-utils-lib` instead.
+ *
+ * DivRect class, left, top, right, bottom rectangle divided into four sections by anchorX, anchorY.
+ */
+declare class DivRect {
+    left: number;
+    anchorX: number;
+    right: number;
+    top: number;
+    anchorY: number;
+    bottom: number;
+    /**
+     * Create rectangle with all zero values.
+     */
+    constructor();
+    /**
+     * Create rectangle with left, right, top, bottom.
+     * Properties anchorX and anchorY will be centered in the middle.
+     *
+     * @param left - Left coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param bottom - Bottom coordinate.
+     */
+    constructor(left: number, right: number, top: number, bottom: number);
+    /**
+     * Create rectangle with full arguments.
+     *
+     * @param left - Left coordinate.
+     * @param anchorX - Center x-coordinate.
+     * @param right - Right coordinate.
+     * @param top - Top coordinate.
+     * @param anchorY - Center y-coordinate.
+     * @param bottom - Bottom coordinate.
+     */
+    constructor(left: number, anchorX: number, right: number, top: number, anchorY: number, bottom: number);
+    /**
+     * Create rect from basic left, top, width and height arguments.
+     *
+     * @param left - Left coordinate.
+     * @param top - Top coordinate.
+     * @param width - Width.
+     * @param height - Height.
+     * @returns - DivRect.
+     */
+    static create(left: number, top: number, width: number, height: number): DivRect;
+    /**
+     * Create rect from anchorX, anchorY, width, height arguments.
+     *
+     * @param centerX - Center x-coordinate.
+     * @param centerY - Center y-coordinate.
+     * @param width - Width.
+     * @param height - Height.
+     * @returns - DivRect.
+     */
+    static createCentered(centerX: number, centerY: number, width: number, height: number): DivRect;
+    /**
+     * Create rect from sections.
+     *
+     * @param leftw - Left section width.
+     * @param rightw - Right section width.
+     * @param toph - Top section height.
+     * @param bottomh - Bottomsection height.
+     * @returns - DivRect.
+     */
+    static createSections(leftw: number, rightw: number, toph: number, bottomh: number): DivRect;
+    /** @deprecated - Renamed to anchorX. */
+    get centerX(): number;
+    /** @deprecated - Renamed to anchorX. */
+    set centerX(x: number);
+    /** @deprecated - Renamed to anchorY. */
+    get centerY(): number;
+    /** @deprecated - Renamed to anchorY. */
+    set centerY(y: number);
+    /**
+     * Width getter.
+     */
+    get width(): number;
+    /**
+     * Height getter.
+     */
+    get height(): number;
+    /**
+     * Left section width getter.
+     */
+    get leftw(): number;
+    /**
+     * Right section width getter.
+     */
+    get rightw(): number;
+    /**
+     * Top section height getter.
+     */
+    get toph(): number;
+    /**
+     * Bottom section height getter.
+     */
+    get bottomh(): number;
+    /**
+     * Does this Rect contain given (x, y)-point?
+     *
+     * @param x - X-coordinate.
+     * @param y - Y-coordinate.
+     * @returns - True/false.
+     */
+    contains(x: number, y: number): boolean;
+    /**
+     * Do a and b rects overlap?
+     *
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
+     */
+    static overlap(a: DivRect, b: DivRect): boolean;
+    /**
+     * Do horizontal measures of a and b rects overlap?
+     *
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
+     */
+    static overlapX(a: DivRect, b: DivRect): boolean;
+    /**
+     * Check if given rects are equal.
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
+     */
+    static equals(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
+    /**
+     * Check if this rect equals with another rect.
+     * @param other - The other rect.
+     * @returns - True/false.
+     */
+    equals(other: DivRect): boolean;
+    /**
+     * Check if edges of given rects are equal, ignoring anchorX and anchorY.
+     *
+     * @param a - DivRect a.
+     * @param b - DivRect b.
+     * @returns - True/false.
+     */
+    static equalsEdges(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
+    /**
+     * Check if edges of this Rect equals with given Rect, ignoring anchorX and anchorY.
+     *
+     * @param other - The other DivRect.
+     * @returns - True/false.
+     */
+    equalsEdges(other: DivRect): boolean;
+    /** @deprecated - Use `DivRect.equalsEdges()` instead. */
+    static equalsFrame(a: DivRect | null | undefined, b: DivRect | null | undefined): boolean;
+    /**
+     * Created duplicate of this Rect.
+     *
+     * @returns - Duplicate.
+     */
+    copy(): DivRect;
+    /**
+     * Move this rect by (dx, dy). Modifies this Rect.
+     *
+     * @param dx - Offset amount in x-direction.
+     * @param dy - Offset amount in y-direction.
+     * @returns - This DivRect instance.
+     */
+    offsetInPlace(dx: number, dy: number): DivRect;
+    /**
+     * Move this rect by (dx, dy). Immutable, returns modified copy.
+     *
+     * @param dx - Offset amount in x-direction.
+     * @param dy - Offset amount in y-direction.
+     * @returns - DivRect copy with applied offset.
+     */
+    offsetCopy(dx: number, dy: number): DivRect;
+    /**
+     * Expand this Rect by given Rect. Modifies this Rect.
+     *
+     * @param rect - DivRect to expand this instance with.
+     * @returns - This DivRect instance.
+     */
+    expandInPlace(rect: DivRect): DivRect;
+    /**
+     * Expand this Rect by given Rect. Immutable, returns modified copy.
+     *
+     * @param rect - DivRect to expand this instance with.
+     * @returns - Expanded copy of this DivRect.
+     */
+    expandCopy(rect: DivRect): DivRect;
+    /**
+     * Clip this Rect by given Rect. Mmodifies this Rect.
+     *
+     * @param clipRect - DivRect to clip this instance with.
+     * @returns - This DivRect instance.
+     */
+    clipInPlace(clipRect: DivRect): DivRect;
+    /**
+     * Clip this Rect by given Rect. Immutable, return modified copy.
+     *
+     * @param clipRect - DivRecto to clip this instance with.
+     * @returns - Clipped DivRect copy.
+     */
+    clipCopy(clipRect: DivRect): DivRect;
+    /**
+     * Scale Rect. Anchor pos is (anchorX, anchorY). Modifies this Rect.
+     *
+     * @param scaleX - Scale x-amount.
+     * @param scaleY - Scale y-amount. If undefined then scale x-amount is used.
+     * @returns This DivRect instance.
+     */
+    scaleInPlace(scaleX: number, scaleY?: number): DivRect;
+    /**
+     * Scale Rect. Anchor pos is (anchorX, anchorY). Immutable, returns modified copy.
+     *
+     * @param scaleX - Scale x-amount.
+     * @param scaleY - Scale y-amount. If undefined then scale x-amount is used.
+     * @returns Scaled copy of this DivRect.
+     */
+    scaleCopy(scaleX: number, scaleY?: number): DivRect;
+    /**
+     * Get this DivRect instance.
+     * @returns - This DivRect instance.
+     */
+    getRect(): DivRect;
+}
+
 /** Tuplet builder type. */
 type TupletBuilder = {
     /**
@@ -88,6 +314,7 @@ declare class DocumentBuilder {
      * @param config - Score configuration (e.g. { type: "staff", clef: "G", isOctavewDown: true }).
      */
     setScoreConfiguration(config: ScoreConfiguration): DocumentBuilder;
+    private static DefaultMeasureOptions;
     private getMeasure;
     /**
      * Get music document after finished building.
@@ -110,9 +337,10 @@ declare class DocumentBuilder {
     setMeasuresPerRow(measuresPerRow: number): DocumentBuilder;
     /**
      * Add new measure.
+     * @param measureOptions - Measure options.
      * @returns - This document builder instance.
      */
-    addMeasure(): DocumentBuilder;
+    addMeasure(measureOptions?: MeasureOptions): DocumentBuilder;
     /**
      * Set key signature for current measure and forward.
      * @param tonic - Tonic note (e.g. "C").
@@ -421,4 +649,4 @@ declare class DocumentBuilder {
     addScaleArpeggio(scale: Scale, bottomNote: string, numOctaves: number): DocumentBuilder;
 }
 
-export { Annotation, AnnotationText, Connective, DocumentBuilder, type ExtensionBuilder, Fermata, Label, LyricsOptions, MDocument, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, StaffTabOrGroups, TieType, type TupletBuilder, TupletOptions, VerseNumber, VerticalPosition, VoiceId };
+export { Annotation, AnnotationText, Connective, DivRect, DocumentBuilder, type ExtensionBuilder, Fermata, Label, LyricsOptions, MDocument, MeasureOptions, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, StaffTabOrGroups, TieType, type TupletBuilder, TupletOptions, VerseNumber, VerticalPosition, VoiceId };