IPropertyPaneAccessor interface

Web part context property pane accessor interface. Provides some most commonly used operations to access the property pane.

Methods

close()

This API should be used to close the PropertyPane to help configure the web part.

isPropertyPaneOpen()

Returns true if the PropertyPane is open.

isRenderedByWebPart()

Indicates whether the PropertyPane was initially opened by the web part.

open()

This API should be used to open the PropertyPane to help configure the web part.

openDetails(context)

This API should be used to open the Details PropertyPane to help configure the items in the web part.

refresh()

This API should be used to invoke the PropertyPane to help configure the web part.

Method Details

close()

This API should be used to close the PropertyPane to help configure the web part.

close(): void;

Returns

void

isPropertyPaneOpen()

Returns true if the PropertyPane is open.

isPropertyPaneOpen(): boolean;

Returns

boolean

isRenderedByWebPart()

Indicates whether the PropertyPane was initially opened by the web part.

isRenderedByWebPart(): boolean;

Returns

boolean

Remarks

For example, if the web part calls this.context.propertyPane.open() then the property would be true, whereas if the property pane was opened by the host, then the value will be false.

open()

This API should be used to open the PropertyPane to help configure the web part.

open(): void;

Returns

void

openDetails(context)

This API should be used to open the Details PropertyPane to help configure the items in the web part.

openDetails(context?: any): void;

Parameters

context
any

Add additional context for property pane

Returns

void

Remarks

This API is mainly used for configuring Details, which is different from configuring the web part itself.

refresh()

This API should be used to invoke the PropertyPane to help configure the web part.

refresh(): void;

Returns

void

Remarks

This operation only works when the PropertyPane is already open for the currently active web part. If the PropertyPane is opened for another web part, calling the refresh API will have no impact.