quadbase.reportdesigner.ReportAPI
Class ChartObject

quadbase.ChartAPI.QbChart
  |
  +--quadbase.reportdesigner.ReportAPI.ChartObject

All Implemented Interfaces:

IChart, IChartTypeConstants, IExportConstants

public class ChartObject

extends QbChart

implements IChart

A ChartObject is a chart that is wrapped by the class ReportChartObject for insertion into a report. While it is recommended to insert charts using Designer, the following snippet can be used as a template for inserting charts via the API.

// Create ChartObject
ChartObject chartObj = new ChartObject(...); // Specify arguments for constructor call
// Create ReportChartObject to wrap chartObj
ReportChartObject reportChartObject = new ReportChartObject();

// Change chartObj properties
...

// Wrap reportChartObject around chartObj
reportChartObject.setChart(chartObj);

The ReportChartObject is then added to a report section. For example,

report.getTableFooter().addData(reportChartObject);

Fields inherited from class quadbase.ChartAPI.QbChart

OLAPDATA_CONCATENATELABEL, OLAPDATA_DIRECT, OLAPDATA_TRANSPOSECOLBREAK, VIEW2D, VIEW3D

Fields inherited from interface quadbase.util.IChartTypeConstants

AREA, BAR, BOX, BUBBLE, CHARTTYPENAME, COL, COMBO_COL, COMBO_LINE, COMBO_OVERLAY, COMBO_STACKAREA, COMBOTYPENAME, DIAL, GANTT, HILOW, HLCO, HTMLCENTER, HTMLHORIZONTAL, HTMLLEFT, HTMLRIGHT, HTMLVERTICAL, LINE, OVERLAY, PERCENTCOL, PIE, POLAR, RADAR, SCATTER, STACKAREA, STACKBAR, STACKCOL, SURFACE, TOTALTYPE, TOTALTYPE_2D, TOTALTYPE_3D, XYCHART

Fields inherited from interface quadbase.ChartAPI.IExportConstants

BMP, CHT, CHT_DATA, COMMA, FLASH, GIF, GIF_C, GIF_N, GIF_R, JPEG, JPEG_C, PDF, PNG, PNG_COMPRESSION_DEFAULT, PNG_COMPRESSION_FAST, PNG_COMPRESSION_MAX, PNG_COMPRESSION_NONE, SEMICOLON, SPACE, SVG, TPL, TXTFORMAT, VRML, WMF, XMLFORMAT

Constructor Summary

ChartObject(java.lang.Object chartInfo)
Using chartInfo to create ChartObject.

ChartObject(QbReport qbReport, int dimension, int chartType, boolean doTransposeData, int[] transposeCol, IColumnMap cmap, java.lang.String template)
Create an instance of ChartObject that can embedded in a ReportChartObject, which can be used to insert this chart into a report.

ChartObject(QbReport qbReport, int dimension, int chartType, boolean doTransposeData, int[] transposeCol, IColumnMap cmap, java.lang.String template, quadbase.reportdesigner.ReportElements.ReportTableElement panel)
Creates an instance of ChartObject that can be embedded in a ReportChartObject, which can be used to insert this chart into a report.

ChartObject(QbReport qbReport, int dimension, int chartType, boolean doTransposeData, int[] transposeCol, IColumnMap cmap, java.lang.String template, quadbase.reportdesigner.ReportElements.ReportTableElement panel, boolean useSummaryData)
Creates an instance of ChartObject that can be embedded in a ReportChartObject, which can be used to insert this chart into a report.

Method Summary

static ChartObject	createChartObject(QbReport report, java.lang.String templateFileName) Method to create a new ChartObject that does NOT using report section Aggregation data.
static ChartObject	createChartObject(QbReport report, java.lang.String templateFileName, ReportSection panel) Creates a ChartOject in a specific ReportSection.

Methods inherited from class quadbase.ChartAPI.QbChart

