#Interface: IRootPropertyPane experimental

Beta

A root pane that can store property items.

#Extends

• IPropertyPane

#Properties

#collapsed

readonly collapsed: boolean

Beta

#Remarks

Pane state for being expanded or collapsed.

#Inherited from

IPropertyPane.collapsed

---

#drawerPane

readonly drawerPane: IPropertyPane

Beta

#Remarks

Property pane that is displayed over the root pane content

---

#id

readonly id: string

Beta

#Remarks

Unique identifier for the pane.

#Inherited from

IPropertyPane.id

---

#onPropertyPaneVisibilityUpdated

onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

Beta

#Remarks

Provides visibility change events

#Inherited from

IPropertyPane.onPropertyPaneVisibilityUpdated

---

#visible

visible: boolean

Beta

#Remarks

Check visibility of the pane

#Inherited from

IPropertyPane.visible

#Methods

#addBlockList()

addBlockList(value, options?): IBlockListPropertyItem

Beta

#Parameters

#value

IObservableProp<string[]>

#options?

IBlockListPropertyItemOptions

#Returns

IBlockListPropertyItem

#Remarks

Adds a block list to the pane.

#Inherited from

IPropertyPane.addBlockList

---

#addBlockTable()

addBlockTable(options?): IBlockTablePropertyItem

Beta

#Parameters

#options?

IBlockTablePropertyItemOptions

#Returns

IBlockTablePropertyItem

#Remarks

Adds a block table to the pane.

#Inherited from

IPropertyPane.addBlockTable

---

#addBool()

addBool(value, options?): IBoolPropertyItem

Beta

#Parameters

#value

IObservableProp<boolean>

#options?

IBoolPropertyItemOptions

#Returns

IBoolPropertyItem

#Remarks

Adds a togglable boolean item to the pane.

#Inherited from

IPropertyPane.addBool

---

#addButton()

addButton(action, options?): IButtonPropertyItem

Beta

#Parameters

#action

ButtonPropertyItemSupportedActionTypes

#options?

IButtonPropertyItemOptions

#Returns

IButtonPropertyItem

#Remarks

Adds a button to the pane and binds the specified action to the button interaction.

#Inherited from

IPropertyPane.addButton

---

#addButtonPane()

addButtonPane(options?): IButtonPanePropertyItem

Beta

#Parameters

#options?

IButtonPanePropertyItemOptions

#Returns

IButtonPanePropertyItem

#Remarks

Adds a pane for grouped button layout.

#Inherited from

IPropertyPane.addButtonPane

---

#addCollectionTree()

addCollectionTree(options): ICollectionTreePropertyItem

Beta

#Parameters

#options

ICollectionTreePropertyItemOptions

#Returns

ICollectionTreePropertyItem

#Remarks

Adds a tree view for collections with folders and entries.

#Inherited from

IPropertyPane.addCollectionTree

---

#addColorPicker()

addColorPicker(value, options?): IColorPickerPropertyItem

Beta

#Parameters

#value

any

#options?

IColorPickerPropertyItemOptions

#Returns

IColorPickerPropertyItem

#Remarks

Adds a color picker item to the pane.

#Inherited from

IPropertyPane.addColorPicker

---

#addColorTimeline()

addColorTimeline(value, options?): IColorTimelinePropertyItem

Beta

#Parameters

#value

IObservableProp<number>

#options?

IColorTimelinePropertyItemOptions

#Returns

IColorTimelinePropertyItem

#Remarks

Adds a Color Timeline item to the pane.

#Inherited from

IPropertyPane.addColorTimeline

---

#addComboBox()

addComboBox(value, options?): IComboBoxPropertyItem

Beta

#Parameters

#value

IObservableProp<string>

#options?

IComboBoxPropertyItemOptions

#Returns

IComboBoxPropertyItem

#Remarks

Adds a combo box item to the pane.

#Inherited from

IPropertyPane.addComboBox

---

#addDataTable()

addDataTable(options?): IDataTablePropertyItem

Beta

#Parameters

#options?

IDataTablePropertyItemOptions

#Returns

IDataTablePropertyItem

#Remarks

Adds a data table to the pane.

#Inherited from

IPropertyPane.addDataTable

---

#addDivider()

addDivider(options?): IPropertyItemBase

Beta

#Parameters

#options?

IDividerPropertyItemOptions

#Returns

IPropertyItemBase

#Remarks

Adds an divider item to the pane.

#Inherited from

IPropertyPane.addDivider

---

