Interface PropertyViewWidgetProvider

The PropertyViewWidgetProvider should be implemented to provide a property view content widget for the given selection..

interface PropertyViewWidgetProvider {
    id: string;
    label?: string;
    canHandle(selection): MaybePromise<number>;
    provideWidget(selection): Promise<PropertyViewContentWidget>;
    updateContentWidget(selection): void;
}

Implemented by

Properties

id label?

Methods

canHandle provideWidget updateContentWidget

Properties

id

id: string

A unique id for this provider.

Optional label

label?: string

A human-readable name for this provider.

Methods

canHandle

  • canHandle(selection): MaybePromise<number>

  • Test whether this provider can provide a widget for the given selection. A returned value indicating a priority of this provider.

    Parameters

    • selection: undefined | Object

      the global selection object

    Returns MaybePromise<number>

    a nonzero number if this provider can provide; otherwise it cannot; never reject

provideWidget

updateContentWidget

  • updateContentWidget(selection): void

  • Update the widget with the given selection. Never reject if canHandle return a positive number; otherwise should reject.

    Parameters

    • selection: undefined | Object

      the global selection object

    Returns void

    a resolved property view content widget.

Settings

Member Visibility

Theme

On This Page

idlabelcanHandleprovideWidgetupdateContentWidget