applyAntiAliasToChartAreaOnly, applyTemplateFile, createDrillDownChart, createDrillDownChart, draw, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, export, exportChartToByteArray, exportChartToByteArray, exportChartToString, exportDataFile, exportDataFile, finalize, getApplet, getArgument, getBufferedImageType, getChartGraphics, getDimension, getDrillDownChart, getDrillDownChartAt, getDrillDownChartCount, getErrorMessage, getFile, getFileRecordBufferSize, geth3DControlPanel, geth3DProperties, gethAnnotations, gethAxis, gethBoxProperties, gethBubbleProperties, gethCanvas, gethChartPlot, gethControlRanges, gethDataLines, gethDataPoints, gethDialProperties, gethDrillDown, gethDropBars, gethFloatingLines, gethFloatingText, gethGanttProperties, gethHistogramInfo, gethHyperLinks, gethInputData, gethLegend, gethLineProperties, gethMainTitle, gethMouseEvents, gethNoDataToPlotMessage, gethOverlayProperties, gethPieProperties, gethPolarProperties, gethPopupMenu, gethRadarProperties, gethSecondaryChart, gethSurfaceProperties, gethTable, getHTMLParamPage, getHTMLParamPage, getHTMLParamPageBlock, getHTMLParamPageBody, getHTMLParamPageBody, gethTrendLines, gethXAxis, gethXRuler, gethYAxis, gethYRuler, gethZAxis, gethZoomInfo, getImageMapDataHintBoxHandle, getLocale, getMaxCharForRecordFile, getMaxRecordInMemory, getModifier, getParameterPage, getPickDataCount, getPreferredSize, getQueryTimeout, getServletContext, getTempDirectory, getTemplateFile, getTimeZone, getType, getUpdateVersion, getVersion, is3DShadingEnabled, isAdjustFont, isBackgroundTransparent, isBufferedImageUsed, isChartServerUsed, isDrawBorderForWMF, isEspressManagerUsed, isFieldDrillDownChart, isFieldDrillDownEnabled, isForExportOnly, isGradientEnabled, isGrayscaleForExport, isHiLowAsCandleStick, isPrintKeyEnabled, isRefreshEnabled, loadFile, readExternal, refresh, repaintPanel, set3DShadingEnabled, setAddOnChart, setAdjustFont, setApplet, setBackgroundTransparent, setBufferedImageType, setBufferedImageUsed, setChartGraphics, setChartServerUsed, setChartServerUsed, setChartServerUsed, setConnectURLForServer, setDebugMode, setDebugMode, setDimension, setDrawBorderForWMF, setDrillDownPath, setEspressManagerUsed, setEspressManagerUsed, setEspressManagerUsed, setFileRecordBufferSize, setForExportOnly, setGIFEnable, setGradientEnabled, setGrayscaleForExport, setHiLowAsCandleStick, setImageMapDataHintBoxHandle, setLocale, setMaxCharForRecordFile, setMaxRecordInMemory, setOpaque, setPanelBorder, setParamPageAlignment, setParamPageBackgroundColor, setParamPageBorderColor, setParamPageBorderColor, setParamPageBorderThickness, setParamPageFooter, setParamPageHeader, setParamPageLayout, setParamPageOuterBorder, setParamPageResetEnabled, setParamPageTextFontColor, setParamPageTextFontColor, setParamPageTextFontName, setParamPageTextFontSize, setParamPageTextFontStyle, setParamPageTitle, setParamPageTitleFontColor, setParamPageTitleFontColor, setParamPageTitleFontName, setParamPageTitleFontSize, setParamPageTitleFontStyle, setPreferredSize, setPrintKeyEnabled, setQueryTimeout, setRefreshEnabled, setRenderingHint, setScrollBarOption, setServerAddress, setServerHosts, setServerPortNumber, setServletContext, setServletRunner, setStringCustomizer, setTempDirectory, setTimeZone, setType, setUseSingleTableForDistinctParamValue, toPickData, updateDrillDownCharts, useHttp, useServlet, useSingleTableForDistinctParamValue, writeExternal

Constructor Detail

ChartObject

