IgniteUI Dock Manager

All
  • Public
  • Public/Protected
  • All

Class IgcDockManagerComponent

Describes a Dock Manager component.

Hierarchy

  • HTMLElement
    • IgcDockManagerComponent

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns IgcDockManagerComponent

Properties

activePane

activePane: IgcContentPane

Gets/sets the active pane of the Dock Manager.

allowFloatingPanesResize

allowFloatingPanesResize: boolean

Determines whether the end user is allowed to resize floating panes. Defaults to true.

Optional allowInnerDock

allowInnerDock?: boolean

Determines whether the end user is allowed to inner dock panes. Defaults to true.

allowMaximize

allowMaximize: boolean

Determines whether the end user is allowed to maximize panes. Defaults to true.

closeBehavior

closeBehavior: IgcPaneActionBehavior

Determines whether the selected pane or all panes are closed when clicking the close button of a pane within a dockable TabGroup. Defaults to 'allPanes'.

containedInBoundaries

containedInBoundaries: boolean

Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to false.

disableKeyboardNavigation

disableKeyboardNavigation: boolean

Disables the built-in keyboard shortcuts for pane navigation. Defaults to false.

draggedPane

draggedPane: IgcContentPane | IgcSplitPane | IgcTabGroupPane

Gets/sets the currently dragged pane.

dropPosition

dropPosition: IgcDockManagerPoint

Gets/sets the current drop position when performing custom drag/drop.

layout

layout: IgcDockManagerLayout

Gets/sets the layout configuration of the Dock Manager.

maximizedPane

maximizedPane: IgcContentPane | IgcSplitPane | IgcTabGroupPane

Gets/sets the maximized pane.

Optional proximityDock

proximityDock?: boolean

Determines whether the end user can dock the dragged pane by dragging it close to the target pane edges. If enabled, docking indicators are not visible. Defaults to false.

resourceStrings

resourceStrings: IgcDockManagerResourceStrings

Gets/sets the resource strings.

showHeaderIconOnHover

showHeaderIconOnHover: "closeOnly" | "moreOptionsOnly" | "all"

Determines which tab header icons should show when hovering over the tab with the mouse. Defaults to undefined.

showPaneHeaders

showPaneHeaders: "onHoverOnly" | "always"

Determines whether pane headers are only shown on hover or always visible. Defaults to 'always'.

unpinBehavior

unpinBehavior: IgcPaneActionBehavior

Determines whether the selected pane or all panes are unpinned when clicking the unpin button of a pane within a dockable TabGroup. Defaults to 'allPanes'.

Methods

addEventListener

  • addEventListener<K>(type: K, listener: ((this: HTMLElement, ev: IgcDockManagerEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

dropPane

  • dropPane(): Promise<boolean>

focusPane

  • focusPane(contentId: string): Promise<void>

removeEventListener

  • removeEventListener<K>(type: K, listener: ((this: HTMLElement, ev: IgcDockManagerEventMap[K]) => any), options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

removePane