Interface PropertyDataService

PropertyDataService should be implemented to provide property data for the given selection.

interface PropertyDataService {
    id: string;
    label?: string;
    canHandleSelection(selection): number;
    providePropertyData(selection): Promise<undefined | Object>;
}

Implemented by

Properties

id label?

Methods

canHandleSelection providePropertyData

Properties

Readonly id

id: string

A unique id for this provider.

Optional Readonly label

label?: string

A human-readable name for this provider.

Methods

canHandleSelection

  • canHandleSelection(selection): number

  • Test whether this provider can provide property data for the given selection. Return a nonzero number if this provider can provide; otherwise it cannot. Never reject.

    A returned value indicating a priority of this provider.

    Parameters

    • selection: undefined | Object

    Returns number

providePropertyData

  • providePropertyData(selection): Promise<undefined | Object>

  • Provide property data for the given selection. Resolve to a property view content widget. Never reject if canHandle returns a positive number; otherwise should reject.

    Parameters

    • selection: undefined | Object

    Returns Promise<undefined | Object>

Settings

Member Visibility

Theme

On This Page

idlabelcanHandleSelectionprovidePropertyData