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

    Plugin registering the TeiaAnomaly widget, used to create, list, edit, comment, document and export the anomalies of the loaded Twin or file, and to replay their scene. Open it with the ShowTeiaAnomalyMenuToolbarItem or an OpenAnomalyWidgetCommand.

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

    Hierarchy

    • PluginBaseClass
      • AnomalyPlugin
    Index

    Constructors

    Properties

    identityApiClient: ApiClient = ...

    Client of the Teia identity API, authenticated with the Teia plugin token

    name: string

    Display name of the plugin

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

    viewer: Viewer
    ToolbarItems: { ShowTeiaAnomalyMenuToolbarItem: () => Element } = ...

    Toolbar items provided by the plugin

    Type Declaration

    • ShowTeiaAnomalyMenuToolbarItem: () => Element

      Toolbar menu to create an anomaly from the current scene, open the anomalies list and import anomalies (.bcf, .bcfzip, .xls, .xlsx). Disabled when no Teia source is loaded.

    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