|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AQBIChart
BIChart
Synopsis: BIChart renders a graphical representation of a set of data, using row & column hierarchies displaying one or more measures. Description:
Method Summary | |
---|---|
String |
cache(int timeToLive)
Renders a chart and inserts the resulting image into an image cache, returning a URL string which can be used to access the generated chart. |
AQDataSource |
getDataSource()
Get the AQChartModel's datasource. |
AQBIChartModel |
getModel()
Get the Chart's data model. |
AQBIChartProperties |
getProperties()
Get the Chart's properties. |
boolean |
isCacheValid(String cacheKey)
Determines whether the specified cache key is still valid (based on its timeToLive) |
byte[] |
renderToImage(String imageFormat)
Render the Chart to an array of bytes, using the specified image file format |
void |
setDataSource(AQDataSet dataSet)
Use the specified AQDataSet as the AQChartModel's datasource |
void |
setDataSource(AQDataSource dataSource)
Use the specified AQDataSource as the AQChartModel's datasource |
void |
setDataSource(AQPivotDataSet pivotDataSet)
Use the specified AQPivotDataSet as the AQChartModel's datasource |
void |
setModel(AQBIChartModel model)
Set the Chart's data model. |
void |
setProperties(AQBIChartProperties chartProperties)
Set the Chart's properties. |
Method Detail |
---|
AQBIChartModel getModel()
void setModel(AQBIChartModel model)
model
- set the underlying data modelAQBIChartProperties getProperties()
void setProperties(AQBIChartProperties chartProperties)
chartProperties
- Properties which define how the chart will be rendered (chart types, functions, colors, fonts, etc)void setDataSource(AQDataSet dataSet)
dataSet
- AQDataSet containing rows and columns of datavoid setDataSource(AQPivotDataSet pivotDataSet)
pivotDataSet
- AQPivotDataSet containing rows and columns of datavoid setDataSource(AQDataSource dataSource)
dataSource
- AQDataSource containing rows and columns of dataAQDataSource getDataSource()
byte[] renderToImage(String imageFormat) throws Exception
imageFormat
- Image format ("jpg" or "png")
Exception
- during the rendering of the image (e.g. if the specified image format is invalid or unsupported)String cache(int timeToLive) throws Exception
timeToLive
- Time period in seconds during which the image will remain in the cache.
Exception
- if timeToLive < 0; if exception occurs during the rendering of the imageboolean isCacheValid(String cacheKey)
cacheKey
- Cache entry key
|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |