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

    Plugin registering the TeiaPatchData widget, used to create a Patch Data request (BIM properties modifications) on the selected objects of a Twin. Open it with the ShowTeiaPatchDataWidgetToolbarItem or an OpenWidgetCommand.

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

    Hierarchy

    • PluginBaseClass
      • PatchDataPlugin
    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: { ShowTeiaPatchDataWidgetToolbarItem: () => Element } = ...

    Toolbar items provided by the plugin

    Type Declaration

    • ShowTeiaPatchDataWidgetToolbarItem: () => Element

      Toolbar item opening the TeiaPatchDataWidget on the current selection. Disabled when the loaded source is not a Twin or when nothing is selected.

    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