Interface DockviewGroupPanelApi

interface DockviewGroupPanelApi {
    component: string;
    height: number;
    id: string;
    isActive: boolean;
    isFocused: boolean;
    isVisible: boolean;
    location: DockviewGroupLocation;
    onDidActiveChange: DockviewEvent<ActiveEvent>;
    onDidActivePanelChange: DockviewEvent<DockviewGroupChangeEvent>;
    onDidConstraintsChange: DockviewEvent<GridConstraintChangeEvent>;
    onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>;
    onDidFocusChange: DockviewEvent<FocusEvent>;
    onDidLocationChange: DockviewEvent<DockviewGroupPanelFloatingChangeEvent>;
    onDidParametersChange: DockviewEvent<Parameters>;
    onDidVisibilityChange: DockviewEvent<VisibilityEvent>;
    onWillFocus: DockviewEvent<WillFocusEvent>;
    width: number;
    close(): void;
    exitMaximized(): void;
    getParameters<T>(): T;
    getWindow(): Window;
    isMaximized(): boolean;
    maximize(): void;
    moveTo(options): void;
    setActive(): void;
    setConstraints(value): void;
    setSize(event): void;
    setVisible(isVisible): void;
    updateParameters(parameters): void;
}

Hierarchy (view full)

Properties

component height id isActive isFocused isVisible location onDidActiveChange onDidActivePanelChange onDidConstraintsChange onDidDimensionsChange onDidFocusChange onDidLocationChange onDidParametersChange onDidVisibilityChange onWillFocus width

Methods

close exitMaximized getParameters getWindow isMaximized maximize moveTo setActive setConstraints setSize setVisible updateParameters

Properties

Readonly component

component: string

The id of the component renderer

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 isVisible

isVisible: boolean

Whether the panel is visible

Readonly location

location: DockviewGroupLocation

Readonly onDidActiveChange

onDidActiveChange: DockviewEvent<ActiveEvent>

Readonly onDidActivePanelChange

onDidActivePanelChange: DockviewEvent<DockviewGroupChangeEvent>

Readonly onDidConstraintsChange

onDidConstraintsChange: DockviewEvent<GridConstraintChangeEvent>

Readonly onDidDimensionsChange

onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>

Readonly onDidFocusChange

onDidFocusChange: DockviewEvent<FocusEvent>

Readonly onDidLocationChange

onDidLocationChange: DockviewEvent<DockviewGroupPanelFloatingChangeEvent>

Readonly onDidParametersChange

onDidParametersChange: DockviewEvent<Parameters>

Readonly onDidVisibilityChange

onDidVisibilityChange: DockviewEvent<VisibilityEvent>

Readonly onWillFocus

onWillFocus: DockviewEvent<WillFocusEvent>

Readonly width

width: number

The panel width in pixels

Methods

close

exitMaximized

getParameters

getWindow

isMaximized

maximize

moveTo

setActive

setConstraints

setSize

setVisible

updateParameters

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc