Class PivotTable

constructor

• new PivotTable(widget): PivotTable

• Creates a client PivotTable instance from a Widget that has been exported from the server.

  Parameters

  • widget: Widget

    a PivotTable widget that has been fetched from the server

  Returns PivotTable

Static Readonly EVENT_DISCONNECT

Static Readonly EVENT_RECONNECT

Static Readonly EVENT_RECONNECTFAILED

Static Readonly EVENT_UPDATED

columnSort

• get columnSort(): PivotSort[]

• The current column sort configuration of this PivotTable.

  Returns PivotSort[]

  PivotSort array

columnSources

• get columnSources(): PivotSource[]

• The sources that represent the columns of this pivot table.

  Returns PivotSource[]

filter

• get filter(): FilterCondition[]

• The current filter configuration of this Tree Table.

  Returns FilterCondition[]

  FilterCondition array

isClosed

• get isClosed(): boolean

• True if this pivot table is closed.

  Returns boolean

isRefreshing

• get isRefreshing(): boolean

• True if this pivot table's subscription may receive updates from the server.

  Returns boolean

rowSort

• get rowSort(): PivotSort[]

• The current row sort configuration of this PivotTable.

  Returns PivotSort[]

  PivotSort array

rowSources

• get rowSources(): PivotSource[]

• The sources that represent the rows of this pivot table.

  Returns PivotSource[]

valueSources

• get valueSources(): PivotSource[]

• The sources that represent the values of this pivot table.

  Returns PivotSource[]

addEventListener

• addEventListener<T>(name, callback): (() => void)

• 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

        • e: Event<T>

        Returns void

  Returns (() => void)

  Returns a cleanup function.

  • • (): void

    • Returns void

applyColumnSort

• applyColumnSort(colSorts): PivotSort[]

• Changes the column sorts of this pivot table. The column sorts may contain sorts of both the column and value sources.

  Parameters

  • colSorts: PivotSort[]

    column and value sorts to apply to the columns of this pivot table

  Returns PivotSort[]

  the previous column sorts

applyFilter

• applyFilter(filter): FilterCondition[]

• Changes the filter conditions of this pivot table. The filter array may contain any number of conditions, which will be AND'd together. Only row and column sources can be filtered, not value sources.

  Parameters

  • filter: FilterCondition[]

    Row and column filter conditions to apply to this pivot table.

  Returns FilterCondition[]

  the previous filter conditions

applyRowSort

• applyRowSort(rowSorts): PivotSort[]

• Changes the row sorts of this pivot table. The row sorts may contain sorts of both the row and value sources.

  Parameters

  • rowSorts: PivotSort[]

    row and value sorts to apply to the rows of this pivot table

  Returns PivotSort[]

  the previous row sorts

close

• close(): void

• Closes this pivot table, releasing all resources and subscriptions associated with it.

  Returns void

collapseAll

• collapseAll(): void

• Collapses all rows and columns in this pivot table, including all descendants of any expanded rows or columns.

  Returns void

collapseColumn

• collapseColumn(position): void

• Collapses the column at the given position.

  Parameters

  • position: number

    the position of the column to collapse

  Returns void

collapseRow

• collapseRow(position): void

• Collapses the row at the given position.

  Parameters

  • position: number

    the position of the row to collapse

  Returns void

expandAll

• expandAll(): void

• Expands all rows and columns in this pivot table, including all descendants of any expanded rows or columns.

  Returns void

expandColumn

• expandColumn(position, expandDescendants?): void

• Expands the column at the given position.

  Parameters

  • position: number

    the position of the column to expand

  • Optional expandDescendants: boolean

    if true, also expands all descendants of the column, defaults to false

  Returns void

expandRow

• expandRow(position, expandDescendants?): void

• Expands the row at the given position.

  Parameters

  • position: number

    the position of the row to expand

  • Optional expandDescendants: boolean

    if true, also expands all descendants of the row, defaults to false

  Returns void

hasListeners

• hasListeners(name): boolean

• Parameters

  • name: string

  Returns boolean

nextEvent

• nextEvent<T>(eventName, timeoutInMillis?): Promise<Event<T>>

• Type Parameters

  • T

  Parameters

  • eventName: string

  • Optional timeoutInMillis: number

  Returns Promise<Event<T>>

removeEventListener

• removeEventListener<T>(name, callback): boolean

• Removes an event listener added to this table.

  Type Parameters

  • T

  Parameters

  • name: string

  • callback: ((e) => void)

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns boolean

setColumnExpanded

• setColumnExpanded(position, isExpanded, expandDescendants?): void

• Sets the expansion state of the column at the given position.

  Parameters

  • position: number

    the position of the column to set the expansion state for

  • isExpanded: boolean

    if true, the column will be expanded, if false, it will be collapsed

  • Optional expandDescendants: boolean

    if true, also expands all descendants of the column, defaults to false. Ignored if isExpanded is false.

  Returns void

setRowExpanded

• setRowExpanded(position, isExpanded, expandDescendants?): void

• Sets the expansion state of the row at the given position.

  Parameters

  • position: number

    the position of the row to set the expansion state for

  • isExpanded: boolean

    if true, the row will be expanded, if false, it will be collapsed

  • Optional expandDescendants: boolean

    if true, also expands all descendants of the row, defaults to false. Ignored if isExpanded is false.

  Returns void

setViewport

• setViewport(options): void

• Parameters

  • options: PivotSubscriptionOptions

  Returns void