Documentation - v19.12.0-dev
    Preparing search index...

    Class DocumentViewerPlugin

    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

    constructor

    Properties

    name settings viewer ToolbarItems

    Methods

    clear dependencies hasSettings onRegister onUnregister Create

    Constructors

    Properties

    name: string

    Display name of the plugin

    settings: TSettings

    Plugin settings

    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)[]

    • Indicates whether the plugin has settings

      Returns boolean

    • Called when the plugin is registered in the viewer.

      Returns void

    • Called when the plugin is unregistred from the viewer.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods