Zoomdata¶

The Zoomdata data provider allows ChartFactor to interact with Zoomdata through its WebSocket and HTTP APIs. Internally, it takes advantage of the Zoomdata Query API to perform all aggregation requests.

The Zoomdata data provider supports Zoomdata version 2.6.

 <script src="./CFT-zoomdata-provider.min.js"></script>

The Provider JSON object requires the url and OAuthOptions parameters in addition to name and provider. Example:

var providers = [{
    name:'Zoomdata',
    provider:'zoomdata',
    url:'https://prototype.zoomdata.com',
    OAuthOptions: {
        auth_uri:'https://prototype.zoomdata.com/zoomdata/oauth/authorize',
        redirect_uri:'https://chartfactor.com:3000/',
        client_id:'QWt0aXVuIERlbW8xNTAzNjY4NjkwNzI0MzRmODViOGYtZGFjNS00MDFiLWJhNDItZDkyNmI4NGFkZGRm',
        scope:['read']
    }
}]

The OAuthOptions fields¶

auth_uri: The Zoomdata endpoint for OAuth authorization
redirect_uri: The resource that should load after successful OAuth authentication
client_id: The ID obtained from Zoomdata when registering your OAuth client
scope: Use “read” for this parameter

Please refer to the Zoomdata documentation for details on how it implements its OAuth workflow and how to register OAuth clients to obtain a client ID.

Supported Aggregations Out-Of-The-Box¶

SUM¶

    var metric = cf.Metric("amount","sum");

AVG¶

    var metric = cf.Metric("amount","avg");

MIN¶

    var metric = cf.Metric("amount","min");

MAX¶

    var metric = cf.Metric("amount","max");

COUNT DISTINCT¶

It supports this aggregation by using calc fields.

CALC¶

It allows invoking a Zoomdata-defined calculation. Example:

    var metric = cf.Metric("calc_my_special_calc","calc");

The first parameter of the cf.Metric() function is the name of your Zoomdata calculation, prefixed with “calc_”. The second parameter, “calc”, is a constant to indicate this is invoking a calculation.

Refer to the Zoomdata documentation for details on how to create calculations in Zoomdata.

Time Zone Support¶

Zoomdata currently does not support time zone conversions. Its time zone support is limited to appending the time zone label to the time field name when rendering visualizaitons. Therefore, its ChartFactor data provider inherits the same behavior since it pushes down aggregations with time zone conversions to the Zoomdata engine.

Dependencies¶

zoomdata-client.js