Interface: IPropertyPane
Property pane present dynamic content. It can be associated with an object and presented with different kind of controls.
Properties
collapsed
collapsed:
boolean
Remarks
Pane state for being expanded or collapsed.
id
readonlyid:string
Remarks
Unique ID for the property pane.
onPropertyPaneVisibilityUpdated
onPropertyPaneVisibilityUpdated:
EventSink<PropertyPaneVisibilityUpdate>
Remarks
Provides visibility change events
parentPaneId?
optionalreadonlyparentPaneId:string
Remarks
In case of sub pane this is the id of the parent pane.
titleAltText
titleAltText:
string
Remarks
Fallback display text if no loc ID
titleStringId
titleStringId:
string
Remarks
Loc ID (resolved on client)
visible
visible:
boolean
Remarks
Check visibility of the pane
width?
optionalwidth:number
Remarks
Width of the panel in rem.
Methods
addBlockPicker()
addBlockPicker<
T,Prop>(obj,property,options?):IPropertyItem<T,Prop>
Type parameters
| Type parameter |
|---|
T extends PropertyBag |
Prop extends string |
Parameters
| Parameter | Type |
|---|---|
obj | T |
property | Prop |
options? | IPropertyItemOptionsDataPicker |
Returns
IPropertyItem<T, Prop>
Remarks
Adds a BlockPicker item to the pane.
addBool()
addBool<
T,Prop>(obj,property,options?):IPropertyItem<T,Prop>
Type parameters
| Type parameter |
|---|
T extends PropertyBag |
Prop extends string |
Parameters
| Parameter | Type |
|---|---|
obj | T |
property | Prop |
options? | IPropertyItemOptionsBool |
Returns
IPropertyItem<T, Prop>
Remarks
Adds a boolean item to the pane.
addButton()
addButton(
action,options?):IActionPropertyItem<object,"EMPTY">
Parameters
| Parameter | Type |
|---|---|
action | RegisteredAction <NoArgsAction> |
options? | IPropertyItemOptionsButton |
Returns
IActionPropertyItem<object, "EMPTY">
EMPTY
EMPTY:
undefined
Remarks
Adds a button to the pane and binds the specified action to the button activate.
addDivider()
addDivider():
IPropertyItem<PropertyBag,string>
Returns
IPropertyItem <PropertyBag, string>
Remarks
Adds an divider item to the pane.
addDropdown()
addDropdown<
T,Prop>(obj,property,options?):IDropdownPropertyItem<T,Prop>
Type parameters
| Type parameter |
|---|
T extends Omit <PropertyBag, Prop> & { [key in string]: number } |
Prop extends string |
Parameters
| Parameter | Type |
|---|---|
obj | T |
property | Prop |
options? | IPropertyItemOptionsDropdown |
Returns
IDropdownPropertyItem<T, Prop>
Remarks
Adds an DropDown item to the pane.
addEntityPicker()
addEntityPicker<
T,Prop>(obj,property,options?):IPropertyItem<T,Prop>
Type parameters
| Type parameter |
|---|
T extends PropertyBag |
Prop extends string |
Parameters
| Parameter | Type |
|---|---|
obj | T |
property | Prop |
options? | IPropertyItemOptionsDataPicker |
Returns
IPropertyItem<T, Prop>
Remarks
Adds an EntityPicker item to the pane.
addImage()
addImage<
T,Prop>(obj,property,options?):IPropertyItem<T,Prop>
Type parameters
| Type parameter |
|---|
T extends PropertyBag |
Prop extends string |
Parameters
| Parameter | Type |
|---|---|
obj | T |
property | Prop |
options? | IPropertyItemOptionsImage |
Returns
IPropertyItem<T, Prop>
Remarks
addNumber()
addNumber<
T,Prop>(obj,property,options?):IPropertyItem<T,Prop>
Type parameters
| Type parameter |
|---|
T extends PropertyBag |
Prop extends string |
Parameters
| Parameter | Type |
|---|---|
obj | T |
property | Prop |
options? | IPropertyItemOptionsNumber |
Returns
IPropertyItem<T, Prop>
Remarks
Adds a number item to the pane.
addString()
addString<
T,Prop>(obj,property,options?):IPropertyItem<T,Prop>
Type parameters
| Type parameter |
|---|
T extends PropertyBag |
Prop extends string |
Parameters
| Parameter | Type |
|---|---|
obj | T |
property | Prop |
options? | IPropertyItemOptions |
Returns
IPropertyItem<T, Prop>
Remarks
Adds a string item to the pane
addTable()
addTable(
options?):ITablePropertyItem<object,"EMPTY">
Parameters
| Parameter | Type |
|---|---|
options? | IPropertyItemOptionsTable |
Returns
ITablePropertyItem<object, "EMPTY">
EMPTY
EMPTY:
undefined
Remarks
Adds a table to the pane.
addText()
addText<
T,Prop>(obj,property,options?):IPropertyItem<T,Prop>
Type parameters
| Type parameter |
|---|
T extends PropertyBag |
Prop extends string |
Parameters
| Parameter | Type |
|---|---|
obj | T |
property | Prop |
options? | IPropertyItemOptionsText |
Returns
IPropertyItem<T, Prop>
Remarks
Adds a multiline Text item to the pane.
addVector3()
addVector3<
T,Prop>(obj,property,options?):IVector3PropertyItem<T,Prop>
Type parameters
| Type parameter |
|---|
T extends PropertyBag |
Prop extends string |
Parameters
| Parameter | Type |
|---|---|
obj | T |
property | Prop |
options? | IPropertyItemOptionsVector3 |
Returns
IVector3PropertyItem<T, Prop>
Remarks
Adds a Vec3 item to the pane.
collapse()
collapse():
void
Returns
void
Remarks
Collapse the pane.
createPropertyPane()
createPropertyPane(
options):IPropertyPane
Parameters
| Parameter | Type |
|---|---|
options | IPropertyPaneOptions |
Returns
Remarks
Creates an internal sub panel that is presented inside a extender control.
expand()
expand():
void
Returns
void
Remarks
Expand the pane.
hide()
hide():
void
Returns
void
Remarks
Hide the pane.
removePropertyPane()
removePropertyPane(
paneToRemove):boolean
Parameters
| Parameter | Type |
|---|---|
paneToRemove | IPropertyPane |
Returns
boolean
Remarks
Removes a child property pane from the parent pane.
show()
show():
void
Returns
void
Remarks
Show the pane and all of its property items.