io.starter.formats.XLS.charts

Class BarChart

java.lang.Object

io.starter.formats.XLS.charts.ChartType

io.starter.formats.XLS.charts.BarChart

All Implemented Interfaces:

ChartConstants, Serializable

Direct Known Subclasses:

Bar3DChart

public class BarChart
extends ChartType

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Bar	bar

Fields inherited from class io.starter.formats.XLS.charts.ChartType

cf, chartobj, defaultShape, legend, wb

Fields inherited from interface io.starter.formats.XLS.charts.ChartConstants

AREACHART, BARCHART, BUBBLECHART, COLCHART, CONEBARCHART, CONECHART, CYLINDERBARCHART, CYLINDERCHART, DOUGHNUTCHART, LINECHART, OFPIECHART, PIECHART, PYRAMIDBARCHART, PYRAMIDCHART, RADARAREACHART, RADARCHART, SCATTERCHART, SHAPECOLUMN, SHAPECONE, SHAPECONETOMAX, SHAPECYLINDER, SHAPEDEFAULT, SHAPEPYRAMID, SHAPEPYRAMIDTOMAX, STOCKCHART, SURFACECHART, XAXIS, XVALAXIS, YAXIS, ZAXIS

Constructor Summary

Constructors

Constructor and Description
BarChart(GenericChartObject charttype, ChartFormat cf, WorkBook wb)

Method Summary

Modifier and Type	Method and Description
int	getBarShape() returns the bar shape for a column or bar type chart can be one of: SHAPECOLUMN default SHAPECONEd SHAPECONETOMAX SHAPECYLINDER SHAPEPYRAMID SHAPEPYRAMIDTOMAX
int	getDefaultShape() return the default shape for all bars in this chart
org.json.JSONObject	getJSON(ChartSeriesHandle[] series, WorkBookHandle wbh, Double[] minMax) replaces generic getJSON with Bar/Column specifics (necessary for stacked-type charts)
StringBuffer	getOOXML(String catAxisId, String valAxisId, String serAxisId) gets the chart-type specific ooxml representation:
String	getOptionsXML()
String	getSVG(HashMap<String,Double> chartMetrics, HashMap<String,Object> axisMetrics, ChartSeries s) returns SVG to represent the actual chart object i.e.
org.json.JSONObject	getTypeJSON() return Type JSON for generic chart types
boolean	isClustered()
void	setDefaultShape(int shape) set the default shape for all bars in this chart

Methods inherited from class io.starter.formats.XLS.charts.ChartType

addLegend, addLegend, convertShape, create, createChartTypeObject, createUnderlyingChartObject, getChartOption, getChartOptionsXML, getChartType, getDarkColor, getDataLabel, getDataLabelFontSVG, getDataLabelInts, getDataLabels, getDataLabelsInt, getDataLegend, getFillOpacity, getFontSVG, getFontSVG, getGapDepth, getHasDropLines, getHasLines, getHasSmoothLines, getJSON, getJSON, getLightColor, getMarkerFormat, getMarkerFormats, getMediumColor, getOptionsJSON, getParentChart, getScript, getSeriesList, getShape, getStrokeSVG, getStrokeSVG, getSVG, getSVGDataLabels, getTextColor, getThreeDRec, getThreeDXML, hasDataLegend, initThreeD, is100PercentStacked, isStacked, isThreeD, parseOOXML, setChartOption, setHasDropLines, setHasSmoothLines, setIs100Psercent, setIsStacked, setOptions, setVaryColor, showLegend, WriteMainChartRecs

Methods inherited from class java.lang.Object

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

Field Detail

bar

protected Bar bar

Constructor Detail

BarChart

public BarChart(GenericChartObject charttype,
                ChartFormat cf,
                WorkBook wb)

Method Detail

setDefaultShape

public void setDefaultShape(int shape)

set the default shape for all bars in this chart

Parameters:

shape -

getDefaultShape

public int getDefaultShape()

return the default shape for all bars in this chart

Returns:

isClustered

public boolean isClustered()

Overrides:

isClustered in class ChartType

Returns:

truth of "Chart is Clustered" (Bar/Col only)

getBarShape

public int getBarShape()

returns the bar shape for a column or bar type chart can be one of:
SHAPECOLUMN default
SHAPECONEd
SHAPECONETOMAX
SHAPECYLINDER
SHAPEPYRAMID
SHAPEPYRAMIDTOMAX

Overrides:

getBarShape in class ChartType

Returns:

int bar shape

getOptionsXML

public String getOptionsXML()

Returns:

String XML representation of this chart-type's options

getTypeJSON

public org.json.JSONObject getTypeJSON()
                                throws org.json.JSONException

Description copied from class: ChartType

return Type JSON for generic chart types

Overrides:

getTypeJSON in class ChartType

Returns:

Throws:

org.json.JSONException

getJSON

public org.json.JSONObject getJSON(ChartSeriesHandle[] series,
                                   WorkBookHandle wbh,
                                   Double[] minMax)
                            throws org.json.JSONException

replaces generic getJSON with Bar/Column specifics (necessary for stacked-type charts)

Throws:

org.json.JSONException

getSVG

public String getSVG(HashMap<String,Double> chartMetrics,
                     HashMap<String,Object> axisMetrics,
                     ChartSeries s)

returns SVG to represent the actual chart object i.e. the representation of the series data in the particular format (BAR, LINE, AREA, etc.)

Overrides:

getSVG in class ChartType

Parameters:

chartMetrics - maps chart coords in pixels x, y, w, h, canvasw, canvash, min, max

axisMetrics - maps specific axis options such as xAxisReversed, xPattern ...

categories -

series - arraylist of double[] series values

seriescolors - int[] of series or bar colors color ints

Returns:

String svg

getOOXML

public StringBuffer getOOXML(String catAxisId,
                             String valAxisId,
                             String serAxisId)

gets the chart-type specific ooxml representation:

Overrides:

getOOXML in class ChartType

Returns: