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

    Class AnomalyPlugin

    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

    constructor

    Properties

    identityApiClient name settings viewer ToolbarItems

    Methods

    clear dependencies hasSettings onRegister onUnregister Create

    Constructors

    Properties

    identityApiClient: ApiClient = ...

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

    name: string

    Display name of the plugin

    settings: { identityApiUrl: StringController }

    Plugin settings

    Type Declaration

    • identityApiUrl: StringController

      Url of the Teia identity API, used to suggest the users an anomaly can be assigned to

      ''
    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)[]

    • 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