#Interface: ISubPaneHeader experimental

Beta

A fixed-layout header that replaces the default expander header of a sub pane. Only the two dynamic widgets are add*-able; they land in the right region, in call order, just left of the menu.

#Extends

• IPane

#Properties

#id

readonly id: string

Beta

#Remarks

Unique identifier for the pane.

#Inherited from

IPane.id

---

#visible

visible: boolean

Beta

#Remarks

Check visibility of the pane

#Inherited from

IPane.visible

#Methods

#addColorPicker()

addColorPicker(value, options?): ISubPaneHeaderColorItem

Beta

#Parameters

#value

any

Observable driving the color value.

#options?

ISubPaneHeaderColorOptions

Header-local color options.

#Returns

ISubPaneHeaderColorItem

#Remarks

Adds a color picker to the dynamic region of the header.

---

#addIconButton()

addIconButton(action, options): ISubPaneHeaderButtonItem

Beta

#Parameters

#action

ButtonPropertyItemSupportedActionTypes

Action to run when the button is clicked.

#options

ISubPaneHeaderButtonOptions

Header-local button options.

#Returns

ISubPaneHeaderButtonItem

#Remarks

Adds an icon button to the dynamic region of the header.

---

#hide()

hide(): void

Beta

#Returns

void

#Remarks

Hide the pane.

#Inherited from

IPane.hide

---

#setMenu()

setMenu(entries): void

Beta

#Parameters

#entries

IMenuCreationParams[]

New menu entries.

#Returns

void

#Remarks

Replaces the overflow menu entries of the header.

---

#show()

show(): void

Beta

#Returns

void

#Remarks

Show the pane and all of its items.

#Inherited from

IPane.show