@finos/perspective-viewer
Version:
The `<perspective-viewer>` Custom Element, frontend for Perspective.js
40 lines (39 loc) • 1.91 kB
TypeScript
/**
* Module for the `<perspective-viewer>` custom element. This module has no
* (real) exports, but importing it has a side effect: the
* `PerspectiveViewerElement`class is registered as a custom element, after
* which it can be used as a standard DOM element.
*
* Though `<perspective-viewer>` is written mostly in Rust, the nature
* of WebAssembly's compilation makes it a dynamic module; in order to
* guarantee that the Custom Elements extension methods are registered
* synchronously with this package's import, we need perform said registration
* within this wrapper module. As a result, the API methods of the Custom
* Elements are all `async` (as they must await the wasm module instance).
*
* The documentation in this module defines the instance structure of a
* `<perspective-viewer>` DOM object instantiated typically, through HTML or any
* relevent DOM method e.g. `document.createElement("perspective-viewer")` or
* `document.getElementsByTagName("perspective-viewer")`.
*
* @module perspective-viewer
*/
export { IPerspectiveViewerPlugin } from "./plugin";
export { HTMLPerspectiveViewerPluginElement } from "./plugin";
import { ExportDropDownMenuElement, CopyDropDownMenuElement } from "../../dist/wasm/perspective-viewer";
export interface HTMLPerspectiveViewerExportMenu extends HTMLElement, ExportDropDownMenuElement {
}
export interface HTMLPerspectiveViewerCopyMenu extends HTMLElement, CopyDropDownMenuElement {
}
export * from "./extensions";
export type * from "./ts-rs/ViewerConfigUpdate.d.ts";
export type * from "./ts-rs/ColumnConfigValues.d.ts";
export type * from "./ts-rs/Filter.d.ts";
export type * from "./ts-rs/FilterTerm.d.ts";
export type * from "./ts-rs/FilterReducer.d.ts";
export { init_client } from "./bootstrap";
import { init_client } from "./bootstrap";
declare const _default: {
init_client: typeof init_client;
};
export default _default;