#addDropdown()

addDropdown(value, options?): IDropdownPropertyItem

Beta

#Parameters

#value

IObservableProp<number>

#options?

IDropdownPropertyItemOptions

#Returns

IDropdownPropertyItem

#Remarks

Adds an Dropdown item to the pane.

#Inherited from

IPropertyPane.addDropdown

---

#addImage()

addImage(value, options?): IImagePropertyItem

Beta

#Parameters

#value

IObservableProp<string | ImageResourceData>

#options?

IImagePropertyItemOptions

#Returns

IImagePropertyItem

#Remarks

Adds an image item to the pane.

#Inherited from

IPropertyPane.addImage

---

#addLink()

addLink(value, options?): ILinkPropertyItem

Beta

#Parameters

#value

IObservableProp<string>

#options?

ILinkPropertyItemOptions

#Returns

ILinkPropertyItem

#Remarks

Adds a Link item to the pane.

#Inherited from

IPropertyPane.addLink

---

#addListPane()

addListPane(options): IListPanePropertyItem

Beta

#Parameters

#options

IListPanePropertyItemOptions

#Returns

IListPanePropertyItem

#Remarks

Adds a pane for displaying list of items in a predefined layout.

#Inherited from

IPropertyPane.addListPane

---

#addMenu()

addMenu(defaultEntries, options?): IMenuPropertyItem

Beta

#Parameters

#defaultEntries

object[]

#options?

IMenuPropertyItemOptions

#Returns

IMenuPropertyItem

#Remarks

Adds a menu button property item to the pane.

#Inherited from

IPropertyPane.addMenu

---

#addMinimap()

addMinimap(mapId, options?): IMinimapPropertyItem

Beta

#Parameters

#mapId

string

#options?

IMinimapPropertyItemOptions

#Returns

IMinimapPropertyItem

#Remarks

Adds Map item to the pane.

#Inherited from

IPropertyPane.addMinimap

---

#addNumber()

addNumber(value, options?): INumberPropertyItem

Beta

#Parameters

#value

IObservableProp<number>

#options?

INumberPropertyItemOptions

#Returns

INumberPropertyItem

#Remarks

Adds a number item to the pane.

#Inherited from

IPropertyPane.addNumber

---

#addNumberTimeline()

addNumberTimeline(value, options?): INumberTimelinePropertyItem

Beta

#Parameters

#value

IObservableProp<number>

#options?

INumberTimelinePropertyItemOptions

#Returns

INumberTimelinePropertyItem

#Remarks

Adds a Number Timeline item to the pane.

#Inherited from

IPropertyPane.addNumberTimeline

---

#addProgressIndicator()

addProgressIndicator(options?): IProgressIndicatorPropertyItem

Beta

#Parameters

#options?

IProgressIndicatorPropertyItemOptions

#Returns

IProgressIndicatorPropertyItem

#Remarks

Adds a Progress Indicator item to the pane.

#Inherited from

IPropertyPane.addProgressIndicator

---

#addProxyPane()

addProxyPane(paneId): void

Beta

#Parameters

#paneId

string

#Returns

void

#Remarks

Adds a proxy view of another supported pane

#Inherited from

IPropertyPane.addProxyPane

---

#addString()

addString(value, options?): IStringPropertyItem

Beta

#Parameters

#value

IObservableProp<string>

#options?

IStringPropertyItemOptions

#Returns

IStringPropertyItem

#Remarks

Adds an editable string item to the pane

#Inherited from

IPropertyPane.addString

---

#addTagContainer()

addTagContainer(options?): ITagContainerPropertyItem

Beta

#Parameters

#options?

ITagContainerPropertyItemOptions

#Returns

ITagContainerPropertyItem

#Remarks

Adds a tag container to the pane.

#Inherited from

IPropertyPane.addTagContainer

---

#addText()

addText(value, options?): ITextPropertyItem

Beta

#Parameters

#value

IObservableProp<LocalizedString>

#options?

ITextPropertyItemOptions

#Returns

ITextPropertyItem

#Remarks

Adds a multiline Text item to the pane.

#Inherited from

IPropertyPane.addText

---

#addTimelinePlayer()

addTimelinePlayer(options?): ITimelinePlayer

Beta

#Parameters

#options?

ITimelinePlayerOptions

#Returns

ITimelinePlayer

#Remarks

Adds a timeline player pane to the pane. The player owns its own playhead and a collection of timeline entries that share that playhead.

#Inherited from

IPropertyPane.addTimelinePlayer

