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

MusicXML to Vexflow

import { NamedElement } from '../util';
import { AboveBelow, LineType } from './enums';
/** Indicates a regular horizontal accent mark. */
export type Accent = {
    type: 'accent';
    placement: AboveBelow | null;
};
/** Indicates a bold horizontal accent mark. */
export type StrongAccent = {
    type: 'strongaccent';
    placement: AboveBelow | null;
};
/** Represents a staccato mark. */
export type Staccato = {
    type: 'staccato';
    placement: AboveBelow | null;
};
/** Represents a tenuto mark. */
export type Tenuto = {
    type: 'tenuto';
    placement: AboveBelow | null;
};
/** Represents a detached legato mark. */
export type DetachedLegato = {
    type: 'detachedlegato';
    placement: AboveBelow | null;
};
/** Represents a staccatissimo mark. */
export type Staccatissimo = {
    type: 'staccatissimo';
    placement: AboveBelow | null;
};
/** Represents a scoop mark. */
export type Scoop = {
    type: 'scoop';
    lineType: LineType;
    placement: AboveBelow | null;
};
/** Represents a plop mark. */
export type Plop = {
    type: 'plop';
    lineType: LineType;
    placement: AboveBelow | null;
};
/** Represents a doit mark. */
export type Doit = {
    type: 'doit';
    lineType: LineType;
    placement: AboveBelow | null;
};
/** Represents a falloff mark. */
export type Falloff = {
    type: 'falloff';
    lineType: LineType;
    placement: AboveBelow | null;
};
/** Represents a breath mark. */
export type BreathMark = {
    type: 'breathmark';
    placement: AboveBelow | null;
};
/**
 * The `<articulations>` element groups together articulations and accents.
 *
 * See https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/articulations/
 */
export declare class Articulations {
    private element;
    constructor(element: NamedElement<'articulations'>);
    /** Returns the accent articulations. */
    getAccents(): Accent[];
    /** Returns the strong accent articulations. */
    getStrongAccents(): StrongAccent[];
    /** Returns the staccato articulations. */
    getStaccatos(): Staccato[];
    /** Returns the tenuto articulations. */
    getTenutos(): Tenuto[];
    /** Returns the detached legato articulations. */
    getDetachedLegatos(): DetachedLegato[];
    /** Returns the staccatissimo articulations. */
    getStaccatissimos(): Staccatissimo[];
    /** Returns the scoop articulations. */
    getScoops(): Scoop[];
    /** Returns the plop articulations. */
    getPlops(): Plop[];
    /** Returns the doit articulations. */
    getDoits(): Doit[];
    /** Returns the falloff articulations. */
    getFalloffs(): Falloff[];
    /** Returns the breath mark articulations. */
    getBreathMarks(): BreathMark[];
}