satie
Version:
A sheet music renderer for the web
30 lines (29 loc) • 1.02 kB
TypeScript
import Factory from "./engine_factory";
/**
* Optional initialization function. Call this if you don't want the default options. Must be called
* before any Satie component is mounted, and must only be called once.
*/
export declare function init(options: ISatieOptions): void;
/**
* Options to pass into init(...). No options are required.
*/
export interface ISatieOptions {
/**
* For web browsers only.
*
* A list of fonts and variants (in parentheses) that are included on a webpage, that Satie
* should not automatically load. You can get better performance improvements by putting font
* loading inside your's HTML file's `<head></head>`
*
* e.g., "Alegreya", "Alegreya (bold)", "Bravura"
*/
preloadedFonts?: string[];
/**
* For web browsers only.
*
* Specify where all the files Satie needs are.
* By default, Satie looks inside `http[s]://vendor/`.
*/
satieRoot?: string;
}
export declare function makeFactory(): Factory;