---

#addToggleGroup()

addToggleGroup(value, options?): IToggleGroupPropertyItem

Beta

#Parameters

#value

IObservableProp<number>

#options?

IToggleGroupPropertyItemOptions

#Returns

IToggleGroupPropertyItem

#Remarks

Adds a toggle button group to the pane.

#Inherited from

IPropertyPane.addToggleGroup

---

#addVector2()

addVector2(value, options?): IVector2PropertyItem

Beta

#Parameters

#value

any

#options?

IVector2PropertyItemOptions

#Returns

IVector2PropertyItem

#Remarks

Adds a Vector2 item to the pane.

#Inherited from

IPropertyPane.addVector2

---

#addVector3()

addVector3(value, options?): IVector3PropertyItem

Beta

#Parameters

#value

any

#options?

IVector3PropertyItemOptions

#Returns

IVector3PropertyItem

#Remarks

Adds a Vector3 item to the pane.

#Inherited from

IPropertyPane.addVector3

---

#addVector3Timeline()

addVector3Timeline(value, options?): IVector3TimelinePropertyItem

Beta

#Parameters

#value

IObservableProp<number>

#options?

IVector3TimelinePropertyItemOptions

#Returns

IVector3TimelinePropertyItem

#Remarks

Adds a Vector3 Timeline item to the pane.

#Inherited from

IPropertyPane.addVector3Timeline

---

#collapse()

collapse(): void

Beta

#Returns

void

#Remarks

Collapse the pane.

#Inherited from

IPropertyPane.collapse

---

#createModalOverlayPane()

createModalOverlayPane(options?): IModalOverlayPane

Beta

#Parameters

#options?

IModalOverlayPaneOptions

Creation parameters for modal overlay pane.

#Returns

IModalOverlayPane

#Remarks

Register a modal overlay to the root pane. It will be hidden by default, when shown it will display over the root pane content. Only one modal overlay can be shown at a time.

---

#createSubPane()

createSubPane(options): ISubPanePropertyItem

Beta

#Parameters

#options

ISubPanePropertyItemOptions

#Returns

ISubPanePropertyItem

#Remarks

Creates an sub pane that can store property items.

#Inherited from

IPropertyPane.createSubPane

---

#expand()

expand(): void

Beta

#Returns

void

#Remarks

Expand the pane.

#Inherited from

IPropertyPane.expand

---

#getActiveModalOverlayId()

getActiveModalOverlayId(): string | undefined

Beta

#Returns

string | undefined

Unique identifier of the active modal overlay

#Remarks

---

#getTitle()

getTitle(): LocalizedString | undefined

Beta

#Returns

LocalizedString | undefined

#Remarks

Returns pane title.

#Inherited from

IPropertyPane.getTitle

---

#hide()

hide(): void

Beta

#Returns

void

#Remarks

Hide the pane.

#Inherited from

IPropertyPane.hide

---

#isHeaderActionVisible()

isHeaderActionVisible(): boolean

Beta

#Returns

boolean

Current visibility state of header action

#Remarks

---

#removeSubPane()

removeSubPane(paneToRemove): boolean

Beta

#Parameters

#paneToRemove

IPropertyPane

#Returns

boolean

#Remarks

Removes an existing sub pane.

#Inherited from

IPropertyPane.removeSubPane

---

#setActiveModalOverlay()

setActiveModalOverlay(id): void

Beta

#Parameters

#id

string | undefined

Unique id for modal overlay pane.

#Returns

void

#Remarks

Sets registered modal overlay as active, if not found it will hide the current.

---

#setHeaderActionVisibility()

setHeaderActionVisibility(visible): void

Beta

#Parameters

#visible

boolean

New visibility state of the action button.

#Returns

void

#Remarks

If a header action exists, updates visibility of the button.

---

#setTitle()

setTitle(newTitle): void

Beta

#Parameters

#newTitle

LocalizedString | undefined

New title

#Returns

void

#Remarks

Updates title of pane.

#Inherited from

IPropertyPane.setTitle

---

#show()

show(): void

Beta

#Returns

void

#Remarks

Show the pane and all of its items.

#Inherited from

IPropertyPane.show

---

#toggleSubPaneVisibility()

toggleSubPaneVisibility(subPaneId): void

Beta

#Parameters

#subPaneId

string | undefined

Identifier of the sub pane to display.

#Returns

void

#Remarks

Shows only the specified sub-pane, hiding all others

#Inherited from

IPropertyPane.toggleSubPaneVisibility