Documentation - v20.0.0-dev
    Preparing search index...

    Plugin registering the DocumentViewer widget, used to display a document (pdf, image, video, audio) in the viewport. Open it with the ShowDocumentViewerWidgetToolbarItem or an OpenWidgetCommand.

    Requires the Viewport plugin to be registered. Call setupLegacyPluginsTranslation once i18next is initialized to load its translations.

    Hierarchy

    • PluginBaseClass
      • DocumentViewerPlugin
    Index

    Constructors

    Properties

    name: string

    Display name of the plugin

    settings: EmptySettings

    Its settings: those saved in the local storage set, then config.

    viewer: Viewer
    ToolbarItems: {
        ShowDocumentViewerWidgetToolbarItem: (
            props: DocumentViewerWidgetProps,
        ) => Element;
    } = ...

    Toolbar items provided by the plugin

    Type Declaration

    Methods

    • Returns void

    • List of plugins this plugin depends on

      Returns readonly (keyof ViewerPluginRegistry)[]

    • Whether the plugin has at least one setting an interface shows (not hidden).

      Returns boolean

    • Called when the plugin is registered in the viewer.

      Returns void

    • Called when the plugin is unregistred from the viewer.

      Returns void

    • A base class for a plugin of this name, its settings an instance of SettingsClass (EmptySettings for none): class MyPlugin extends ViewerPlugin.Create('MyPlugin', MySettings) {}.

      Type Parameters

      Parameters

      • name: string
      • SettingsClass: new () => S

      Returns typeof PluginClass