visualize API | Java SDK | Teradata AppCenter - 2.0 - visualize API - Teradata AppCenter

Teradata® AppCenter Java SDK User Guide

prodname
Teradata AppCenter
vrm_release
2.0
created_date
September 2020
category
Programming Reference
User Guide
featnum
B035-1118-090K

Purpose

The visualize API supports Aster visualizations, bar and line NGX charts, ECharts, and custom visualizations. For custom visualizations, you must bundle your visualization assets and upload the bundled html with your app.

Interfaces

The visualize API has the following two interfaces:
Interface Description Code Example
String Use string data from the query API and return visualized data in String.
String visualizedResult = client.visualize(data, “query1”);
InputStream Use InputStream from the streamResultsFromQuery API and return visualized data in InputStream.
InputStream queryResultStream = client.streamResultsFromQuery(query); InputStream vizResultStream = client.visualize(queryResultStream, "query1"); client.cacheResult(vizResultStream, "application/json");

Request Parameters

The visualize API has the following two parameters:
Parameter Description
data Data to be visualized. It can be the JSON output from the query API or customized data from a custom visualization.
tag Name of the visualization configuration in the app result configuration, or null if using Aster custom visualizations.