Dockview
    Preparing search index...

    Interface IGridviewComponent

    interface IGridviewComponent {
        activeGroup: GridviewPanel<GridviewPanelApiImpl> | undefined;
        element: HTMLElement;
        groups: GridviewPanel<GridviewPanelApiImpl>[];
        height: number;
        id: string;
        maximumHeight: number;
        maximumWidth: number;
        minimumHeight: number;
        minimumWidth: number;
        onDidActiveGroupChange: DockviewEvent<
            GridviewPanel<GridviewPanelApiImpl>
            | undefined,
        >;
        onDidAddGroup: DockviewEvent<GridviewPanel<GridviewPanelApiImpl>>;
        onDidLayoutChange: DockviewEvent<void>;
        onDidLayoutFromJSON: DockviewEvent<void>;
        onDidMaximizedChange: DockviewEvent<
            MaximizedChanged<GridviewPanel<GridviewPanelApiImpl>>,
        >;
        onDidRemoveGroup: DockviewEvent<GridviewPanel<GridviewPanelApiImpl>>;
        orientation: Orientation;
        size: number;
        width: number;
        addPanel<T extends object = Parameters>(
            options: AddGridviewComponentOptions<T>,
        ): IGridviewPanel;
        clear(): void;
        dispose(): void;
        exitMaximizedGroup(): void;
        focus(): void;
        fromJSON(serializedGridview: SerializedGridviewComponent): void;
        getPanel(id: string): GridviewPanel<GridviewPanelApiImpl> | undefined;
        hasMaximizedGroup(): boolean;
        isMaximizedGroup(panel: GridviewPanel): boolean;
        isVisible(panel: GridviewPanel): boolean;
        layout(width: number, height: number, force?: boolean): void;
        maximizeGroup(panel: GridviewPanel): void;
        movePanel(
            panel: IGridviewPanel,
            options: { direction: Direction; reference: string; size?: number },
        ): void;
        removePanel(panel: IGridviewPanel, sizing?: Sizing): void;
        setActive(panel: IGridviewPanel): void;
        setVisible(panel: IGridviewPanel, visible: boolean): void;
        toJSON(): SerializedGridviewComponent;
        updateOptions(options: Partial<GridviewComponentOptions>): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    activeGroup element groups height id maximumHeight maximumWidth minimumHeight minimumWidth onDidActiveGroupChange onDidAddGroup onDidLayoutChange onDidLayoutFromJSON onDidMaximizedChange onDidRemoveGroup orientation size width

    Methods

    addPanel clear dispose exitMaximizedGroup focus fromJSON getPanel hasMaximizedGroup isMaximizedGroup isVisible layout maximizeGroup movePanel removePanel setActive setVisible toJSON updateOptions

    Properties

    activeGroup: GridviewPanel<GridviewPanelApiImpl> | undefined
    element: HTMLElement
    groups: GridviewPanel<GridviewPanelApiImpl>[]
    height: number
    id: string
    maximumHeight: number
    maximumWidth: number
    minimumHeight: number
    minimumWidth: number
    onDidActiveGroupChange: DockviewEvent<
        GridviewPanel<GridviewPanelApiImpl>
        | undefined,
    >
    onDidAddGroup: DockviewEvent<GridviewPanel<GridviewPanelApiImpl>>
    onDidLayoutChange: DockviewEvent<void>
    onDidLayoutFromJSON: DockviewEvent<void>
    onDidMaximizedChange: DockviewEvent<
        MaximizedChanged<GridviewPanel<GridviewPanelApiImpl>>,
    >
    onDidRemoveGroup: DockviewEvent<GridviewPanel<GridviewPanelApiImpl>>
    orientation: Orientation
    size: number
    width: number

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods