Panels in the aiWARE SDK

A panel is a UI element that exposes a core function of the system. Unlike widgets, panels are often mounted and unmounted as needed, whereas widgets usually remain on the screen permanently. Panels are typically used with the App bar widget.

Available panels

Each panel in the SDK contains a standard interface, a set of features, and configurations you can use to customize the panel.
The available panels are:

Help panels

• Documentation panel
• Knowledgebase panel

Utility panels

• Local machine importer panel

OS Center panels

• Admin Center panel
• Data Center panel
• Processing Center panel
• Resource Center panel

Mount a panel

To display any of the OS Center panels or the Local machine importer panel in the app, use the mountPanel() method.

[Tip] To see a list of all mounted panels in the console, run aiware.store.getState().panels.

• Call aiware.mountPanel().

Parameters

The parameters of mountPanel() are an object with these properties:

microFrontend

panelConfig

This example defines microFrontend and panelConfig, then it mounts the Local machine importer panel.

    const microFrontend = {
      name: 'DATA_CENTER_IMPORTER',
      config: {
        name: 'Local Importer',
      },
    };
    const panelConfig = {
      type: 'APP_BAR_PANEL_TEMPLATE',
      marginTop: 55,
      marginStart: 80,
      size: 'large',
      zIndex: 1000,
      dimmed: 0,
    };
    aiware.mountPanel({
      panelId: 'DATA_CENTER_IMPORTER',
      microFrontend: microFrontend,
      panelConfig: panelConfig,
    });

Unmount a panel

To stop a panel from displaying in the app, use the hidePanel() method.

• Call aiware.hidePanel().

Parameters

The parameters of hidePanel() are:

• To get started with the aiWARE SDK, see Set up the aiWARE SDK.
• For more information about widgets, see Widgets.
• To learn more about the App bar, see App bar widget.

• Developer's reference
• aiWARE SDK
• Panels in the aiWARE SDK

• Available panels
• Mount a panel
• Unmount a panel