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

    Plugin saving selections of a Twin as selection filters, and registering the TeiaSelectionRecord widget listing them. Use its toolbar items to save the selection and to open the widget.

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

    Hierarchy

    • PluginBaseClass
      • SelectionInfoPlugin
    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: {
        SaveSelectionToolbarItem: () => Element;
        ShowTeiaSelectionRecordWidgetToolbarItem: () => Element;
    } = ...

    Toolbar items provided by the plugin

    Type Declaration

    • SaveSelectionToolbarItem: () => Element

      Toolbar item saving the current selection as a selection filter of the Twin project. Disabled when the loaded source is not a Twin or when nothing is selected.

    • ShowTeiaSelectionRecordWidgetToolbarItem: () => Element

      Toolbar item opening the TeiaSelectionRecordWidget. Disabled when the loaded source is not a Twin.

    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