@stringsync/vexml/dist/@types/musicxml/tuplet.d.ts

MusicXML to Vexflow

import { NamedElement } from '../util';
import { AboveBelow, StartStop, ShowTuplet } from './enums';
/**
 * A <tuplet> element is present when a tuplet is to be displayed graphically, in addition to the sound data provided by
 * the <time-modification> elements.
 *
 * See https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/tuplet/.
 */
export declare class Tuplet {
    private element;
    constructor(element: NamedElement<'tuplet'>);
    /** Returns the type of tuplet. */
    getType(): StartStop | null;
    /** Returns the placement of the tuplet. Defaults to 'below'. */
    getPlacement(): AboveBelow;
    /** Returns the number of the tuplet. Defaults to 1. */
    getNumber(): number;
    /** Returns how the tuplet number should be displayed. */
    getShowNumber(): ShowTuplet;
}