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

    Class OpenDataPlugin

    Plugin registering the TeiaOpenData widget, used to create an Open Data (key/value properties) on the selected objects of a Twin. Open it with the ShowTeiaOpenDataWidgetToolbarItem or an OpenWidgetCommand.

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

    Hierarchy

    • PluginBaseClass
      • OpenDataPlugin
    Index

    Constructors

    constructor

    Properties

    name settings viewer ToolbarItems

    Methods

    clear dependencies hasSettings onRegister onUnregister Create

    Constructors

    • Parameters

      Returns OpenDataPlugin

    Properties

    name: string

    Display name of the plugin

    settings: {
        guidChunkSize: NumberController;
        maxPostRequestParallelism: NumberController;
    }

    Plugin settings

    Type Declaration

    • guidChunkSize: NumberController

      Maximum number of twin objects per Open Data request (bigger selections are split)

      1000
    • maxPostRequestParallelism: NumberController

      Maximum number of Open Data requests sent in parallel

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

    Toolbar items provided by the plugin

    Type Declaration

    • ShowTeiaOpenDataWidgetToolbarItem: () => Element

      Toolbar item opening the TeiaOpenDataWidget 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)[]

    • 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