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

A JavaScript library for rendering music notation and guitar tablature.

import { BoundingBox } from './boundingbox';
import { ElementStyle } from './element';
import { Note, NoteStruct } from './note';
import { Stave } from './stave';
export interface NoteHeadMetrics {
    minPadding?: number;
    displacedShiftX?: number;
}
export interface NoteHeadStruct extends NoteStruct {
    line?: number;
    glyph_font_scale?: number;
    slashed?: boolean;
    style?: ElementStyle;
    stem_down_x_offset?: number;
    stem_up_x_offset?: number;
    custom_glyph_code?: string;
    x_shift?: number;
    stem_direction?: number;
    displaced?: boolean;
    note_type?: string;
    x?: number;
    y?: number;
    index?: number;
}
/**
 * `NoteHeads` are typically not manipulated
 * directly, but used internally in `StaveNote`.
 *
 * See `tests/notehead_tests.ts` for usage examples.
 */
export declare class NoteHead extends Note {
    /** To enable logging for this class. Set `Vex.Flow.NoteHead.DEBUG` to `true`. */
    static DEBUG: boolean;
    static get CATEGORY(): string;
    glyph_code: string;
    protected custom_glyph: boolean;
    protected stem_up_x_offset: number;
    protected stem_down_x_offset: number;
    protected displaced: boolean;
    protected stem_direction: number;
    protected x: number;
    protected y: number;
    protected line: number;
    protected index?: number;
    protected slashed: boolean;
    constructor(noteStruct: NoteHeadStruct);
    /** Get the width of the notehead. */
    getWidth(): number;
    /** Determine if the notehead is displaced. */
    isDisplaced(): boolean;
    /** Set the X coordinate. */
    setX(x: number): this;
    /** Get the Y coordinate. */
    getY(): number;
    /** Set the Y coordinate. */
    setY(y: number): this;
    /** Get the stave line the notehead is placed on. */
    getLine(): number;
    /** Set the stave line the notehead is placed on. */
    setLine(line: number): this;
    /** Get the canvas `x` coordinate position of the notehead. */
    getAbsoluteX(): number;
    /** Get the `BoundingBox` for the `NoteHead`. */
    getBoundingBox(): BoundingBox;
    /** Set notehead to a provided `stave`. */
    setStave(stave: Stave): this;
    /** Pre-render formatting. */
    preFormat(): this;
    /** Draw the notehead. */
    draw(): void;
}