Class DockLayout

Hierarchy

DockPortalManager
- DockLayout

Implements

DockContext

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DockLayout(props: LayoutProps): DockLayout

Overrides DockPortalManager.constructor
- Defined in DockLayout.tsx:365
Parameters
- props: LayoutProps
Returns DockLayout

Properties

_isMounted

_isMounted: boolean = false

_onWindowResize

_onWindowResize: any = ...

_pendingDestroy

_pendingDestroy: any

Methods

destroyRemovedPane

destroyRemovedPane(): void

Inherited from DockPortalManager.destroyRemovedPane
- Defined in DockLayout.tsx:118
Returns void

dockMove

dockMove(source: TabData | PanelData, target: string | TabData | PanelData | BoxData, direction: DropDirection, floatPosition?: FloatPosition): void

Implementation of DockContext.dockMove
- Defined in DockLayout.tsx:216
Move a tab or a panel, if source or target is already in the layout, you can use the find method to get it with id first

Parameters
- source: TabData | PanelData
  
  @inheritDoc
- target: string | TabData | PanelData | BoxData
  
  @inheritDoc
- direction: DropDirection
  
  @inheritDoc
- Optional floatPosition: FloatPosition
  
  @inheritDoc
Returns void

find

find(id: string, filter?: Filter): TabData | PanelData | BoxData

Implementation of DockContext.find
- Defined in DockLayout.tsx:280
Find PanelData or TabData by id

Parameters
- id: string
- Optional filter: Filter
Returns TabData | PanelData | BoxData

getGroup

getGroup(name: string): TabGroup

Implementation of DockContext.getGroup
- Defined in DockLayout.tsx:196
Get the TabGroup defined in defaultLayout

Parameters
- name: string
Returns TabGroup

getLayout

getLayout(): LayoutData

- Defined in DockLayout.tsx:577
Returns LayoutData

loadLayout

loadLayout(savedLayout: LayoutBase): void

- Defined in DockLayout.tsx:624
load layout calling this api won't trigger the LayoutProps.onLayoutChange callback

Parameters
- savedLayout: LayoutBase
Returns void

navigateToPanel

navigateToPanel(fromElement?: HTMLElement, direction?: string): void

Implementation of DockContext.navigateToPanel
- Defined in DockLayout.tsx:328
Move focus to a dockpanel nearby

Parameters
- Optional fromElement: HTMLElement
- Optional direction: string
Returns void

saveLayout

saveLayout(): LayoutBase

- Defined in DockLayout.tsx:616
Returns LayoutBase

setLayout

setLayout(layout: LayoutData): void

- Defined in DockLayout.tsx:572
Parameters
- layout: LayoutData
Returns void

updateTab

updateTab(id: string, newTab: TabData, makeActive?: boolean): boolean

Implementation of DockContext.updateTab
- Defined in DockLayout.tsx:293
Update a tab with new TabData

Parameters
- id: string
  
  tab id to update
- newTab: TabData
  
  new tab data, if newTab is null, it only changes the active tab of parent panel
- makeActive: boolean = true
  
  whether to make the tab the active child of parent panel
Returns boolean

Static getDerivedStateFromProps

getDerivedStateFromProps(props: LayoutProps, state: LayoutState): { layout: LayoutData }

- Defined in DockLayout.tsx:643
Parameters
- props: LayoutProps
- state: LayoutState
Returns { layout: LayoutData }
- layout: LayoutData

Generated using TypeDoc