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

    Class PluginsUIPlugin

    Registers the React UI widgets and toolbar items for the plugins package. Depends on the Teia and Viewport plugins, and hooks into the viewport's widget factory and infobox/settings tabs to expose each installed plugin's widgets.

    Hierarchy

    • PluginBaseClass
      • PluginsUIPlugin
    Index

    Constructors

    constructor

    Properties

    name settings viewer ToolbarItems

    Methods

    clear dependencies hasSettings onRegister onUnregister Create

    Constructors

    • Parameters

      • viewer: Viewer
      • Optionalcfg: RecursivePartial<
            ExtractValues<
                {
                    advancedSearch: {
                        enableAI: BooleanController;
                        enableJsonEditor: BooleanController;
                    };
                },
            >,
        >

      Returns PluginsUIPlugin

    Properties

    name: string

    Display name of the plugin

    settings: {
        advancedSearch: {
            enableAI: BooleanController;
            enableJsonEditor: BooleanController;
        };
    }

    Plugin settings

    viewer: Viewer
    ToolbarItems: {
        MeasureLineToolbarItem: () => Element;
        NavigationGraphToolbarItem: () => Element;
        ObjectTransformToolbarItem: () => Element;
        ShowFloorPlanWidgetToolbarItem: () => Element;
        ShowProjectionsWidgetToolbarItem: () => Element;
        TeiaSearchToolbarItem: () => Element;
        ZoneToolbarItem: () => Element;
    } = ...

    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