@stringsync/vexml/dist/@types/components/root.d.ts

MusicXML to Vexflow

import { Overlay } from './overlay';
/**
 * The root component that houses the vexflow renderings.
 *
 * The purpose of this class is to insulate low-level DOM manipulation from the rest of the codebase.
 */
export declare class Root {
    private element;
    private overlay;
    private constructor();
    static svg(parent: HTMLElement, width: number | undefined, height: number | undefined): Root;
    static canvas(parent: HTMLElement, width: number | undefined, height: number | undefined): Root;
    private static render;
    /** Returns the Overlay component. */
    getOverlay(): Overlay;
    getScrollContainer(): HTMLDivElement;
    /** Returns the element that is intended to be inputted to vexflow. */
    getVexflowContainerElement(): HTMLDivElement | HTMLCanvasElement;
    /** Returns the element that vexflow rendered onto. */
    getVexflowElement(): SVGElement | HTMLCanvasElement;
    /** Removes the element from the DOM. */
    remove(): void;
}