WebPivotTable provides lots of APIs for developers to call them from hosted web page or web application. For example, developers can use these APIs to load source data from any kind of resources, or save reports to local files or server then reload them in future, etc.

How to call APIs?

WebPivotTable APIs are implemented based on event bus mechanism. An event bus is a mechanism that allows different components to communicate with each other without knowing about each other. A component can send an event to the event bus without knowing who will pick it up or how many others will pick it up. Components can also listen to events on an event bus, without knowing who sent the events. That way, components can communicate without depending on each other.

There is an "$eventBus" property of initialed WebPivotTable object. This property is an event bus. We can use it to emit events to WebPivotTable and trigger some internal logic of WebPivotTable. This event emit mechanism is the key how APIs works.

Below is standard syntax to call APIs:

var wpt = document.getElementsByTagName('web-pivot-table')[0];

wpt.$eventBus.$emit(apiName, params1, params2, ..., paramsn);

First, we need get WebPivotTable object, then call $emit method of this object's $eventBus props, passing with API name together with a list of params.

Since event bus is asynchronous, we should pass callbacks as params if we want to add some logic when API call succeed with response or failed with error.

`setLocale`

wpt.$eventBus.$emit("setLocale", locale);

`setOptions`

wpt.$eventBus.$emit("setOptions", options);

`setView`

wpt.$eventBus.$emit("setView", view);

`setDataArray` Available in the current release.

wpt.$eventBus.$emit("setDataArray", attrArray, dataArray, dataUrl, wptObject, successCB, errorCB);

Load source data from data array

Notes:

• If wptObject is not null, use it as pre-saved pivot selections

• This is major API to load source data into WebPivotTable, it was used by setCsvUrl and setCsvRawData internally. Actually, developers can load any kinds of data from any other resources, like SQL databases, and format them as attrArray and dataArray, then load them into WebPivotTable.

`setCsvUrl` Available in the current release.

wpt.$eventBus.$emit("setCsvUrl", csvUrl, separator, wptObject, successCB, errorCB);

Load source data from CSV file URL

Notes:

• If wptObject is not null, use it as pre-saved pivot selections

`setWptString` Available in the current release.

wpt.$eventBus.$emit("setWptString", wptString, dataObject, successCB, errorCB);

Load WPT format String

`setWptObject` Available in the current release.

wpt.$eventBus.$emit("setWptObject", wptObject, dataObject, successCB, errorCB);

Load WPT format JSON Oject

`setWpt` Available in the current release.

wpt.$eventBus.$emit("setWpt", wpt, dataObject, successCB, errorCB);

Load WPT format String or JSON Object with updated first source data

`generateWptString` Available in the current release.

wpt.$eventBus.$emit("generateWptString", ignoreData, successCB);

Generate WPT format string

`generateWptJSON` Available in the current release.

wpt.$eventBus.$emit("generateWptJSON", ignoreData, successCB);

Generate WPT format JSON object

`setOlapCube` Available in the current release.

wpt.$eventBus.$emit("setOlapCube", olapData, successCB, errorCB);

Load OLAP Cube

olapData: {
  xmlaUrl: "Xmla server url",
  dataSourceInfo: "Data source info",
  catalog: "Catalog name",
  cubeName: "Cube name"
}

`setWebServiceDataUrl` Available in the current release.

wpt.$eventBus.$emit("setWebServiceDataUrl", wsDataUrl, wptObject, successCB, errorCB);

Load source data from WebService URL and create a new WPT with a new Sheet

Notes:

• If wptObject is not null, use it as pre-saved pivot selections

• The Web Service should return a JSON object

       {
           attrArray: [],
           dataArray: []
       }

• This is a very useful API to access data in SQL databases or any other data storages since Web Service access is cross domain and can be provided by any backend technologies.

`addWebServiceDataUrl` Available in the current release.

wpt.$eventBus.$emit("addWebServiceDataUrl", wsDataUrl, successCB, errorCB);

Add a new source data from WebService URL

Notes:

• The Web Service should return a JSON object

       {
           attrArray: [],
           dataArray: []
       }

• This is a very useful API to access data in SQL databases or any other data storages since Web Service access is cross domain and can be provided by any backend technologies.