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

    Class QuantityTakeoffPlugin

    Plugin registering the TeiaQuantityTakeoff widget, displaying the quantity take-off of the objects of a Twin. Open it with the ShowTeiaQuantityTakeoffWidgetToolbarItem or an OpenWidgetCommand.

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

    Hierarchy

    • PluginBaseClass
      • QuantityTakeoffPlugin
    Index

    Constructors

    constructor

    Properties

    name settings viewer ToolbarItems

    Methods

    clear dependencies hasSettings onRegister onUnregister Create

    Constructors

    Properties

    name: string

    Display name of the plugin

    settings: { maxObjectsLimit: NumberController }

    Plugin settings

    Type Declaration

    • maxObjectsLimit: NumberController

      Maximum number of selected objects the quantity take-off can be opened on

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

    Toolbar items provided by the plugin

    Type Declaration

    • ShowTeiaQuantityTakeoffWidgetToolbarItem: () => Element

      Toolbar item opening the TeiaQuantityTakeoffWidget on the current selection, or on all the objects without selection. Disabled when the loaded source is not a Twin or when the selection exceeds the maxObjectsLimit setting of the plugin.

    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