Class WidgetFactory

The WidgetFactory handles all the type of widgets that can be display on the viewer. Use the registerWidget method to register (override) the widget to display for a given widget type.

Index

Constructors

constructor

Methods

createWidget registerWidget

Constructors

constructor

new WidgetFactory(): WidgetFactory
Returns WidgetFactory

Methods

createWidget

createWidget<
    TType extends keyof ViewerWidgetRegistry,
    TFunction extends

            | WidgetFactoryFunction<InfoBoxWidget, InfoBoxWidgetOptions>
            | WidgetFactoryFunction<SettingsWidget>
            | WidgetFactoryFunction<TeiaAdvancedSearchWidget>
            | WidgetFactoryFunction<ProjectionWidget>
            | WidgetFactoryFunction<DevStatsWidget>
            | WidgetFactoryFunction<DevToolsWidget>
            | WidgetFactoryFunction<TreeViewWidget>
            | WidgetFactoryFunction<ObjectTransformWidget>
            | WidgetFactoryFunction<CommandHistoryWidget>
            | WidgetFactoryFunction<NotificationCenterWidget>,
    TWidget extends
        | InfoBoxWidget
        | SettingsWidget
        | TeiaAdvancedSearchWidget
        | ProjectionWidget
        | DevStatsWidget
        | DevToolsWidget
        | TreeViewWidget
        | ObjectTransformWidget
        | CommandHistoryWidget
        | NotificationCenterWidget,
    TParams extends
        []
        | [params: InfoBoxWidgetOptions]
        | [params: StandardWidgetOptions],
>(
    type: TType,
    ...params: TParams,
): TWidget
Creates the widgets of the given type with the registered params
Type Parameters
- TType extends keyof ViewerWidgetRegistry
- TFunction extends
      | WidgetFactoryFunction<InfoBoxWidget, InfoBoxWidgetOptions>
      | WidgetFactoryFunction<SettingsWidget>
      | WidgetFactoryFunction<TeiaAdvancedSearchWidget>
      | WidgetFactoryFunction<ProjectionWidget>
      | WidgetFactoryFunction<DevStatsWidget>
      | WidgetFactoryFunction<DevToolsWidget>
      | WidgetFactoryFunction<TreeViewWidget>
      | WidgetFactoryFunction<ObjectTransformWidget>
      | WidgetFactoryFunction<CommandHistoryWidget>
      | WidgetFactoryFunction<NotificationCenterWidget>
- TWidget extends
      | InfoBoxWidget
      | SettingsWidget
      | TeiaAdvancedSearchWidget
      | ProjectionWidget
      | DevStatsWidget
      | DevToolsWidget
      | TreeViewWidget
      | ObjectTransformWidget
      | CommandHistoryWidget
      | NotificationCenterWidget
- TParams extends [] | [params: InfoBoxWidgetOptions] | [params: StandardWidgetOptions]
Parameters
- type: TType
  The type of widget to create
- ...params: TParams
  The params used by the widget
Returns TWidget
- Defined in src/viewer/widgets/base/WidgetFactory.tsx:90

registerWidget

registerWidget<
    TType extends keyof ViewerWidgetRegistry,
    TFunction extends

            | WidgetFactoryFunction<InfoBoxWidget, InfoBoxWidgetOptions>
            | WidgetFactoryFunction<SettingsWidget>
            | WidgetFactoryFunction<TeiaAdvancedSearchWidget>
            | WidgetFactoryFunction<ProjectionWidget>
            | WidgetFactoryFunction<DevStatsWidget>
            | WidgetFactoryFunction<DevToolsWidget>
            | WidgetFactoryFunction<TreeViewWidget>
            | WidgetFactoryFunction<ObjectTransformWidget>
            | WidgetFactoryFunction<CommandHistoryWidget>
            | WidgetFactoryFunction<NotificationCenterWidget>,
    TCreateFunction extends
        | (
            (params: InfoBoxWidgetOptions & CreateWidgetOptions) => InfoBoxWidget
        )
        | (
            (
                params: StandardWidgetOptions & CreateWidgetOptions,
            ) => SettingsWidget
        )
        | (
            (
                params: StandardWidgetOptions & CreateWidgetOptions,
            ) => TeiaAdvancedSearchWidget
        )
        | (
            (
                params: StandardWidgetOptions & CreateWidgetOptions,
            ) => ProjectionWidget
        )
        | (
            (
                params: StandardWidgetOptions & CreateWidgetOptions,
            ) => DevStatsWidget
        )
        | (
            (
                params: StandardWidgetOptions & CreateWidgetOptions,
            ) => DevToolsWidget
        )
        | (
            (
                params: StandardWidgetOptions & CreateWidgetOptions,
            ) => TreeViewWidget
        )
        | (
            (
                params: StandardWidgetOptions & CreateWidgetOptions,
            ) => ObjectTransformWidget
        )
        | (
            (
                params: StandardWidgetOptions & CreateWidgetOptions,
            ) => CommandHistoryWidget
        )
        | (
            (
                params: StandardWidgetOptions & CreateWidgetOptions,
            ) => NotificationCenterWidget
        ),
>(
    type: TType,
    createFunction: TCreateFunction,
): void
Registers the callback function to create the given widget type into the factory
Type Parameters
- TType extends keyof ViewerWidgetRegistry
- TFunction extends
      | WidgetFactoryFunction<InfoBoxWidget, InfoBoxWidgetOptions>
      | WidgetFactoryFunction<SettingsWidget>
      | WidgetFactoryFunction<TeiaAdvancedSearchWidget>
      | WidgetFactoryFunction<ProjectionWidget>
      | WidgetFactoryFunction<DevStatsWidget>
      | WidgetFactoryFunction<DevToolsWidget>
      | WidgetFactoryFunction<TreeViewWidget>
      | WidgetFactoryFunction<ObjectTransformWidget>
      | WidgetFactoryFunction<CommandHistoryWidget>
      | WidgetFactoryFunction<NotificationCenterWidget>
- TCreateFunction extends
      | (
          (params: InfoBoxWidgetOptions & CreateWidgetOptions) => InfoBoxWidget
      )
      | ((params: StandardWidgetOptions & CreateWidgetOptions) => SettingsWidget)
      | (
          (
              params: StandardWidgetOptions & CreateWidgetOptions,
          ) => TeiaAdvancedSearchWidget
      )
      | (
          (
              params: StandardWidgetOptions & CreateWidgetOptions,
          ) => ProjectionWidget
      )
      | ((params: StandardWidgetOptions & CreateWidgetOptions) => DevStatsWidget)
      | ((params: StandardWidgetOptions & CreateWidgetOptions) => DevToolsWidget)
      | ((params: StandardWidgetOptions & CreateWidgetOptions) => TreeViewWidget)
      | (
          (
              params: StandardWidgetOptions & CreateWidgetOptions,
          ) => ObjectTransformWidget
      )
      | (
          (
              params: StandardWidgetOptions & CreateWidgetOptions,
          ) => CommandHistoryWidget
      )
      | (
          (
              params: StandardWidgetOptions & CreateWidgetOptions,
          ) => NotificationCenterWidget
      )
Parameters
- type: TType
  The type of the widget to register the creation fonction
- createFunction: TCreateFunction
  The callback function
Returns void
- Defined in src/viewer/widgets/base/WidgetFactory.tsx:76

Class WidgetFactory

Index

Constructors

Methods

Constructors

constructor

Returns WidgetFactory

Methods

createWidget

Type Parameters

Parameters

Returns TWidget

registerWidget

Type Parameters

Parameters

Returns void

Settings

On This Page