org.ibisph.charts
Class StackedBar

java.lang.Object
  org.ibisph.charts.AbstractChart
      org.ibisph.charts.AbstractSharedChart
          org.ibisph.charts.StackedBar

All Implemented Interfaces:

java.io.Serializable, Chart

public class StackedBar
extends AbstractSharedChart

Grouped Stacked Bar specific chart object class.

Author:

Garth Braithwaite, STG

See Also:

Serialized Form

Field Summary

Fields inherited from class org.ibisph.charts.AbstractChart

acxmlPathAndFilename, defaultChartHeight, defaultXAxisLabelDistance, defaultYAxisLabelDistance, labelCharacterWidth, legendSymbolWidth, maxLegendWidth, maxXAxisLabelWidth, maxYAxisLabelWidth, minLegendWidth

Constructor Summary

StackedBar(java.lang.String acxmlPathAndFilename)
Required explicit constructor which creates the actual Agileblox chart class object, loads the ACXML file/properties, and sets some general chart properties.

Method Summary

protected com.elan.wclibrary.svg.BaseChart	getBaseChart(java.lang.String chartTitle, java.lang.String seriesAxisTitle, java.lang.String[] seriesTitles, java.lang.String categoryAxisTitle, java.lang.String[] categoryTitles, java.lang.String[][] values, java.lang.String[][] lowerLimits, java.lang.String[][] upperLimits, java.lang.String[][] toolTips, double maxValue, boolean showConfidenceLimits) Sets the chart's data values, adjusts chart's layout based on the control properties, and returns the chart instance.
void	set3DProps(double rotation, double elevation) Sets 3-D properties for the chart.
protected void	setCategoryTitle(java.lang.String title) Overrides/kills the setCategoryTitle method because there is no x axis title for a stacked bar.
protected java.lang.String[][]	transpose(java.lang.String[][] seriesCategoryValueArray) Transposes/swaps array dimensions and values around.

Methods inherited from class org.ibisph.charts.AbstractSharedChart

generate

Methods inherited from class org.ibisph.charts.AbstractChart

adjustLegendSize, adjustXAxisLabelHeight, adjustXAxisLabelHeight, adjustYAxisLabelWidthAndSetScale, adjustYAxisLabelWidthAndSetScale, getMaxCategorySum, getMaxSeriesSum, numberOfLines, setChartHeight, setDefaultChartHeight, setDefaultXAxisLabelDistance, setDefaultYAxisLabelDistance, setLabelCharacterWidth, setLegendSymbolWidth, setMaxLegendWidth, setMaxXAxisLabelWidth, setMaxYAxisLabelWidth, setMinLegendWidth, setTitle, toDouble, toNullToZeroDoubleArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StackedBar

public StackedBar(java.lang.String acxmlPathAndFilename)

Required explicit constructor which creates the actual Agileblox chart class object, loads the ACXML file/properties, and sets some general chart properties.

Parameters:

acxmlPathAndFilename - complete filename with path of the ACXML properties file to load.

Method Detail

set3DProps

public void set3DProps(double rotation,
                       double elevation)

Sets 3-D properties for the chart.

Parameters:

rotation - Angle between 0 and 360 which specifies the bar's view rotation.

elevation - Amount the view perspective is elevated.

getBaseChart

protected com.elan.wclibrary.svg.BaseChart getBaseChart(java.lang.String chartTitle,
                                                        java.lang.String seriesAxisTitle,
                                                        java.lang.String[] seriesTitles,
                                                        java.lang.String categoryAxisTitle,
                                                        java.lang.String[] categoryTitles,
                                                        java.lang.String[][] values,
                                                        java.lang.String[][] lowerLimits,
                                                        java.lang.String[][] upperLimits,
                                                        java.lang.String[][] toolTips,
                                                        double maxValue,
                                                        boolean showConfidenceLimits)

Description copied from class: AbstractChart

Sets the chart's data values, adjusts chart's layout based on the control properties, and returns the chart instance. This is the chart specific core method that needs to be implemented for each type of chart. This method can share a single instance or create a new instance of the chart each time. This behavior was changed 11/2005 because some of the AgileBlox chart objects were not behaving well. Some chart objects could be reused (for speed) and others would get messed after being used for a while so they were instantiated upon each use.

Specified by:

getBaseChart in class AbstractChart

Parameters:

chartTitle - Main title that is to be displayed on the top of the chart.

seriesAxisTitle - Title to be shown on typically the Y axis which is associated with the series. This axis title usually describes the type of "values" that the data is e.g. "Population Count", "Percentage of Adults" etc.

seriesTitles - Array of strings that is the title/description for each data series. These series title values are displayed in the legend.

categoryAxisTitle - Title to be shown on typically the X axis which is associated with the categoy values. This axis title usually describes what the categories are. Examples are "Year" or "County" etc.

categoryTitles - Array that contains the title for each different data category. These values are typically displayed as labels for each interval on the axis. For the above example these titles would be "1995", "1996", ... "2005" or "Beaver", "Box Elder", ... "Weber".

values - 2-d array that contains the actual data values to be displayed/plotted on the chart. These are string values so that null missing values will be handled (e.g. not shown) on the chart. If the double method is used, then missing values are counted as 0.0 and the chart is not correct. The first array index is the series with the second corresponding to the category.

lowerLimits - Similar to the values array but contains the lower confidence limit (if any) associated with the value[series][category].

upperLimits - Similar to the values array but contains the upper confidence limit (if any) associated with the value[series][category].

toolTips - Contains any special label type values to be shown to the user when the data value is moused over.

maxValue - Maximum data value which is used to control the chart's value scaling.

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.

Returns:

Agileblox base chart.

setCategoryTitle

protected void setCategoryTitle(java.lang.String title)

Overrides/kills the setCategoryTitle method because there is no x axis title for a stacked bar.

Parameters:

title - Not used but required for method signature.

transpose

protected java.lang.String[][] transpose(java.lang.String[][] seriesCategoryValueArray)

Transposes/swaps array dimensions and values around.

Parameters:

seriesCategoryValueArray - source array to be redimensioned / transposed value[series][category].

Returns:

Transposed 2-d array. value[category][series]