SCION Workbench Client - v1.0.0-beta.35
    Preparing search index...

    Interface WorkbenchPerspectiveCapability

    Defines a perspective in the SCION Workbench.

    A perspective defines an arrangement of parts and views. Parts can be docked to the side or positioned relative to each other. Views are stacked in parts. Content can be displayed in both parts and views.

    Users can personalize the layout of a perspective and switch between perspectives. The workbench remembers the layout of a perspective, restoring it the next time it is activated.

    A typical perspective has a main area part and parts docked to the side, providing navigation and context-sensitive assistance to support the user's workflow. The main area part is where the workbench opens views by default and is shared between perspectives. Its layout is not reset when resetting perspectives.

    Each part must be assigned a unique ID. The ID is used to align parts relative to each other, open views in a specific part, and, if main-area, mark the part as the main area part.

    A part references a part capability that specifies its content, either a microfrontend, a stack of views, or both. If both, the microfrontend is displayed only if the view stack is empty. Views in a docked part cannot be dragged into or out of docked parts.

    Declaring an intention allows for referencing public part capabilities of other applications. If a part capability cannot be resolved, the part is omitted, allowing conditional display, for example, based on user permissions.

    Example: - Main area with two docked parts

    {
      "type": "perspective",
      "qualifier": {
        "perspective": "sample-perspective"
      },
      "properties": {
        "parts": [
          {
            "id": "main-area",
            "qualifier": {"part": "main-area"}
          },
          {
            "id": "navigator",
            "qualifier": {"part": "navigator"},
            "position": "left-top"
          },
          {
            "id": "find",
            "qualifier": {"part": "find"},
            "position": "bottom-left",
          }
        ]
      }
    }

    Layout of above definition:

    +-+------------+-----------------+
|x| navigator  |    main-area    |
| | (left-top) |                 |
| |            |                 |
| |            |                 |
| |------------+-----------------|
|x| find (bottom-left)           |
+-+------------------------------+

    Example: - Main area with a part aligned relative to a docked part

    {
      "type": "perspective",
      "qualifier": {
        "perspective": "sample-perspective"
      },
      "properties": {
        "parts": [
          {
            "id": "main-area",
            "qualifier": {"part": "main-area"}
          },
          {
            "id": "navigator",
            "qualifier": {"part": "navigator"},
            "position": "left-top"
          },
          {
            "id": "detail",
            "qualifier": {"part": "detail"},
            "position": {"align": "bottom", "relativeTo": "navigator"}
          }
        ]
      }
    }

    Layout of above definition:

    +-+------------+-----------------+
|x| navigator  |    main-area    |
| | (left-top) |                 |
| |            |                 |
| |------------+                 |
| | detail     |                 |
| | (bottom of |                 |
| | navigator) |                 |
+-+------------+-----------------+

    Example: - Main area with parts aligned relative to the main area

    {
      "type": "perspective",
      "qualifier": {
        "perspective": "sample-perspective"
      },
      "properties": {
        "parts": [
          {
            "id": "main-area",
            "qualifier": {"part": "main-area"}
          },
          {
            "id": "navigator",
            "qualifier": {"part": "navigator"},
            "position": {"align": "left", "relativeTo": "main-area", "ratio": 0.25}
          },
          {
            "id": "find",
            "qualifier": {"part": "find"},
            "position": {"align": "bottom", "relativeTo": "main-area"}
          }
        ]
      }
    }

    Layout of above definition:

    +------------+---------------+
| navigator  |   main-area   |
| (left of   |               |
| main-area) |               |
|            |               |
|            +---------------+
|            |     find      |
|            |  (bottom of   |
|            |  main-area)   |
+------------+---------------+
    interface WorkbenchPerspectiveCapability {
        properties: {
            data?: { [key: string]: unknown };
            parts: [Omit<WorkbenchPartRef, "position">, ...WorkbenchPartRef[]];
        };
        qualifier: Qualifier;
        type: Perspective;
    }

    Hierarchy

    • Capability
      • WorkbenchPerspectiveCapability
    Index

    Properties

    properties qualifier type

    Properties

    properties: {
        data?: { [key: string]: unknown };
        parts: [Omit<WorkbenchPartRef, "position">, ...WorkbenchPartRef[]];
    }

    Type Declaration

    • Optionaldata?: { [key: string]: unknown }

      Associates arbitrary data with the perspective, e.g., a label, icon or tooltip.

      The workbench host application can read associated data plus metadata about the perspective from WorkbenchPerspective.data. See WorkbenchPerspectiveData for metadata set by the SCION Workbench.

    • parts: [Omit<WorkbenchPartRef, "position">, ...WorkbenchPartRef[]]

      Defines the arrangement of parts.

      Parts can be docked to the side or positioned relative to each other.

      The first part cannot be positioned and is typically the main area part. The main area part is a special part with main-area as its id. The main area is where the workbench opens views by default. It is shared between perspectives and its layout is not reset when resetting perspectives.

    qualifier: Qualifier

    Qualifies this perspective. The qualifier is required for a perspective.

    type: Perspective

    Settings

    Member Visibility

    On This Page

    Properties