Interface PaneviewPanelApi

interface PaneviewPanelApi {
    component: string;
    height: number;
    id: string;
    isActive: boolean;
    isExpanded: boolean;
    isFocused: boolean;
    isVisible: boolean;
    onDidActiveChange: DockviewEvent<ActiveEvent>;
    onDidConstraintsChange: DockviewEvent<PanelConstraintChangeEvent>;
    onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>;
    onDidExpansionChange: DockviewEvent<ExpansionEvent>;
    onDidFocusChange: DockviewEvent<FocusEvent>;
    onDidParametersChange: DockviewEvent<Parameters>;
    onDidVisibilityChange: DockviewEvent<VisibilityEvent>;
    onMouseEnter: DockviewEvent<MouseEvent>;
    onMouseLeave: DockviewEvent<MouseEvent>;
    onWillFocus: DockviewEvent<WillFocusEvent>;
    width: number;
    getParameters<T>(): T;
    setActive(): void;
    setConstraints(value): void;
    setExpanded(isExpanded): void;
    setSize(event): void;
    setVisible(isVisible): void;
    updateParameters(parameters): void;
}

Hierarchy (view full)

Properties

component height id isActive isExpanded isFocused isVisible onDidActiveChange onDidConstraintsChange onDidDimensionsChange onDidExpansionChange onDidFocusChange onDidParametersChange onDidVisibilityChange onMouseEnter onMouseLeave onWillFocus width

Methods

getParameters setActive setConstraints setExpanded 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 isExpanded

isExpanded: boolean

Readonly isFocused

isFocused: boolean

Whether the panel holds the current focus

Readonly isVisible

isVisible: boolean

Whether the panel is visible

Readonly onDidActiveChange

onDidActiveChange: DockviewEvent<ActiveEvent>

Readonly onDidConstraintsChange

onDidConstraintsChange: DockviewEvent<PanelConstraintChangeEvent>

Readonly onDidDimensionsChange

onDidDimensionsChange: DockviewEvent<PanelDimensionChangeEvent>

Readonly onDidExpansionChange

onDidExpansionChange: DockviewEvent<ExpansionEvent>

Readonly onDidFocusChange

onDidFocusChange: DockviewEvent<FocusEvent>

Readonly onDidParametersChange

onDidParametersChange: DockviewEvent<Parameters>

Readonly onDidVisibilityChange

onDidVisibilityChange: DockviewEvent<VisibilityEvent>

Readonly onMouseEnter

onMouseEnter: DockviewEvent<MouseEvent>

Readonly onMouseLeave

onMouseLeave: DockviewEvent<MouseEvent>

Readonly onWillFocus

onWillFocus: DockviewEvent<WillFocusEvent>

Readonly width

width: number

The panel width in pixels

Methods

getParameters

setActive

setConstraints

setExpanded

setSize

setVisible

updateParameters

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc