vexflow/build/types/src/accidental.d.ts

A JavaScript library for rendering music notation and guitar tablature.

import { Modifier } from './modifier';
import { ModifierContextState } from './modifiercontext';
import { Note } from './note';
import { Voice } from './voice';
type StaveLineAccidentalLayoutMetrics = {
    column: number;
    line: number;
    /**
     * A flat line needs more clearance above than below. This is
     * set to true if the accidental is either a flat or double flat.
     */
    flatLine: boolean;
    /**
     * Double sharps need less clearance above and below than other
     * accidentals.
     */
    dblSharpLine: boolean;
    numAcc: number;
    width: number;
};
/**
 * An `Accidental` inherits from `Modifier`, and is formatted within a
 * `ModifierContext`. Accidentals are modifiers that can be attached to
 * notes. Support is included for both western and microtonal accidentals.
 *
 * See `tests/accidental_tests.ts` for usage examples.
 */
export declare class Accidental extends Modifier {
    /** Accidental code provided to the constructor. */
    readonly type: string;
    /** To enable logging for this class. Set `VexFlow.Accidental.DEBUG` to `true`. */
    static DEBUG: boolean;
    protected cautionary: boolean;
    /** Accidentals category string. */
    static get CATEGORY(): string;
    /** Arrange accidentals inside a ModifierContext. */
    static format(accidentals: Accidental[], state: ModifierContextState): void;
    /** Helper function to determine whether two lines of accidentals collide vertically */
    protected static checkCollision(line1: StaveLineAccidentalLayoutMetrics, line2: StaveLineAccidentalLayoutMetrics): boolean;
    /**
     * Use this method to automatically apply accidentals to a set of `voices`.
     * The accidentals will be remembered between all the voices provided.
     * Optionally, you can also provide an initial `keySignature`.
     */
    static applyAccidentals(voices: Voice[], keySignature: string): void;
    /**
     * Create accidental.
     * @param type value from `VexFlow.accidentalCodes.accidentals` table in `tables.ts`.
     * For example: `#`, `##`, `b`, `n`, etc.
     */
    constructor(type: string);
    protected reset(): void;
    /** Attach this accidental to `note`, which must be a `StaveNote`. */
    setNote(note: Note): this;
    /** If called, draws parenthesis around accidental. */
    setAsCautionary(): this;
    /** Render accidental onto canvas. */
    draw(): void;
}
export {};