ChartType (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.charts.ChartType

All Implemented Interfaces:

ChartConstants, Serializable

Direct Known Subclasses:

AreaChart, BarChart, BubbleChart, ColChart, DoughnutChart, LineChart, OfPieChart, PieChart, RadarChart, ScatterChart, SurfaceChart
```
public abstract class ChartType
extends Object
implements ChartConstants, Serializable
```
This abstract class defines a Chart Group for a BIFF Chart. An Excel Chart may have up to 4 (2003 and previous versions) or 9 (post-2003) charts within one chart. The 0th chart type in the Chart Group is the default chart.
NOTES:
CRT = ChartFormat Begin (Bar / Line / (BopPop [BopPopCustom]) / Pie / Area / Scatter / Radar / RadarArea / Surf) CrtLink [SeriesList] [Chart3d] [LD] [2DROPBAR] *4(CrtLine LineFormat) *2DFTTEXT [DataLabExtContents] [SS] *4SHAPEPROPS End MUST CHANGE ChartObject if change chart type MUST ADD/REMOVE ChartObject if add/remove multiple charts axisparent --> when add a new chart a new crt is added axes + titles/labels, number format, etc REFACTOR: TO FINISH showDataTable -- Finish, TODO NOTE: The SeriesList record specifies the series of the chart. This record MUST NOT exist in the first chart group in the chart sheet substream. This record MUST exist when not in the first chart group in the chart sheet substream NOTE: The Chart3d record specifies that the plot area, axis group, and chart group are rendered in a 3-D scene, rather than a 2-D scene, and specifies properties of the 3-D scene. If this record exists in the chart sheet substream, the chart sheet substream MUST have exactly one chart group. This record MUST NOT exist in a bar of pie, bubble, doughnut, filled radar, pie of pie, radar, or scatter chart group. NOTE: legends only in 1st chart group

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected ChartFormat`	`cf`
`protected GenericChartObject`	`chartobj`
`protected int`	`defaultShape`
`protected Legend`	`legend`
`protected WorkBook`	`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

ChartType()

ChartType(GenericChartObject charttype, ChartFormat cf, WorkBook wb)

Constructors
Constructor and Description
`ChartType()`
`ChartType(GenericChartObject charttype, ChartFormat cf, WorkBook wb)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLegend()`
`void`	`addLegend(Legend l)`
`int`	`convertShape(String shape)` Convert the user-friendly OOXML shape string to 2003-v int shape flag
`static ChartType`	`create(int chartType, Chart parentChart, ChartFormat cf)` creates a new chart type object of the desired chart type.
`static ChartType`	`createChartTypeObject(GenericChartObject ch, ChartFormat cf, WorkBook wb)` create and return the appropriate ChartType for the given chart record (Bar, Radar, Line, etc)
`static GenericChartObject`	`createUnderlyingChartObject(int chartType, Chart parentchart, ChartFormat cf)` create a new low-level chart object which determines the ChartTypeObject, and update the existing chartobj
`int`	`getBarShape()` returns the bar shape for a column or bar type chart can be one of: ChartConstants.SHAPECOLUMN default ChartConstants.SHAPECONEd ChartConstants.SHAPECONETOMAX ChartConstants.SHAPECYLINDER ChartConstants.SHAPEPYRAMID ChartConstants.SHAPEPYRAMIDTOMAX
`String`	`getChartOption(String op)` look up a generic chart option
`String`	`getChartOptionsXML()` return chart-type-specific options in XML form
`int`	`getChartType()` returns the chart type for the default chart
`static String`	`getDarkColor()`
`protected int`	`getDataLabel()` return the default data label setting for the chart, if any NOTE: each series can override the default data label for the chart can be one or more of: VALUELABEL= 0x1; VALUEPERCENT= 0x2; CATEGORYPERCENT= 0x4; SMOOTHEDLINE= 0x8; CATEGORYLABEL= 0x10; BUBBLELABEL= 0x20; SERIESLABEL= 0x40;
`static String`	`getDataLabelFontSVG()` Returns SVG used to define font for data labels TODO: read correct value from chart recs
`protected int[]`	`getDataLabelInts()` return data label options for each series as an int array each can be one or more of: VALUELABEL= 0x1; VALUEPERCENT= 0x2; CATEGORYPERCENT= 0x4; SMOOTHEDLINE= 0x8; CATEGORYLABEL= 0x10; BUBBLELABEL= 0x20; SERIESLABEL= 0x40;
`String`	`getDataLabels()` return the Data Labels chosen for this chart, if any can be one or more of: Value ValuePerecentage CategoryPercentage CategoryLabel BubbleLabel SeriesLabel or an empty string if no data labels are chosen for the chart
`int`	`getDataLabelsInt()` return data label options as an int can be one or more of: VALUELABEL= 0x1; VALUEPERCENT= 0x2; CATEGORYPERCENT= 0x4; SMOOTHEDLINE= 0x8; CATEGORYLABEL= 0x10; BUBBLELABEL= 0x20; SERIESLABEL= 0x40;
`Legend`	`getDataLegend()` return the data legend for this chart
`static String`	`getFillOpacity()`
`protected String`	`getFontSVG()` returns the SVG for the font style of this object
`protected String`	`getFontSVG(int sz)` returns the SVG for the font style of this object
`int`	`getGapDepth()` returns an int representing the space between points in a 3d area, bar or line chart, or 0 if not 3d
`boolean`	`getHasDropLines()` returns true if this chart has drop lines
`boolean`	`getHasLines()` returns true if this chart has lines (see Scatter, Line Charts amongst others)
`boolean`	`getHasSmoothLines()` returns true if this chart has smoothed lines
`String`	`getJSON()`
`org.json.JSONObject`	`getJSON(ChartSeries s, WorkBookHandle wbh, Double[] minMax)`
`static String`	`getLightColor()`
`int`	`getMarkerFormat()` returns type of marker for this chart, if any 0 = no marker 1 = square 2 = diamond 3 = triangle 4 = X 5 = star 6 = Dow-Jones 7 = standard deviation 8 = circle 9 = plus sign
`protected int[]`	`getMarkerFormats()` return an array of the type of markers for each series: 0 = no marker 1 = square 2 = diamond 3 = triangle 4 = X 5 = star 6 = Dow-Jones 7 = standard deviation 8 = circle 9 = plus sign
`static String`	`getMediumColor()`
`StringBuffer`	`getOOXML(String catAxisId, String valAxisId, String serAxisId)` gets the chart-type specific OOXML representation (representing child element of plotArea element)
`org.json.JSONObject`	`getOptionsJSON()`
`Chart`	`getParentChart()`
`static String`	`getScript(String range)`
`protected SeriesList`	`getSeriesList()` return the SeriesList record for this chart object The SeriesList record maps the series for the chart.
`String`	`getShape()` convert the default shape flag to a user-friendly (OOXML-compliant) String
`static String`	`getStrokeSVG()` returns the SVG for the font style of this object
`static String`	`getStrokeSVG(float sz, String strokeclr)` returns the SVG for the font style of this object
`String`	`getSVG()`
`String`	`getSVG(HashMap<String,Double> chartMetrics, HashMap<String,Object> axisMetrics, ChartSeries s)` returns SVG to represent the actual chart object (BAR, LINE, AREA, etc.)
`String`	`getSVGDataLabels(int[] datalabels, HashMap<String,Object> axisMetrics, double val, double percentage, int s, String[] legends, String cat)` returns the SVG-ready data label for the given set of data label options TODO: get separator character
`static String`	`getTextColor()`
`ThreeD`	`getThreeDRec(boolean bCreate)` return the 3d record of the chart Creates if not present, if bCreate is true
`String`	`getThreeDXML()` return ThreeD settings for this chart in XML form
`org.json.JSONObject`	`getTypeJSON()` return Type JSON for generic chart types
`boolean`	`hasDataLegend()` return truth if Chart has a data legend key showing
`ThreeD`	`initThreeD(int charttype)` returns the 3d record of the desired chart
`boolean`	`is100PercentStacked()` return truth of "Chart is 100% Stacked"
`boolean`	`isClustered()`
`boolean`	`isStacked()`
`boolean`	`isThreeD()`
`static ChartType`	`parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle wbh, Chart parentChart, int nChart)` parse the chart object OOXML element (barchart, area3DChart, etc.) and create the corresponding chart type objects
`boolean`	`setChartOption(String op, String val)` interface for setting chart-type-specific options in a generic fashion
`void`	`setHasDropLines()` sets this chart (Area, Line, Scatter) to have drop lines
`void`	`setHasSmoothLines(boolean b)`
`void`	`setIs100Psercent(boolean ispercentage)`
`void`	`setIsStacked(boolean isstacked)`
`void`	`setOptions(EnumSet<ChartHandle.ChartOptions> options)`
`protected void`	`setVaryColor(boolean b)` specifies whether the color for each data point and the color and type for each data marker vary
`void`	`showLegend(boolean bShow, boolean vertical)` show or hide chart legend key
`void`	`WriteMainChartRecs(String fName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - chartobj
```
protected GenericChartObject chartobj
```
  - legend
```
protected Legend legend
```
  - cf
```
protected ChartFormat cf
```
  - wb
```
protected transient WorkBook wb
```
  - defaultShape
```
protected int defaultShape
```
- Constructor Detail
  - ChartType
```
public ChartType()
```
  - ChartType
```
public ChartType(GenericChartObject charttype,
                 ChartFormat cf,
                 WorkBook wb)
```
- Method Detail
  - getParentChart
```
public Chart getParentChart()
```
  - create
```
public static ChartType create(int chartType,
                               Chart parentChart,
                               ChartFormat cf)
```
    creates a new chart type object of the desired chart type. Will set options if already set via ChartFormat
    
    Parameters:
    
    chartType -
    
    parentChart -
    
    cf -
    
    Returns:
  - createChartTypeObject
```
public static ChartType createChartTypeObject(GenericChartObject ch,
                                              ChartFormat cf,
                                              WorkBook wb)
```
    create and return the appropriate ChartType for the given chart record (Bar, Radar, Line, etc)
    
    Parameters:
    
    ch - GenericChartObject representing the Chart Type
    Must be one of: Area, Bar, Line, Surface, Pie, Radar, Scatter, BopPop, RadarArea
    
    Returns:
    
    ChartType chart object
  - createUnderlyingChartObject
```
public static GenericChartObject createUnderlyingChartObject(int chartType,
                                                             Chart parentchart,
                                                             ChartFormat cf)
```
    create a new low-level chart object which determines the ChartTypeObject, and update the existing chartobj
    
    Parameters:
    
    chartType -
    
    parentchart -
    
    chartgroup -
    
    Returns:
  - setOptions
```
public void setOptions(EnumSet<ChartHandle.ChartOptions> options)
```
  - parseOOXML
```
public static ChartType parseOOXML(org.xmlpull.v1.XmlPullParser xpp,
                                   WorkBookHandle wbh,
                                   Chart parentChart,
                                   int nChart)
```
    parse the chart object OOXML element (barchart, area3DChart, etc.) and create the corresponding chart type objects
    
    Parameters:
    
    xpp - XmlPullParser
    
    wbh - workBookHandle
    
    parentChart - parent Chart Object
    
    nChart - chart grouping number, 0 for default, 1-9 for overlay
    
    Returns:
  - getDataLabelInts
```
protected int[] getDataLabelInts()
```
    return data label options for each series as an int array
    each can be one or more of:
    VALUELABEL= 0x1;
    VALUEPERCENT= 0x2;
    CATEGORYPERCENT= 0x4;
    SMOOTHEDLINE= 0x8;
    CATEGORYLABEL= 0x10;
    BUBBLELABEL= 0x20;
    SERIESLABEL= 0x40;
    
    Returns:
    
    int array
    
    See Also:
    
    AttachedLabel
  - getDataLabel
```
protected int getDataLabel()
```
    return the default data label setting for the chart, if any
    NOTE: each series can override the default data label for the chart
    can be one or more of:
    VALUELABEL= 0x1;
    VALUEPERCENT= 0x2;
    CATEGORYPERCENT= 0x4;
    SMOOTHEDLINE= 0x8;
    CATEGORYLABEL= 0x10;
    BUBBLELABEL= 0x20;
    SERIESLABEL= 0x40;
    
    Returns:
    
    int default data label for chart
  - getMarkerFormats
```
protected int[] getMarkerFormats()
```
    return an array of the type of markers for each series:
    0 = no marker
    1 = square
    2 = diamond
    3 = triangle
    4 = X
    5 = star
    6 = Dow-Jones
    7 = standard deviation
    8 = circle
    9 = plus sign
  - setVaryColor
```
protected void setVaryColor(boolean b)
```
    specifies whether the color for each data point and the color and type for each data marker vary
    
    Parameters:
    
    b -
  - getHasSmoothLines
```
public boolean getHasSmoothLines()
```
    returns true if this chart has smoothed lines
    
    Returns:
  - setHasSmoothLines
```
public void setHasSmoothLines(boolean b)
```
  - getChartType
```
public int getChartType()
```
    returns the chart type for the default chart
  - addLegend
```
public void addLegend(Legend l)
```
  - getSVG
```
public String getSVG()
```
  - getJSON
```
public String getJSON()
```
  - getOptionsJSON
```
public org.json.JSONObject getOptionsJSON()
```
  - getOOXML
```
public StringBuffer getOOXML(String catAxisId,
                             String valAxisId,
                             String serAxisId)
```
    gets the chart-type specific OOXML representation (representing child element of plotArea element)
    
    Returns:
  - getJSON
```
public org.json.JSONObject getJSON(ChartSeries s,
                                   WorkBookHandle wbh,
                                   Double[] minMax)
                            throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - getTypeJSON
```
public org.json.JSONObject getTypeJSON()
                                throws org.json.JSONException
```
    return Type JSON for generic chart types
    
    Returns:
    
    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 (BAR, LINE, AREA, etc.)
    
    Parameters:
    
    chartMetrics - maps chart coords in pixels x, y, w, h, canvasw, canvash, min, max
    
    axisMetrics - maps specific axis options such as xAxisReversed, xPattern ...
    
    s - ChartSeries - holds legends, categories, seriesdata ...
    
    Returns:
    
    String svg
  - getSVGDataLabels
```
public String getSVGDataLabels(int[] datalabels,
                               HashMap<String,Object> axisMetrics,
                               double val,
                               double percentage,
                               int s,
                               String[] legends,
                               String cat)
```
    returns the SVG-ready data label for the given set of data label options TODO: get separator character
    
    Parameters:
    
    datalabel - int[] Data label options (indexed by current series # s)
    can be one or more of:
    VALUELABEL= 0x1;
    VALUEPERCENT= 0x2;
    CATEGORYPERCENT= 0x4;
    SMOOTHEDLINE= 0x8;
    CATEGORYLABEL= 0x10;
    BUBBLELABEL= 0x20;
    SERIESLABEL= 0x40;
    
    series - ArrayList of series and category data: structure: category data, series 0-n data, series colors, series Labels (Eventually will be an object)
    
    val - double current series value
    
    percentage - double percentage value (pie charts only)
    
    s - int current series #
    
    cat - string current cat
    
    Returns:
  - hasDataLegend
```
public boolean hasDataLegend()
```
    return truth if Chart has a data legend key showing
    
    Returns:
  - getDataLegend
```
public Legend getDataLegend()
```
    return the data legend for this chart
    
    Returns:
  - showLegend
```
public void showLegend(boolean bShow,
                       boolean vertical)
```
    show or hide chart legend key
    
    Parameters:
    
    bShow - boolean show or hide
    
    vertical - boolean show as vertical or horizontal
  - getDataLabels
```
public String getDataLabels()
```
    return the Data Labels chosen for this chart, if any can be one or more of:
    Value
    ValuePerecentage
    CategoryPercentage
    CategoryLabel
    BubbleLabel
    SeriesLabel or an empty string if no data labels are chosen for the chart
    
    Returns:
  - getDataLabelsInt
```
public int getDataLabelsInt()
```
    return data label options as an int
    can be one or more of:
    VALUELABEL= 0x1;
    VALUEPERCENT= 0x2;
    CATEGORYPERCENT= 0x4;
    SMOOTHEDLINE= 0x8;
    CATEGORYLABEL= 0x10;
    BUBBLELABEL= 0x20;
    SERIESLABEL= 0x40;
    
    Returns:
    
    a combination of data label options above or 0 if none
    
    See Also:
    
    AttachedLabel
  - getBarShape
```
public int getBarShape()
```
    returns the bar shape for a column or bar type chart can be one of:
    ChartConstants.SHAPECOLUMN default
    ChartConstants.SHAPECONEd
    ChartConstants.SHAPECONETOMAX
    ChartConstants.SHAPECYLINDER
    ChartConstants.SHAPEPYRAMID
    ChartConstants.SHAPEPYRAMIDTOMAX
    
    Returns:
    
    int bar shape
  - getMarkerFormat
```
public int getMarkerFormat()
```
    returns type of marker for this chart, if any
    0 = no marker
    1 = square
    2 = diamond
    3 = triangle
    4 = X
    5 = star
    6 = Dow-Jones
    7 = standard deviation
    8 = circle
    9 = plus sign
    
    Returns:
    
    int marker type
  - getHasLines
```
public boolean getHasLines()
```
    returns true if this chart has lines (see Scatter, Line Charts amongst others)
    
    Returns:
  - getHasDropLines
```
public boolean getHasDropLines()
```
    returns true if this chart has drop lines
    
    Returns:
  - setHasDropLines
```
public void setHasDropLines()
```
    sets this chart (Area, Line, Scatter) to have drop lines
  - getChartOption
```
public String getChartOption(String op)
```
    look up a generic chart option
    
    Parameters:
    
    op -
    
    Returns:
  - getChartOptionsXML
```
public String getChartOptionsXML()
```
    return chart-type-specific options in XML form
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
    
    String XML
  - setChartOption
```
public boolean setChartOption(String op,
                              String val)
```
    interface for setting chart-type-specific options in a generic fashion
    
    Parameters:
    
    op - option
    
    val - value
    
    See Also:
    
    OpenXLS.handleChartElement, ChartHandle.getXML
  - isThreeD
```
public boolean isThreeD()
```
    Returns:
    
    truth of "Chart is Three-D"
  - getThreeDXML
```
public String getThreeDXML()
```
    return ThreeD settings for this chart in XML form
    
    Returns:
    
    String XML
  - initThreeD
```
public ThreeD initThreeD(int charttype)
```
    returns the 3d record of the desired chart
    
    Parameters:
    
    chartType - one of the chart type constants
    
    Returns:
  - getThreeDRec
```
public ThreeD getThreeDRec(boolean bCreate)
```
    return the 3d record of the chart
    Creates if not present, if bCreate is true
    
    Returns:
  - isStacked
```
public boolean isStacked()
```
    Returns:
    
    truth of "Chart is Stacked"
  - is100PercentStacked
```
public boolean is100PercentStacked()
```
    return truth of "Chart is 100% Stacked"
    
    Returns:
  - setIsStacked
```
public void setIsStacked(boolean isstacked)
```
  - setIs100Psercent
```
public void setIs100Psercent(boolean ispercentage)
```
  - isClustered
```
public boolean isClustered()
```
    Returns:
    
    truth of "Chart is Clustered" (Bar/Col only)
  - addLegend
```
public void addLegend()
```
  - getScript
```
public static String getScript(String range)
```
  - getFillOpacity
```
public static String getFillOpacity()
```
  - getTextColor
```
public static String getTextColor()
```
  - getLightColor
```
public static String getLightColor()
```
  - getMediumColor
```
public static String getMediumColor()
```
  - getDarkColor
```
public static String getDarkColor()
```
  - getFontSVG
```
protected String getFontSVG()
```
    returns the SVG for the font style of this object
  - getDataLabelFontSVG
```
public static String getDataLabelFontSVG()
```
    Returns SVG used to define font for data labels TODO: read correct value from chart recs
    
    Returns:
  - getStrokeSVG
```
public static String getStrokeSVG()
```
    returns the SVG for the font style of this object
    
    Parameters:
    
    stroke - size in pt
  - getStrokeSVG
```
public static String getStrokeSVG(float sz,
                                  String strokeclr)
```
    returns the SVG for the font style of this object
    
    Parameters:
    
    stroke - size in pt
    
    String - stroke color in HTML format
  - getFontSVG
```
protected String getFontSVG(int sz)
```
    returns the SVG for the font style of this object
    
    Parameters:
    
    font - size in pt
  - convertShape
```
public int convertShape(String shape)
```
    Convert the user-friendly OOXML shape string to 2003-v int shape flag
    
    Parameters:
    
    shape -
    
    Returns:
  - getShape
```
public String getShape()
```
    convert the default shape flag to a user-friendly (OOXML-compliant) String
    
    Parameters:
    
    shape - int
    
    Returns:
  - getGapDepth
```
public int getGapDepth()
```
    returns an int representing the space between points in a 3d area, bar or line chart, or 0 if not 3d
    
    Returns:
  - getSeriesList
```
protected SeriesList getSeriesList()
```
    return the SeriesList record for this chart object The SeriesList record maps the series for the chart.
    
    Returns:
  - WriteMainChartRecs
```
public void WriteMainChartRecs(String fName)
```
    Parameters:
    
    fName -

Class ChartType

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

chartobj

legend

cf

wb

defaultShape

Constructor Detail

ChartType

ChartType

Method Detail

getParentChart

create

createChartTypeObject

createUnderlyingChartObject

setOptions

parseOOXML

getDataLabelInts

getDataLabel

getMarkerFormats

setVaryColor

getHasSmoothLines

setHasSmoothLines

getChartType

addLegend

getSVG

getJSON

getOptionsJSON

getOOXML

getJSON

getTypeJSON

getSVG

getSVGDataLabels

hasDataLegend

getDataLegend

showLegend

getDataLabels

getDataLabelsInt

getBarShape

getMarkerFormat

getHasLines

getHasDropLines

setHasDropLines

getChartOption

getChartOptionsXML

setChartOption

isThreeD

getThreeDXML

initThreeD

getThreeDRec

isStacked

is100PercentStacked

setIsStacked

setIs100Psercent

isClustered

addLegend

getScript

getFillOpacity

getTextColor

getLightColor

getMediumColor

getDarkColor

getFontSVG

getDataLabelFontSVG

getStrokeSVG

getStrokeSVG

getFontSVG

convertShape

getShape

getGapDepth

getSeriesList

WriteMainChartRecs