Interface DockviewPanelApi

interface DockviewPanelApi {
    component: string;
    group: DockviewGroupPanel;
    height: number;
    id: string;
    isActive: boolean;
    isFocused: boolean;
    isGroupActive: boolean;
    isVisible: boolean;
    location: DockviewGroupLocation;
    onDidActiveChange: DockviewEvent<ActiveEvent>;
    onDidActiveGroupChange: DockviewEvent<ActiveGroupEvent>;
    onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>;
    onDidFocusChange: DockviewEvent<FocusEvent>;
    onDidGroupChange: DockviewEvent<GroupChangedEvent>;
    onDidLocationChange: DockviewEvent<DockviewGroupPanelFloatingChangeEvent>;
    onDidParametersChange: DockviewEvent<Parameters>;
    onDidRendererChange: DockviewEvent<RendererChangedEvent>;
    onDidTitleChange: DockviewEvent<TitleEvent>;
    onDidVisibilityChange: DockviewEvent<VisibilityEvent>;
    onWillFocus: DockviewEvent<WillFocusEvent>;
    renderer: DockviewPanelRenderer;
    tabComponent: undefined | string;
    title: undefined | string;
    width: number;
    close(): void;
    exitMaximized(): void;
    getParameters<T>(): T;
    getWindow(): Window;
    isMaximized(): boolean;
    maximize(): void;
    moveTo(options): void;
    setActive(): void;
    setRenderer(renderer): void;
    setSize(event): void;
    setTitle(title): void;
    updateParameters(parameters): void;
}

Hierarchy

  • Omit<GridviewPanelApi, "setVisible" | "onDidConstraintsChange" | "setConstraints">
    • DockviewPanelApi

Properties

component group height id isActive isFocused isGroupActive isVisible location onDidActiveChange onDidActiveGroupChange onDidDimensionsChange onDidFocusChange onDidGroupChange onDidLocationChange onDidParametersChange onDidRendererChange onDidTitleChange onDidVisibilityChange onWillFocus renderer tabComponent title width

Methods

close exitMaximized getParameters getWindow isMaximized maximize moveTo setActive setRenderer setSize setTitle updateParameters

Properties

Readonly component

component: string

The id of the component renderer

Readonly group

group: DockviewGroupPanel

Readonly height

height: number

The panel height in pixels

Readonly id

id: string

The id of the panel that would have been assigned when the panel was created

Readonly isActive

isActive: boolean

Whether the panel is the actively selected panel

Readonly isFocused

isFocused: boolean

Whether the panel holds the current focus

Readonly isGroupActive

isGroupActive: boolean

Readonly isVisible

isVisible: boolean

Whether the panel is visible

Readonly location

location: DockviewGroupLocation

Readonly onDidActiveChange

onDidActiveChange: DockviewEvent<ActiveEvent>

Readonly onDidActiveGroupChange

onDidActiveGroupChange: DockviewEvent<ActiveGroupEvent>

Readonly onDidDimensionsChange

onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>

Readonly onDidFocusChange

onDidFocusChange: DockviewEvent<FocusEvent>

Readonly onDidGroupChange

onDidGroupChange: DockviewEvent<GroupChangedEvent>

Readonly onDidLocationChange

onDidLocationChange: DockviewEvent<DockviewGroupPanelFloatingChangeEvent>

Readonly onDidParametersChange

onDidParametersChange: DockviewEvent<Parameters>

Readonly onDidRendererChange

onDidRendererChange: DockviewEvent<RendererChangedEvent>

Readonly onDidTitleChange

onDidTitleChange: DockviewEvent<TitleEvent>

Readonly onDidVisibilityChange

onDidVisibilityChange: DockviewEvent<VisibilityEvent>

Readonly onWillFocus

onWillFocus: DockviewEvent<WillFocusEvent>

Readonly renderer

renderer: DockviewPanelRenderer

Readonly tabComponent

tabComponent: undefined | string

The id of the tab component renderer

Undefined if no custom tab renderer is provided

Readonly title

title: undefined | string

Readonly width

width: number

The panel width in pixels

Methods

close

exitMaximized

getParameters

getWindow

isMaximized

maximize

moveTo

setActive

setRenderer

setSize

setTitle

updateParameters

  • updateParameters(parameters): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc