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

    Registers the React UI widgets and toolbar items for the plugins package. Depends on Teia (the advanced search, the infobox tabs) and Viewport only: the content of the other plugins (the floor plans widget, the map's settings tab) is added while they are registered, whenever they are, and removed with them, their widgets closed. Their toolbar items are disabled without them.

    Hierarchy

    • PluginBaseClass
      • PluginsUIPlugin
    Index

    Constructors

    Properties

    name: string

    Display name of the plugin

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

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

    Methods

    • Returns void

    • Teia (the advanced search, the infobox tabs) and the viewport.

      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