Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace app

The client application that is running the extension.

Index

Variables

Const activeWindow

activeWindow: Window | undefined

The currently active window, or undefined. The active window is the window that has focus, or when none has focus, the window that was most recently focused.

Const activeWindowChanges

activeWindowChanges: Subscribable<Window | undefined>

An event that is fired when the currently active window changes.

Const windows

windows: Window[]

All application windows that are accessible by the extension.

readonly

Functions

createDecorationType

createPanelView

  • Create a panel view for the view contribution with the given {@link id}.

    todo

    Consider requiring extensions to specify these statically in package.json's contributions section to improve the activation experience.

    Parameters

    • id: string

      The ID of the view. This may be shown to the user (e.g., in the URL fragment when the panel is active).

    Returns PanelView

    The panel view.

createStatusBarItemType

  • Creates a statusBarItemType that can be used to add a status bar item to the status bar of code views.

    Use this to create a unique handle to a status bar item, that can be applied to text editors using setStatusBarItem.

    Returns StatusBarItemType

log

  • log(message?: any, ...optionalParams: any[]): void
  • Log a message to the console if logs for the extension are enabled in user settings.

    Messages are automatically prefixed by the extension's ID.

    Note that messages may be transferred via the structured clone algorithm. Ensure that your messages are cloneable

    Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

registerFileDecorationProvider

registerViewProvider

  • Register a view provider, which provides the contents of a view.

    This API is experimental and is subject to change or removal without notice.

    Parameters

    • id: string

      The ID of the view.

    • provider: ViewProvider

      A view provider.

    Returns Unsubscribable

    An unsubscribable to unregister this provider.

Generated using TypeDoc