ChartSeries (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:: ChartConstants, Serializable

public class ChartSeries
extends Object
implements ChartConstants, Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Object[]`	`categories`
`protected String[]`	`legends`
`protected double[]`	`minmaxcache`
`protected Chart`	`parentChart`
`protected String[]`	`seriescolors`
`protected ArrayList`	`seriesranges`
`protected ArrayList`	`seriesvalues`

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

ChartSeries()

Constructors
Constructor and Description
`ChartSeries()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Object[] o)` series stores new Object[] {Series Record, Integer.valueOf(nCharts)}
`Series`	`addSeries(String seriesRange, String categoryRange, String bubbleRange, String legendRange, String legendText, ChartType chartObject, int nChart)` Add a series object to the array.
`void`	`addSeriesMapping(int nCharts, int[] seriesList)` for overlay charts, store series list
`boolean`	`changeCategoryRange(String originalrange, String newrange)` changes the category range which matches originalrange to new range
`boolean`	`changeSeriesRange(String originalrange, String newrange)` Change series ranges for ALL matching series
`boolean`	`changeTextValue(String originalval, String newval)` attempts to replace all category elements containing originalval text to newval
`Vector`	`getAllSeries()` get all the series objects for ALL charts (i.e.
`Vector`	`getAllSeries(int nChart)` get all the series objects in the specified chart (-1 for ALL)
`Object[]`	`getCategories()`
`String[]`	`getCategories(int nChart)` Return an array of strings, one for each category
`Ptg[]`	`getCellRangePtgs()` return an array of ALL cell references of the chart
`int[]`	`getDataLabelsPerSeries(int defaultDL, int charttype)` return Data Labels Per Series or default Data Labels, if no overrides specified
`org.json.JSONObject`	`getDataRangeJSON()` retrieve the current data range JSON for comparisons
`String[]`	`getLegends()`
`String[]`	`getLegends(int nChart)` return an array of legend text
`int[]`	`getMarkerFormats()` return 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
`double[]`	`getMetrics(boolean isDirty)` returns an array containing the and maximum values of Y (Value) axis, along with the maximum number of series values of each series (bar, line, etc.) ...
`String`	`getOOXML(int ct, boolean isBubble3d, int nChart)`
`String[]`	`getSeries(int nChart)` Return a string representing all series in this chart
`Series`	`getSeries(String seriesName, int nChart)` get a chart series handle based off the series name
`String[]`	`getSeriesBarColors()`
`org.json.JSONArray`	`getSeriesJSON()` retrieve the current Series JSON for comparisons
`HashMap`	`getSeriesPtgs()`
`ArrayList`	`getSeriesRanges()`
`ArrayList`	`getSeriesValues()`
`static Series`	`parseOOXML(org.xmlpull.v1.XmlPullParser xpp, WorkBookHandle wbh, ChartType parentChart, boolean hasPivotTableSource, Stack<String> lastTag)` parse a chartSpace->chartType->ser element into our Series record/structure
`void`	`removeSeries(int index)` specialty method to take absolute index of series and remove it only used in WorkSheetHandle
`void`	`removeSeries(Series seriestodelete)` remove desired series from chart
`void`	`resetSeriesNumber()` all contain: idx (index) order (order) tx (series text) spPr (shape properties) then after, may contain: bubble: invertIfNegative, dPt, dLbls, trendline, errBars, xVal, yVal, bubbleSize, bubble3D (bubbleChart) line marker, dPt, dLbls, trendline, errBars, cat, val, smooth (line3DChart, lineChart, stockChart) pie: explosion, dPt,dLbls, cat, val (doughnutChart, ofPieChart, pie3DChart, pieChart) surface: cat, val (surfaceChart, surface3DChart) scatter: marker, dPt, dLbls, trendline, errBars, xVal, yVal, smooth (scatterChart) radar: marker, dPt, dLbls, cat, val (radarChart) area: pictureOptions, dPt, dLbls, trendline, errBars, cat, val (area3DChart, areaChart) bar: invertIfNegative, pictureOptions, dPt, dLbls, trendline, errBars, cat, val, shape (bar3DChart, barChart)
`void`	`setParentChart(Chart c)`
`void`	`setSeriesJSON(org.json.JSONArray s)` set the current Series JSON
`protected void`	`updateSeriesMappings(SeriesList sl, int thischartnumber)` if has multiple or overlay charts, update series mappings

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

- Field Detail
  - minmaxcache
```
protected double[] minmaxcache
```
  - legends
```
protected String[] legends
```
  - seriesranges
```
protected ArrayList seriesranges
```
  - categories
```
protected Object[] categories
```
  - seriesvalues
```
protected ArrayList seriesvalues
```
  - seriescolors
```
protected String[] seriescolors
```
  - parentChart
```
protected Chart parentChart
```
- Constructor Detail
  - ChartSeries
```
public ChartSeries()
```
- Method Detail
  - add
```
public void add(Object[] o)
```
    series stores new Object[] {Series Record, Integer.valueOf(nCharts)}
    
    Parameters:
    
    o -
  - setParentChart
```
public void setParentChart(Chart c)
```
  - getMetrics
```
public double[] getMetrics(boolean isDirty)
```
    returns an array containing the and maximum values of Y (Value) axis, along with the maximum number of series values of each series (bar, line, etc.) ...
    sets all series cache values: seriesvalues, seriesranges, seriescolors, legends and minmaxcache
    Note: this will only reset cached values if isDirty
    
    Returns:
    
    double[]
  - changeSeriesRange
```
public boolean changeSeriesRange(String originalrange,
                                 String newrange)
```
    Change series ranges for ALL matching series
    
    Parameters:
    
    originalrange -
    
    newrange -
    
    Returns:
  - getSeries
```
public String[] getSeries(int nChart)
```
    Return a string representing all series in this chart
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts -1 for ALL charts
    
    Returns:
  - getCategories
```
public String[] getCategories(int nChart)
```
    Return an array of strings, one for each category
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts -1 for All
    
    Returns:
  - getAllSeries
```
public Vector getAllSeries()
```
    get all the series objects for ALL charts (i.e. even in overlay charts)
    
    Returns:
  - getAllSeries
```
public Vector getAllSeries(int nChart)
```
    get all the series objects in the specified chart (-1 for ALL)
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts -1 for ALL series
    
    Returns:
  - addSeries
```
public Series addSeries(String seriesRange,
                        String categoryRange,
                        String bubbleRange,
                        String legendRange,
                        String legendText,
                        ChartType chartObject,
                        int nChart)
```
    Add a series object to the array.
    
    Parameters:
    
    seriesRange - = one row range, expressed as (Sheet1!A1:A12);
    
    categoryRange - = category range
    
    bubbleRange= - bubble range, if any 20070731 KSC
    
    seriesText - = label for the series;
    
    nChart - 0=default, 1-9= overlay charts s * @return
  - removeSeries
```
public void removeSeries(int index)
```
    specialty method to take absolute index of series and remove it
    only used in WorkSheetHandle
    
    Parameters:
    
    index -
  - removeSeries
```
public void removeSeries(Series seriestodelete)
```
    remove desired series from chart
    
    Parameters:
    
    index -
  - getSeries
```
public Series getSeries(String seriesName,
                        int nChart)
```
    get a chart series handle based off the series name
    
    Parameters:
    
    seriesName -
    
    nChart - 0=default, 1-9= overlay charts
    
    Returns:
  - changeCategoryRange
```
public boolean changeCategoryRange(String originalrange,
                                   String newrange)
```
    changes the category range which matches originalrange to new range
    
    Parameters:
    
    originalrange -
    
    newrange -
    
    Returns:
  - changeTextValue
```
public boolean changeTextValue(String originalval,
                               String newval)
```
    attempts to replace all category elements containing originalval text to newval
    
    Parameters:
    
    originalval -
    
    newval -
    
    Returns:
  - getDataRangeJSON
```
public org.json.JSONObject getDataRangeJSON()
```
    retrieve the current data range JSON for comparisons
    
    Returns:
    
    JSONObject in form of: c:catgeory range, {v:series range, l:legendrange, b: bubble sizes} for each series
  - getSeriesJSON
```
public org.json.JSONArray getSeriesJSON()
```
    retrieve the current Series JSON for comparisons
    
    Returns:
    
    JSONArray
  - setSeriesJSON
```
public void setSeriesJSON(org.json.JSONArray s)
                   throws org.json.JSONException
```
    set the current Series JSON
    
    Parameters:
    
    s - JSONArray
    
    Throws:
    
    org.json.JSONException
  - getCellRangePtgs
```
public Ptg[] getCellRangePtgs()
```
    return an array of ALL cell references of the chart
  - getSeriesPtgs
```
public HashMap getSeriesPtgs()
```
    Returns:
    
    an HashMap of Series Range Ptgs mapped by Series representing all the series in the chart
  - addSeriesMapping
```
public void addSeriesMapping(int nCharts,
                             int[] seriesList)
```
    for overlay charts, store series list
    
    Parameters:
    
    nCharts -
    
    seriesList -
  - getLegends
```
public String[] getLegends(int nChart)
```
    return an array of legend text
    
    Parameters:
    
    nChart - 0=default, 1-9= overlay charts -1 for ALL
  - getMarkerFormats
```
public int[] getMarkerFormats()
```
    return 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
  - parseOOXML
```
public static Series parseOOXML(org.xmlpull.v1.XmlPullParser xpp,
                                WorkBookHandle wbh,
                                ChartType parentChart,
                                boolean hasPivotTableSource,
                                Stack<String> lastTag)
```
    parse a chartSpace->chartType->ser element into our Series record/structure
    
    Parameters:
    
    xpp - XML pullparser positioned at ser element
    
    wbh - WorkBookHandle
    
    parentChart - parent chart object
    
    lastTag -
    
    Returns:
  - resetSeriesNumber
```
public void resetSeriesNumber()
```
    all contain: idx (index) order (order) tx (series text) spPr (shape properties) then after, may contain: bubble: invertIfNegative, dPt, dLbls, trendline, errBars, xVal, yVal, bubbleSize, bubble3D (bubbleChart) line marker, dPt, dLbls, trendline, errBars, cat, val, smooth (line3DChart, lineChart, stockChart) pie: explosion, dPt,dLbls, cat, val (doughnutChart, ofPieChart, pie3DChart, pieChart) surface: cat, val (surfaceChart, surface3DChart) scatter: marker, dPt, dLbls, trendline, errBars, xVal, yVal, smooth (scatterChart) radar: marker, dPt, dLbls, cat, val (radarChart) area: pictureOptions, dPt, dLbls, trendline, errBars, cat, val (area3DChart, areaChart) bar: invertIfNegative, pictureOptions, dPt, dLbls, trendline, errBars, cat, val, shape (bar3DChart, barChart)
  - getOOXML
```
public String getOOXML(int ct,
                       boolean isBubble3d,
                       int nChart)
```
  - updateSeriesMappings
```
protected void updateSeriesMappings(SeriesList sl,
                                    int thischartnumber)
```
    if has multiple or overlay charts, update series mappings
    
    Parameters:
    
    sl -
    
    thischartnumber -
  - getDataLabelsPerSeries
```
public int[] getDataLabelsPerSeries(int defaultDL,
                                    int charttype)
```
    return Data Labels Per Series or default Data Labels, if no overrides specified
    
    Parameters:
    
    defaultDL - Default Data labels
    
    charttype - Chart Type Int
    
    Returns:
  - getLegends
```
public String[] getLegends()
```
  - getCategories
```
public Object[] getCategories()
```
  - getSeriesRanges
```
public ArrayList getSeriesRanges()
```
  - getSeriesValues
```
public ArrayList getSeriesValues()
```
  - getSeriesBarColors
```
public String[] getSeriesBarColors()
```

Class ChartSeries

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

minmaxcache

legends

seriesranges

categories

seriesvalues

seriescolors

parentChart

Constructor Detail

ChartSeries

Method Detail

add

setParentChart

getMetrics

changeSeriesRange

getSeries

getCategories

getAllSeries

getAllSeries

addSeries

removeSeries

removeSeries

getSeries

changeCategoryRange

changeTextValue

getDataRangeJSON

getSeriesJSON

setSeriesJSON

getCellRangePtgs

getSeriesPtgs

addSeriesMapping

getLegends

getMarkerFormats

parseOOXML

resetSeriesNumber

getOOXML

updateSeriesMappings

getDataLabelsPerSeries

getLegends

getCategories

getSeriesRanges

getSeriesValues

getSeriesBarColors