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

    Interface WorkbenchPartRef

    Describes a part referenced in the perspective.

    interface WorkbenchPartRef {
        active?: boolean;
        cssClass?: string | string[];
        id: string;
        "ɵactivityId"?: `activity.${string}`;
        params?: { [name: string]: unknown };
        position: DockingArea | RelativeTo;
        qualifier: Qualifier;
    }
    Index

    Properties

    active?: boolean

    Controls whether to activate the part.

    cssClass?: string | string[]

    Specifies CSS class(es) to add to the part, e.g., to locate the part in tests.

    id: string

    Identifies the part. Use MAIN_AREA for the main area part.

    "ɵactivityId"?: `activity.${string}`

    Internal identifier for a docked part.

    Not public API. For internal use only.

    params?: { [name: string]: unknown }

    Defines data to pass to the part.

    The part can declare mandatory and optional parameters. No additional parameters are allowed. Refer to the documentation of the capability for more information.

    Positions the part, either docked or relative to another part.

    qualifier: Qualifier

    Specifies the WorkbenchPartCapability that provides the content of the part.

    Declaring an intention allows for referencing public part capabilities of other applications.

    If the part capability cannot be resolved, the part is omitted, allowing conditional display, for example, based on user permissions.