Class PivotService

Tool to request the server pivot a table and return the results.

Hierarchy

  • PivotService

Implements

Constructors

constructor

Methods

addEventListener createPivotTable hasListeners nextEvent removeEventListener getInstance

Constructors

Protected constructor

Methods

addEventListener

  • Listen for events on this object.

    Type Parameters

    • T

      the type of the data that the event will provide

    Parameters

    • name: string

      the name of the event to listen for

    • callback: ((e) => void)

      a function to call when the event occurs

        • (e): void

        • Parameters

          Returns void

    Returns (() => void)

    Returns a cleanup function.

      • (): void

      • Returns void

createPivotTable

  • Creates a pivot table from the given options - a source table, row keys, column keys, and aggregations.

    Parameters

    Returns Promise<PivotTable>

    a Promise that resolves to a PivotTable instance

hasListeners

nextEvent

  • Type Parameters

    • T

    Parameters

    • eventName: string
    • Optional timeoutInMillis: number

    Returns Promise<Event<T>>

removeEventListener

  • Removes an event listener added to this table.

    Type Parameters

    • T

    Parameters

    • name: string
    • callback: ((e) => void)
        • (e): void

        • Parameters

          Returns void

    Returns boolean

Static getInstance

  • Given a server object, finds or creates a pivot service talking to that same server. If the instance is a PivotService, it will be wrapped and returned. The initial call for a given worker must be either a PivotTable or a PivotService.

    Parameters

    Returns Promise<PivotService>

    a promise that will resolve to a PivotService instance

Settings

Member Visibility

Theme

On This Page