Dockview
    Preparing search index...

    Class DockviewAngularComponent

    Implements

    • OnInit
    • OnDestroy
    • OnChanges
    Index

    Constructors

    constructor

    Properties

    className? components debug? defaultHeaderPosition? defaultRenderer? defaultTabComponent? defaultTabComponent_? didDrop disableAutoResizing? disableDnd? disableFloatingGroups? disableTabsOverflowList? dndCompass? dndEdges? dndStrategy? dropPositionResolver? floatingGroupBounds? getTabContextMenuItems? getTabGroupChipContextMenuItems? groupDragGhostComponent? hideBorders? leftHeaderActionsComponent? locked? nonce? noPanelsOverlay? orientation? overflow? pinnedTabs? popoutUrl? prefixHeaderActionsComponent? ready rightHeaderActionsComponent? scrollbars? singleTabMode? smartGuides? tabComponents? tabGroupAccent? tabGroupChipComponent? tabGroupColors? tabHeight? theme? watermarkComponent? willDrop

    Methods

    getDockviewApi ngOnChanges ngOnDestroy ngOnInit

    Constructors

    Properties

    className?: string
    components: Record<string, Type<any> | TemplateRef<any>>
    debug?: boolean
    defaultHeaderPosition?: DockviewHeaderPosition
    defaultRenderer?: DockviewPanelRenderer
    defaultTabComponent?: Type<any> | TemplateRef<any>

    OptionaldefaultTabComponent_

    defaultTabComponent_?: string
    didDrop: EventEmitter<DockviewDidDropEvent> = ...
    disableAutoResizing?: boolean
    disableDnd?: boolean
    disableFloatingGroups?: boolean
    disableTabsOverflowList?: boolean
    dndCompass?: boolean | {}
    dndEdges?: false | DroptargetOverlayModel
    dndStrategy?: DockviewDndStrategy
    dropPositionResolver?: PositionResolver
    floatingGroupBounds?: "boundedWithinViewport"
    getTabContextMenuItems?: (
        params: GetTabContextMenuItemsParams,
    ) => (ContextMenuItem | { component: Type<any> | TemplateRef<any> })[]
    getTabGroupChipContextMenuItems?: (
        params: GetTabGroupChipContextMenuItemsParams,
    ) => (
        | ContextMenuItemConfig
        | BuiltInChipContextMenuItem
        | { component: Type<any>
        | TemplateRef<any> }
    )[]
    groupDragGhostComponent?: Type<any>
    hideBorders?: boolean
    leftHeaderActionsComponent?: Type<any> | TemplateRef<any>
    locked?: boolean
    nonce?: CspNonceProvider
    noPanelsOverlay?: "emptyGroup" | "watermark"
    orientation?: "horizontal" | "vertical"
    overflow?: DockviewOverflowOptions
    pinnedTabs?: PinnedTabsOptions
    popoutUrl?: string
    prefixHeaderActionsComponent?: Type<any> | TemplateRef<any>
    ready: EventEmitter<DockviewReadyEvent> = ...
    rightHeaderActionsComponent?: Type<any> | TemplateRef<any>
    scrollbars?: "native" | "custom"
    singleTabMode?: "fullwidth" | "default"
    smartGuides?: SmartGuidesOptions
    tabComponents?: Record<string, Type<any> | TemplateRef<any>>
    tabGroupAccent?: "palette" | "off"
    tabGroupChipComponent?: Type<any>
    tabGroupColors?: DockviewTabGroupColorEntry[]
    tabHeight?: number
    theme?: DockviewTheme
    watermarkComponent?: Type<any> | TemplateRef<any>
    willDrop: EventEmitter<DockviewWillDropEvent> = ...

    Methods

    • A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

      Parameters

      • changes: { [propName: string]: SimpleChange<any> }

        The changed properties.

      Returns void

    • A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

      Returns void

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods