Dockview
    Preparing search index...

    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 extends Parameters = Parameters>(): T;
        setActive(): void;
        setConstraints(value: PanelConstraintChangeEvent2): void;
        setExpanded(isExpanded: boolean): void;
        setSize(event: PanelSizeEvent): void;
        setVisible(isVisible: boolean): void;
        updateParameters(parameters: Parameters): void;
    }

    Hierarchy (View Summary)

    Index

    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

    component: string

    The id of the component renderer

    height: number

    The panel height in pixels

    id: string

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

    isActive: boolean

    Whether the panel is the actively selected panel

    isExpanded: boolean
    isFocused: boolean

    Whether the panel holds the current focus

    isVisible: boolean

    Whether the panel is visible

    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

    The panel width in pixels

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods