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

A JavaScript library for rendering music notation and guitar tablature.

import { Element } from './element';
import { RenderContext } from './rendercontext';
import { Stave } from './stave';
import { StaveModifier } from './stavemodifier';
export interface TimeSignatureInfo {
    glyph: string;
    line: number;
    num: boolean;
}
/**
 * A TimeSignature is a StaveModifier that can make its appropriate Glyphs directly from
 * a provided "timeSpec" such as "4/4", "C|" (cut time), or even something more advanced
 * such as "3/4(6/8)" or "2/4+5/8".
 */
export declare class TimeSignature extends StaveModifier {
    static get CATEGORY(): string;
    bottomLine: number;
    topLine: number;
    protected timeSpec: string;
    protected line: number;
    protected topText: Element;
    protected botText: Element;
    protected isNumeric: boolean;
    protected validateArgs: boolean;
    protected topStartX: number;
    protected botStartX: number;
    protected lineShift: number;
    constructor(timeSpec?: string, customPadding?: number, validateArgs?: boolean);
    static getTimeSigCode(key: string, smallSig?: boolean): string;
    /**
     * Returns a new TimeSignatureGlyph (a Glyph subclass that knows how to draw both
     * top and bottom digits along with plus signs etc.)
     */
    makeTimeSignatureGlyph(topDigits: string, botDigits: string): void;
    /**
     * Set a new time signature specification without changing customPadding, etc.
     *
     * The getter for this is `getTimeSpec` not `getTimeSig`.
     */
    setTimeSig(timeSpec: string): this;
    /**
     * Return the timeSpec (such as '4/4' or 'C|' or even '2/4+3/8') of the TimeSignature
     */
    getTimeSpec(): string;
    /**
     * Return the staff line that the TimeSignature sits on.  Generally 0 for numerator/
     * denominator time signatures such as 3/4 and 2 for cut/common.
     */
    getLine(): number;
    /**
     * Set the line number that the TimeSignature sits on.  Half-values are acceptable
     * for spaces, etc. Can be altered, for instance, for signatures that sit above the
     * staff in large orchestral scores.
     */
    setLine(line: number): void;
    /**
     * Return a boolean on whether this TimeSignature is drawn with one or more numbers
     * (such as 4/4) or not (as in cut time).
     */
    getIsNumeric(): boolean;
    /**
     * Set whether this TimeSignature is drawn with one or more numbers.
     */
    setIsNumeric(isNumeric: boolean): void;
    /**
     * Draw the time signature on a Stave using its RenderContext.  Both setStave
     * and setContext must already be run.
     */
    draw(): void;
    drawAt(ctx: RenderContext, stave: Stave, x: number): void;
}