Interface IgcContentPane

Hierarchy

  • IgcContentPane

Index

Properties

acceptsInnerDock?: boolean

Determines whether the end user can inner dock another pane in this one. Defaults to true.

allowClose?: boolean

Determines whether the end user is allowed to close the pane. Defaults to true.

allowDocking?: boolean

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

allowFloating?: boolean

Determines whether the end user is allowed to make the pane floating. Defaults to true.

allowMaximize?: boolean

Determines whether the end user is allowed to maximize the pane.

allowPinning?: boolean

Determines whether the end user is allowed to pin/unpin the pane. Defaults to true.

contentId: string

The slot attribute's value of the content element.

disabled?: boolean

Determines whether a pane is disabled. Defaults to false.

documentOnly?: boolean

Marks that a content pane can be docked only inside a document host.

floatingHeaderId?: string

The slot attribute's value of the floating header element. If not set, the headerId property value is used.

header: string

The text header of the content pane. Even if header slot templates are used, the text header is used for aria label.

headerId?: string

The slot attribute's value of the content pane header element. If not set, the header property value is used.

hidden?: boolean

Determines whether a pane is hidden in the UI. Defaults to false.

id?: string

The id of the pane. If not set the Dock Manager generates it automatically.

isMaximized?: boolean

Determines whether a content pane is maximized or not. Defaults to false.

isPinned?: boolean

Determines whether a content pane is pinned or not. Defaults to true.

size?: number

The size of the pane relative to its sibling panes' sizes. Defaults to 100.

tabHeaderId?: string

The slot attribute's value of the tab header element. If not set, the header property value is used.

The type of the pane.

unpinnedHeaderId?: string

The slot attribute's value of the unpinned header element. If not set, the header property value is used.

unpinnedLocation?: IgcUnpinnedLocation

The desired unpinned location of the content pane.

If not set the Dock Manager automatically calculates it based on the location of the pane relatively to the document host. If more than one document host is presented, the closest one in the pane hierarchy will be used for the calculation. If there is no document host, the default location is left.

unpinnedSize?: number

The absolute size of the pane in an unpinned state. Defaults to 200.