public ChartObject(QbReport qbReport,
                   int dimension,
                   int chartType,
                   boolean doTransposeData,
                   int[] transposeCol,
                   IColumnMap cmap,
                   java.lang.String template)

Create an instance of ChartObject that can embedded in a ReportChartObject, which can be used to insert this chart into a report.

Parameters:

qbReport - the parent QbReport object

dimension - either a 2D, or 3D chart. Can be either ChartObject.VIEW2D, or ChartObject.VIEW3D

chartType - the type of chart desired. Please see IChartTypeConstants.

doTransposeData - whether to transpose data prior to plotting.

transposeCol - the indices of the columns to be transposed

cmap - the column mapping to use. If using ReportData, values should correspond to ReportTable column indices.

template - the chart template file, ".tpl" to use for look & feel.

ChartObject

public ChartObject(QbReport qbReport,
                   int dimension,
                   int chartType,
                   boolean doTransposeData,
                   int[] transposeCol,
                   IColumnMap cmap,
                   java.lang.String template,
                   quadbase.reportdesigner.ReportElements.ReportTableElement panel)

Creates an instance of ChartObject that can be embedded in a ReportChartObject, which can be used to insert this chart into a report.

Parameters:

qbReport - the parent QbReport object

dimension - either a 2D, or 3D chart. Can be either ChartObject.VIEW2D, or ChartObject.VIEW3D

chartType - the type of chart desired. Please see IChartTypeConstants.

doTransposeData - whether to transpose data prior to plotting.

transposeCol - the indices of the columns to be transposed

cmap - the column mapping to use. If using ReportData, values should correspond to ReportTable column indices.

panel - reportSection/ reportTable element, target section

template - the chart template file, ".tpl" to use for look & feel.

ChartObject

public ChartObject(QbReport qbReport,
                   int dimension,
                   int chartType,
                   boolean doTransposeData,
                   int[] transposeCol,
                   IColumnMap cmap,
                   java.lang.String template,
                   quadbase.reportdesigner.ReportElements.ReportTableElement panel,
                   boolean useSummaryData)

Creates an instance of ChartObject that can be embedded in a ReportChartObject, which can be used to insert this chart into a report.

Parameters:

qbReport - the parent QbReport object

dimension - either a 2D, or 3D chart. Can be either ChartObject.VIEW2D, or ChartObject.VIEW3D

chartType - the type of chart desired. Please see IChartTypeConstants.

doTransposeData - whether to transpose data prior to plotting.

transposeCol - the indices of the columns to be transposed

cmap - the column mapping to use. If using ReportData, values should correspond to ReportTable column indices.

template - the chart template file, ".tpl" to use for look & feel.

panel - reportSection/ reportTable element, target section

useSummaryData - for fixed-field crossTab report only - create summary chart

ChartObject

public ChartObject(java.lang.Object chartInfo)

Using chartInfo to create ChartObject. User can get chartInfo from implementing IChartModifier. After creating ChartObject successfully, user can change the chart attribute using ChartObject which extends QbChart. Once the modification is done, return back the ChartObject in IChartModifier#modifyChart().

Method Detail

createChartObject

public static ChartObject createChartObject(QbReport report,
                                            java.lang.String templateFileName)

Method to create a new ChartObject that does NOT using report section Aggregation data. To load a ChartObject that using section data, please use the method createChartObject(QbReport, String, ReportSection). This method is used to create a ChartObject based on the report and the template, so that the user does not need to know in advance about the chartType, dimension nor the colInfo. The user will need to make sure that the template is applicable to the report.

This method is currently only used in the QuickDesigner to edit the chart inside the report.

createChartObject

public static ChartObject createChartObject(QbReport report,
                                            java.lang.String templateFileName,
                                            ReportSection panel)

Creates a ChartOject in a specific ReportSection.

Parameters:

report - the main report that holding the chart object

templateFileName - The chart template applicable to the report column settings

panel - the report section where the chart is to be inserted. If this parameter is set to null, it won't use any section data and the chart can be put in any section of the report

Returns:

- a ChartObject using the templateFileName
null, if an error occurs