@finos/perspective-viewer
    Preparing search index...

    Interface PerspectiveViewerElementExt

    interface PerspectiveViewerElementExt {
        addEventListener(
            name: "perspective-click",
            cb: (e: CustomEvent) => void,
            options?: { signal: AbortSignal },
        ): void;
        addEventListener(
            name: "perspective-select",
            cb: (e: CustomEvent) => void,
            options?: { signal: AbortSignal },
        ): void;
        addEventListener(
            name: "perspective-toggle-settings",
            cb: (e: CustomEvent) => void,
            options?: { signal: AbortSignal },
        ): void;
        addEventListener(
            name: "perspective-config-update",
            cb: (e: CustomEvent) => void,
            options?: { signal: AbortSignal },
        ): void;
        registerPlugin(name: string): Promise<void>;
        removeEventListener(name: "perspective-click", cb: any): void;
        removeEventListener(name: "perspective-select", cb: any): void;
        removeEventListener(name: "perspective-toggle-settings", cb: any): void;
        removeEventListener(name: "perspective-config-update", cb: any): void;
    }
    Index

    Other

    addEventListener removeEventListener

    Plugin

    registerPlugin

    Other

    • Parameters

      • name: "perspective-click"
      • cb: (e: CustomEvent) => void
      • Optionaloptions: { signal: AbortSignal }

      Returns void

    • Parameters

      • name: "perspective-select"
      • cb: (e: CustomEvent) => void
      • Optionaloptions: { signal: AbortSignal }

      Returns void

    • Parameters

      • name: "perspective-toggle-settings"
      • cb: (e: CustomEvent) => void
      • Optionaloptions: { signal: AbortSignal }

      Returns void

    • Parameters

      • name: "perspective-config-update"
      • cb: (e: CustomEvent) => void
      • Optionaloptions: { signal: AbortSignal }

      Returns void

    Plugin

    • Register a new plugin via its custom element name. This method is called automatically as a side effect of importing a plugin module, so this method should only typically be called by plugin authors.

      Parameters

      • name: string

        The name of the custom element to register, as supplied to the customElements.define(name) method.

      Returns Promise<void>

      customElements.get("perspective-viewer").registerPlugin("my-plugin");

    Settings

    Member Visibility

    On This Page

    Other
    Plugin