@stringsync/vexml
Version:
MusicXML to Vexflow
30 lines (29 loc) • 1.08 kB
TypeScript
import { NamedElement } from '../util';
import { Defaults } from './defaults';
import { Part } from './part';
/** Information about a `Part`. */
export type PartDetail = {
id: string;
name: string;
};
/**
* ScorePartwise is the entrypoint of a MusicXML document.
*
* See https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/score-partwise/
*/
export declare class ScorePartwise {
private element;
constructor(element: NamedElement<'score-partwise'>);
/** Returns the part count in the score. */
getPartCount(): number;
/** Returns an array of part IDs in the score in the order they appear. Each part ID should be unique. */
getPartIds(): string[];
/** Returns an array of part names in the score in the order they appear. Part names can be duplicated. */
getPartDetails(): PartDetail[];
/** Returns an array of parts in the order they appear. */
getParts(): Part[];
/** Returns the defaults of the score. */
getDefaults(): Defaults | null;
/** Returns the title of the score */
getTitle(): string;
}