Theia API Documentation v1.65.0
    Preparing search index...

    Interface PropertyDataService

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

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

    Implemented by

    Index

    Properties

    id label?

    Methods

    canHandleSelection providePropertyData

    Properties

    id: string

    A unique id for this provider.

    label?: string

    A human-readable name for this provider.

    Methods

    • 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

    • 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

    On This Page

    Properties
    Methods