Interface PerspectiveService

ReadonlyonDidChangePerspective

getActivePerspective

• getActivePerspective(): undefined | PerspectiveDescriptor

  Returns the descriptor of the currently active perspective, or undefined if none.

  Returns undefined | PerspectiveDescriptor

getActivePerspectiveId

• getActivePerspectiveId(): string

  Returns the ID of the currently active perspective. A convenient alternative to getActivePerspective()?.id that always returns a string.

  Returns string

getAreaForView

• getAreaForView(viewId: string): undefined | Area

  Returns the target shell area for a widget in the active perspective, or undefined if unmapped.

  Parameters

  • viewId: string

  Returns undefined | Area

getRegisteredPerspectives

• getRegisteredPerspectives(): PerspectiveDescriptor[]

  Returns all registered perspective descriptors.

  Returns PerspectiveDescriptor[]

registerPerspective

• registerPerspective(descriptor: PerspectiveDescriptor): void

  Registers a new perspective descriptor. Contributions should call this from their PerspectiveContribution.registerPerspectives callback.

  Parameters

  • descriptor: PerspectiveDescriptor

  Returns void

resetCurrentPerspective

• resetCurrentPerspective(): Promise<void>

  Resets the active perspective to its programmatic state (viewPlacements from its descriptor), discarding the saved layout. Does not affect other perspectives.

  Returns Promise<void>

switchPerspective

• switchPerspective(id: string): Promise<void>

  Switches the workbench to the given perspective. Saves the current perspective's layout, then restores the target perspective's layout (or applies its viewPlacements on first activation). Concurrent calls are serialized.

  Parameters

  • id: string

  Returns Promise<void>