Class ViewportPlugin

Hierarchy

PluginBaseClass
- ViewportPlugin

Index

Constructors

Properties

frameAlertController name settings spotlight viewer widgetController wrappers

Methods

clear dependencies hasSettings onRegister onUnregister Create

Constructors

constructor

new ViewportPlugin(
    viewer: Viewer,
    cfg?: RecursivePartial<
        ExtractValues<
            {
                disableToolbar: BooleanController;
                showObjectHierarchyBanner: BooleanController;
                showToolbar: BooleanController;
                treeViewPageSize: NumberController;
            },
        >,
    >,
): ViewportPlugin
Parameters
- viewer: Viewer
- Optionalcfg: RecursivePartial<
      ExtractValues<
          {
              disableToolbar: BooleanController;
              showObjectHierarchyBanner: BooleanController;
              showToolbar: BooleanController;
              treeViewPageSize: NumberController;
          },
      >,
  >
Returns ViewportPlugin
Inherited from PluginBaseClass.constructor
- Defined in packages/viewer/src/core/ViewerPlugin.ts:87

Properties

`Readonly`frameAlertController

frameAlertController: FrameAlertController = ...

`Readonly`name

name: string

Display name of the plugin

`Readonly`settings

settings: {
    disableToolbar: BooleanController;
    showObjectHierarchyBanner: BooleanController;
    showToolbar: BooleanController;
    treeViewPageSize: NumberController;
}

Plugin settings

Type Declaration

disableToolbar: BooleanController
Whether to disable the toolbar (if any added)
Default Value
```
false
```
showObjectHierarchyBanner: BooleanController
Whether the selected object hierarchy banner is open by default
Default Value
```
false
```
showToolbar: BooleanController
Whether to show the toolbar (if any added)
Default Value
```
true
```
treeViewPageSize: NumberController
Default number of children displayed per parent in the tree view, also the size of added children
Default Value
```
30
```
Min
1

Max
30

`Readonly`spotlight

spotlight: Spotlight = ...

`Readonly`viewer

viewer: Viewer

`Readonly`widgetController

widgetController: WidgetController = ...

`Readonly`wrappers

wrappers: ObservableSet<FunctionComponent<{}>> = ...

Methods

clear

clear(): void
Returns void
Inherited from PluginBaseClass.clear
- Defined in packages/viewer/src/core/ViewerPlugin.ts:78

dependencies

dependencies(): readonly "Viewport"[]
List of plugins this plugin depends on

Returns readonly "Viewport"[]
Inherited from PluginBaseClass.dependencies
- Defined in packages/viewer/src/core/ViewerPlugin.ts:60

hasSettings

hasSettings(): boolean
Indicates whether the plugin has settings

Returns boolean
Inherited from PluginBaseClass.hasSettings
- Defined in packages/viewer/src/core/ViewerPlugin.ts:52

onRegister

onRegister(): void
Called when the plugin is registered in the viewer.

Returns void
Overrides PluginBaseClass.onRegister
- Defined in packages/viewport/src/ViewportPlugin.tsx:74

onUnregister

onUnregister(): void
Called when the plugin is unregistred from the viewer.

Returns void
Overrides PluginBaseClass.onUnregister
- Defined in packages/viewport/src/ViewportPlugin.tsx:88

`Static`Create

Create<S extends SettingsRecord = Record<string, never>>(
name: string,
settingFunc?: PluginSettingBuildFunction<S>,
): typeof PluginClass
Type Parameters
- S extends SettingsRecord = Record<string, never>
Parameters
- name: string
- settingFunc: PluginSettingBuildFunction<S> = ...
Returns typeof PluginClass
Inherited from PluginBaseClass.Create
- Defined in packages/viewer/src/core/ViewerPlugin.ts:82