@stringsync/vexml/dist/esm/musicxml/ornaments.js

MusicXML to Vexflow

import * as util from '../util';
import { AccidentalMark } from './accidentalmark';
import { WavyLine } from './wavyline';
import { TrillMark } from './trillmark';
import { Turn } from './turn';
import { DelayedTurn } from './delayedturn';
import { InvertedTurn } from './invertedturn';
import { Mordent } from './mordent';
import { InvertedMordent } from './invertedmordent';
import { Tremolo } from './tremolo';
/**
 * Ornaments can be any of several types, followed optionally by accidentals.
 *
 * See https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/ornaments/.
 */
export class Ornaments {
    element;
    constructor(element) {
        this.element = element;
    }
    /** Returns trill mark entries. Defaults to an empty array. */
    getTrillMarks() {
        return this.getEntries('trill-mark').map((entry) => ({
            ...entry,
            value: new TrillMark(entry.value),
        }));
    }
    /** Returns turn entries. Defaults to an empty array. */
    getTurns() {
        return this.getEntries('turn').map((entry) => ({
            ...entry,
            value: new Turn(entry.value),
        }));
    }
    /** Returns the wavy lines of the ornaments. Defaults to an empty array. */
    getWavyLines() {
        return this.getEntries('wavy-line').map((entry) => ({
            ...entry,
            value: new WavyLine(entry.value),
        }));
    }
    /** Returns the delayed turns of the ornaments. Defaults to an empty array. */
    getDelayedTurns() {
        return this.getEntries('delayed-turn').map((entry) => ({
            ...entry,
            value: new DelayedTurn(entry.value),
        }));
    }
    /** Returns the inverted turns of the ornaments. Defaults to an empty array. */
    getInvertedTurns() {
        return this.getEntries('inverted-turn').map((entry) => ({
            ...entry,
            value: new InvertedTurn(entry.value),
        }));
    }
    /** Returns the mordents of the ornaments. Defaults to an empty array. */
    getMordents() {
        return this.getEntries('mordent').map((entry) => ({
            ...entry,
            value: new Mordent(entry.value),
        }));
    }
    /** Returns the inverted mordents of the ornaments. Defaults to an empty array. */
    getInvertedMordents() {
        return this.getEntries('inverted-mordent').map((entry) => ({
            ...entry,
            value: new InvertedMordent(entry.value),
        }));
    }
    getTremolos() {
        return this.getEntries('tremolo').map((entry) => ({
            ...entry,
            value: new Tremolo(entry.value),
        }));
    }
    getEntries(name) {
        const entries = new Array();
        function startEntry(value) {
            entries.push({ value, accidentalMarks: [] });
        }
        function addAccidentalMark(accidentalMark) {
            // Based on the `<ornament>` spec, we should always have an entry to add the accidental mark to. Otherwise, we
            // silently ignore it.
            util.last(entries)?.accidentalMarks.push(accidentalMark);
        }
        for (const child of this.element.children()) {
            if (child.isNamed(name)) {
                startEntry(child);
            }
            if (child.isNamed('accidental-mark')) {
                addAccidentalMark(new AccidentalMark(child));
            }
        }
        return entries;
    }
}