org.ibisph.charts
Interface Chart

All Known Implementing Classes:

AbstractChart, AbstractSharedChart, Area, GroupedBar, GroupedHorzBar, Line, Pie, StackedArea, StackedBar

public interface Chart

Specifies all required methods needed to generate an IBIS-PH type chart.

Author:

Garth Braithwaite, STG

Method Summary

void	generate(javax.servlet.http.HttpServletRequest request, ChartData chartData, java.lang.String chartHeight, boolean showConfidenceLimits, boolean zipOutput, java.io.OutputStream outputStream) Final method used to build the chart content and stream it to an output stream.
void	setDefaultChartHeight(double defaultChartHeight) Controls the default chart height.
void	setDefaultXAxisLabelDistance(double defaultXAxisLabelDistance) Controls the distance that the X axis labels should be placed away from the actual chart.
void	setDefaultYAxisLabelDistance(double defaultYAxisLabelDistance) Controls the distance that the Y axis labels should be placed away from the actual chart.
void	setLabelCharacterWidth(double labelCharacterWidth) Controls how the label width/size is deteremined by using this average width value.
void	setLegendSymbolWidth(double legendSymbolWidth) Controls the legend's symbol size for each series.
void	setMaxLegendWidth(double maxLegendWidth) Controls the maximum legend width.
void	setMaxXAxisLabelWidth(double maxXAxisLabelWidth) Controls the maximum x axis label width.
void	setMaxYAxisLabelWidth(double maxYAxisLabelWidth) Controls the maximum y axis label width.
void	setMinLegendWidth(double minLegendWidth) Controls the minimum legend width.

Method Detail

setMinLegendWidth

void setMinLegendWidth(double minLegendWidth)

Controls the minimum legend width.

Parameters:

minLegendWidth - If the legend contains small titles, this value controls the smallest width that the legend can be "shrunk" down to.

setMaxLegendWidth

void setMaxLegendWidth(double maxLegendWidth)

Controls the maximum legend width. If the legend contains large titles, this value controls the largest width that the legend can be "expanded" to.

setMaxYAxisLabelWidth

void setMaxYAxisLabelWidth(double maxYAxisLabelWidth)

Controls the maximum y axis label width.

setMaxXAxisLabelWidth

void setMaxXAxisLabelWidth(double maxXAxisLabelWidth)

Controls the maximum x axis label width.

setLegendSymbolWidth

void setLegendSymbolWidth(double legendSymbolWidth)

Controls the legend's symbol size for each series.

setLabelCharacterWidth

void setLabelCharacterWidth(double labelCharacterWidth)

Controls how the label width/size is deteremined by using this average width value.

setDefaultYAxisLabelDistance

void setDefaultYAxisLabelDistance(double defaultYAxisLabelDistance)

Controls the distance that the Y axis labels should be placed away from the actual chart.

setDefaultXAxisLabelDistance

void setDefaultXAxisLabelDistance(double defaultXAxisLabelDistance)

Controls the distance that the X axis labels should be placed away from the actual chart.

setDefaultChartHeight

void setDefaultChartHeight(double defaultChartHeight)

Controls the default chart height.

generate

void generate(javax.servlet.http.HttpServletRequest request,
              ChartData chartData,
              java.lang.String chartHeight,
              boolean showConfidenceLimits,
              boolean zipOutput,
              java.io.OutputStream outputStream)

Final method used to build the chart content and stream it to an output stream.

Parameters:

request - required/used by the Agileblox chart object.

chartData - titles and values to be shown as a chart.

chartHeight - controls how tall/high the chart will be (in pixels).

showConfidenceLimits - flag to control how to displaying the confidence intervals. If true the confidence limits will always be displayed. If false then the limits are only shown to the user when they mouse over the value or they mouse over the series title in the legend.

zipOutput - flag that controls if the SVG is gzipped before streaming back.

outputStream - stream that the chart will be streamed back to.