Interface IPropertyPane

Property pane present dynamic content. It can be associated with an object and presented with different kind of controls.

Hierarchy

IPropertyPane

Properties

collapsed

collapsed: boolean

Remarks

Pane state for being expanded or collapsed.

`Readonly` id

id: string

Remarks

Unique ID for the property pane.

onPropertyPaneVisibilityUpdated

onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

Remarks

Provides visibility change events

`Optional` `Readonly` parentPaneId

parentPaneId?: 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)

`Optional` width

width?: number

Remarks

Width of the panel in rem.

Methods

addBlockPicker

addBlockPicker<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optional options: IPropertyItemOptionsDataPicker
Returns IPropertyItem<T, Prop>

Remarks
Adds a BlockPicker item to the pane.
- Defined in index.d.ts:2894

addBool

addBool<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optional options: IPropertyItemOptionsBool
Returns IPropertyItem<T, Prop>

Remarks
Adds a boolean item to the pane.
- Defined in index.d.ts:2904

addButton

addButton(action, options?): IActionPropertyItem<{
EMPTY: undefined;
}, "EMPTY">
Parameters
- action: RegisteredAction<NoArgsAction>
- Optional options: IPropertyItemOptionsButton
Returns IActionPropertyItem<{
EMPTY: undefined;
}, "EMPTY">

Remarks
Adds a button to the pane and binds the specified action to the button activate.
- Defined in index.d.ts:2915

addDivider

addDivider(): IPropertyItem<PropertyBag, string>
Returns IPropertyItem<PropertyBag, string>

Remarks
Adds an divider item to the pane.
- Defined in index.d.ts:2929

addDropdown

addDropdown<T, Prop>(obj, property, options?): IDropdownPropertyItem<T, Prop>
Type Parameters
- T extends Omit<PropertyBag, Prop> & {
  [key in string]: number
  }
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optional options: IPropertyItemOptionsDropdown
Returns IDropdownPropertyItem<T, Prop>

Remarks
Adds an DropDown item to the pane.
- Defined in index.d.ts:2935

addEntityPicker

addEntityPicker<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optional options: IPropertyItemOptionsDataPicker
Returns IPropertyItem<T, Prop>

Remarks
Adds an EntityPicker item to the pane.
- Defined in index.d.ts:2950

addImage

addImage<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optional options: IPropertyItemOptionsImage
Returns IPropertyItem<T, Prop>

Remarks
- Defined in index.d.ts:2958

addNumber

addNumber<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optional options: IPropertyItemOptionsNumber
Returns IPropertyItem<T, Prop>

Remarks
Adds a number item to the pane.
- Defined in index.d.ts:2968

addString

addString<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optional options: IPropertyItemOptions
Returns IPropertyItem<T, Prop>

Remarks
Adds a string item to the pane
- Defined in index.d.ts:2978

addText

addText<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optional options: IPropertyItemOptionsText
Returns IPropertyItem<T, Prop>

Remarks
Adds a multiline Text item to the pane.
- Defined in index.d.ts:2988

addVector3

addVector3<T, Prop>(obj, property, options?): IVector3PropertyItem<T, Prop>
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optional options: IPropertyItemOptionsVector3
Returns IVector3PropertyItem<T, Prop>

Remarks
Adds a Vec3 item to the pane.
- Defined in index.d.ts:2998

collapse

collapse(): void
Returns void

Remarks
Collapse the pane.
- Defined in index.d.ts:3008

createPropertyPane

createPropertyPane(options): IPropertyPane
Parameters
- options: IPropertyPaneOptions
Returns IPropertyPane

Remarks
Creates an internal sub panel that is presented inside a extender control.
- Defined in index.d.ts:3015

expand

expand(): void
Returns void

Remarks
Expand the pane.
- Defined in index.d.ts:3021

hide

hide(): void
Returns void

Remarks
Hide the pane.
- Defined in index.d.ts:3027

removePropertyPane

removePropertyPane(paneToRemove): boolean
Parameters
- paneToRemove: IPropertyPane
Returns boolean

Remarks
Removes a child property pane from the parent pane.
- Defined in index.d.ts:3033

show

show(): void
Returns void

Remarks
Show the pane and all of its property items.
- Defined in index.d.ts:3039

Interface IPropertyPane

Hierarchy

Index

Properties

Methods

Properties

collapsed

Remarks

Readonly id

Remarks

onPropertyPaneVisibilityUpdated

Remarks

Optional Readonly parentPaneId

Remarks

titleAltText

Remarks

titleStringId

Remarks

Optional width

Remarks

Methods

addBlockPicker

Type Parameters

T extends PropertyBag

Prop extends string

Parameters

obj: T

property: Prop

Optional options: IPropertyItemOptionsDataPicker

Returns IPropertyItem<T, Prop>

Remarks

addBool

Type Parameters

T extends PropertyBag

Prop extends string

Parameters

obj: T

property: Prop

Optional options: IPropertyItemOptionsBool

Returns IPropertyItem<T, Prop>

Remarks

addButton

Parameters

action: RegisteredAction<NoArgsAction>

Optional options: IPropertyItemOptionsButton

Returns IActionPropertyItem<{ EMPTY: undefined; }, "EMPTY">

Remarks

addDivider

Returns IPropertyItem<PropertyBag, string>

Remarks

addDropdown

Type Parameters

T extends Omit<PropertyBag, Prop> & { [key in string]: number}

Prop extends string

Parameters

obj: T

property: Prop

Optional options: IPropertyItemOptionsDropdown

Returns IDropdownPropertyItem<T, Prop>

Remarks

addEntityPicker

Type Parameters

T extends PropertyBag

Prop extends string

Parameters

obj: T

property: Prop

Optional options: IPropertyItemOptionsDataPicker

Returns IPropertyItem<T, Prop>

Remarks

addImage

Type Parameters

T extends PropertyBag

Prop extends string

Parameters

obj: T

property: Prop

Optional options: IPropertyItemOptionsImage

Returns IPropertyItem<T, Prop>

Remarks

`Readonly` id

`Optional` `Readonly` parentPaneId

`Optional` width

`Optional` options: IPropertyItemOptionsDataPicker

`Optional` options: IPropertyItemOptionsBool

`Optional` options: IPropertyItemOptionsButton

Returns IActionPropertyItem<{
EMPTY: undefined;
}, "EMPTY">

T extends Omit<PropertyBag, Prop> & {
[key in string]: number
}

`Optional` options: IPropertyItemOptionsDropdown

`Optional` options: IPropertyItemOptionsDataPicker

`Optional` options: IPropertyItemOptionsImage

`Optional` options: IPropertyItemOptionsNumber

`Optional` options: IPropertyItemOptions

`Optional` options: IPropertyItemOptionsText

`Optional` options: IPropertyItemOptionsVector3