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

A JavaScript library for rendering music notation and guitar tablature.

import { Element } from './element';
import { FontInfo } from './font';
import { Note } from './note';
import { RenderContext } from './rendercontext';
export interface TextBracketParams {
    start: Note;
    stop: Note;
    text?: string;
    superscript?: string;
    position?: number | string;
}
export declare enum TextBracketPosition {
    TOP = 1,
    BOTTOM = -1
}
export declare class TextBracket extends Element {
    static DEBUG: boolean;
    static get CATEGORY(): string;
    static TEXT_FONT: Required<FontInfo>;
    render_options: {
        dashed: boolean;
        color: string;
        line_width: number;
        underline_superscript: boolean;
        show_bracket: boolean;
        dash: number[];
        bracket_height: number;
    };
    protected readonly text: string;
    protected readonly superscript: string;
    protected line: number;
    readonly position: TextBracketPosition;
    readonly start: Note;
    readonly stop: Note;
    static get Position(): typeof TextBracketPosition;
    static get PositionString(): Record<string, number>;
    /**
     * @deprecated Use `TextBracket.Position` instead.
     */
    static get Positions(): typeof TextBracketPosition;
    /**
     * @deprecated Use `TextBracket.PositionString` instead.
     */
    static get PositionsString(): Record<string, number>;
    constructor({ start, stop, text, superscript, position }: TextBracketParams);
    /**
     * Apply the text backet styling to the provided context.
     * @param ctx
     * @returns this
     */
    applyStyle(ctx: RenderContext): this;
    setDashed(dashed: boolean, dash?: number[]): this;
    setLine(line: number): this;
    draw(): void;
}