@stringsync/vexml/dist/cjs/musicxml/clef.d.ts

MusicXML to Vexflow

import { ClefSign } from './enums';
import { NamedElement } from '../util';
/**
 * A symbol placed at the left-hand end of the stave, indicating the pitch of the notes written.
 *
 * See https://www.w3.org/2021/06/musicxml40/musicxml-reference/data-types/clef-sign/
 */
export declare class Clef {
    private element;
    constructor(element: NamedElement<'clef'>);
    /** Returns the stave number this clef belongs to. */
    getStaveNumber(): number;
    /** Returns the clef sign. Defaults to null. */
    getSign(): ClefSign | null;
    /** Returns the line of the clef. Defaults to null. */
    getLine(): number | null;
    /** Returns the octave change of the clef. Defaults to null. */
    getOctaveChange(): number | null;
}