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

MusicXML to Vexflow

import { NamedElement } from '../util';
import { KeyMode } from './enums';
/**
 * Key represents a key signature.
 *
 * See https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/key/
 */
export declare class Key {
    private element;
    constructor(element: NamedElement<'key'>);
    /** Returns the fifths count of the key. Defaults to 0. */
    getFifthsCount(): number;
    /** Returns the mode of the key. Defaults to 'none'. */
    getMode(): KeyMode;
    /** Returns the stave number this key belongs to. */
    getStaveNumber(): number | null;
}