ChartHandle (ExtenXLS v10.1-20110808)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.extentech.ExtenXLS
Class ChartHandle

java.lang.Object
  com.extentech.ExtenXLS.ChartHandle

All Implemented Interfaces:: com.extentech.formats.XLS.charts.ChartConstants

public class ChartHandle
extends Object
implements com.extentech.formats.XLS.charts.ChartConstants
extends Object
implements com.extentech.formats.XLS.charts.ChartConstants

Chart Handle allows for manipulation of Charts within a WorkBook.
Allows for run-time modification of Chart titles, labels, categories, and data Cells.
Modification of Chart data cells allows you to completely modify the data shown on the Chart.

Version:: 4.1
Author:: John McMahon -- Copyright ©2011Extentech Inc.
See Also:: WorkBookHandle

Field Summary
`static int`	`AREA`
`static int`	`BAR`
`static int`	`BUBBLE`
`static int`	`COL`
`static int`	`CONE`
`static int`	`CONEBAR`
`static int`	`CYLINDER`
`static int`	`CYLINDERBAR`
`static int`	`DOUGHNUT`
`static int`	`HEIGHT`
`static int`	`LINE`
`static int`	`PIE`
`static int`	`PYRAMID`
`static int`	`PYRAMIDBAR`
`static int`	`RADAR`
`static int`	`RADARAREA`
`static int`	`SCATTER`
`static int`	`SURFACE`
`static int`	`WIDTH`
`static int`	`X`
`static int`	`XAXIS`
`static int`	`XVALAXIS`
`static int`	`Y`
`static int`	`YAXIS`
`static int`	`ZAXIS`

Fields inherited from interface com.extentech.formats.XLS.charts.ChartConstants
`SHAPECOLUMN, SHAPECONE, SHAPECONETOMAX, SHAPECYLINDER, SHAPEPYRAMID, SHAPEPYRAMIDTOMAX`

Constructor Summary
`ChartHandle(com.extentech.formats.XLS.charts.Chart c, WorkBookHandle wb)` Constructor which creates a new ChartHandle from an existing Chart Object

Method Summary
`void`	`addAllSeries(String[] valueRanges, String[] legendCells, String[] bubbleSizeRanges, String categoryRange)` updates (replaces) every Chart Series (bar, line or wedge on the Chart) with the data from the array of values, legends, bubble sizes (optional) and category range.
`void`	`addChartEmbed(String[] ce)` sets external information linked to or "embedded" in this OOXML chart; can be a chart user shape, an image ...
`ChartSeriesHandle`	`addSeriesRange(CellHandle legendCell, CellRange categoryRange, CellRange seriesRange, CellRange bubbleRange)` Adds a new Series to the chart via CellHandles and CellRange Objects.
`ChartSeriesHandle`	`addSeriesRange(CellHandle legendCell, CellRange categoryRange, CellRange seriesRange, CellRange bubbleRange, int nChart)` Adds a new Series to the chart via CellHandles and CellRange Objects.
`ChartSeriesHandle`	`addSeriesRange(String legendCell, String categoryRange, String seriesRange, String bubbleRange)` Adds a new Series to the chart.
`ChartSeriesHandle`	`addSeriesRange(String legendCell, String categoryRange, String seriesRange, String bubbleRange, int nChart)` Adds a new Series to the chart.
`void`	`appendRowCategoryToChart()` Append a row of categories to the bottom of the chart.
`void`	`appendRowCategoryToChart(int nChart)` Append a row of categories to the bottom of the chart.
`ChartSeriesHandle`	`appendRowSeriesToChart()` Appends a series one row below the last series in the chart.
`ChartSeriesHandle`	`appendRowSeriesToChart(int nChart)` Appends a series one row below the last series in the chart for the desired chart
`boolean`	`changeCategoryRange(String originalrange, String newrange)` Change the Cell Range representing the Categories in the Chart.
`boolean`	`changeSeriesRange(String originalrange, String newrange)` Change the Cell Range referenced by one of the Series (a bar, line or wedge of data) in the Chart.
`boolean`	`changeTextValue(String originalval, String newval)` Change the value of a Chart object.
`ChartSeriesHandle[]`	`getAllChartSeriesHandles()` Returns an array of ChartSeriesHandle Objects, one for each bar, line or wedge of data.
`ChartSeriesHandle[]`	`getAllChartSeriesHandles(int nChart)` Returns an array of ChartSeriesHandle Objects for the desired chart, one for each bar, line or wedge of data.
`String`	`getAllSeriesDataJSON()` returns a JSON representation of all Series Data (Legend, Categogies, Series Values) for the chart This is an internal method that is not useful to the end user.
`com.extentech.formats.XLS.charts.Axis`	`getAxis(int axisType)` returns the desired axis (creates if doesn't exist)
`boolean`	`getAxisAutomaticScale()` Returns true if the Y Axis (Value axis) is set to automatic scale
`boolean`	`getAxisAutomaticScale(int axisType)` Returns true if the desired Value axis is set to automatic scale
`com.extentech.formats.XLS.Font`	`getAxisFont()` return the Font associated with the Chart Axes
`int`	`getAxisMajorUnit()` Returns the major tick unit of the Y Axis (Value Axis)
`int`	`getAxisMajorUnit(int axisType)` Returns the major tick unit of the desired Value axis
`double`	`getAxisMaxScale()` Returns the maximum value of the Y Axis (Value Axis) scale
`double`	`getAxisMaxScale(int axisType)` Returns the maximum scale value of the desired Value axis
`int`	`getAxisMinorUnit()` Returns the minor tick unit of the Y Axis (Value Axis)
`int`	`getAxisMinorUnit(int axisType)` Returns the minor tick unit of the desired Value axis
`double`	`getAxisMinScale()` Returns the minimum value of the Y Axis (Value Axis) scale
`double`	`getAxisMinScale(int axisType)` Returns the minimum scale value of the the desired Value axis
`String`	`getAxisOptions(int Axis)`
`int`	`getAxisPlacement(int Axis)` Returns the Axis Label Placement or position as an int
`short[]`	`getBounds()` returns the coordinates or bounds (position, width and height) of this chart in pixels
`String[]`	`getCategories()` Returns an ordered array of strings representing all the category ranges in the chart.
`byte[]`	`getChartBytes()` Get the Chart's bytes This is an internal method that is not useful to the end user.
`String`	`getChartDrawingOOXML(int id)` generates the OOXML specific for DrawingML, specifying offsets and identifying the chart object.
`ArrayList`	`getChartEmbeds()` returns the drawingml file name which defines the userShape (if any) a userShape is a drawing or shape ontop of a chart associated with this chart
`String`	`getChartFontRecsXML()` returns Chart-specific Font Records in XML form
`String`	`getChartFontsXML()` Return non-axis Chart font ids in XML form
`ChartSeriesHandle`	`getChartSeriesHandle(int idx)` Get the ChartSeriesHandle representing Chart Series Data (Series and Categories) for the specified Series index
`ChartSeriesHandle`	`getChartSeriesHandle(String seriesRange)` Get the ChartSeriesHandle representing Chart Series Data (Series and Categories) for the specified Series range
`ChartSeriesHandle`	`getChartSeriesHandleByName(String legend)` Get the ChartSeriesHandle representing Chart Series Data (Series and Categories) for the Series specified by label (legend)
`int`	`getChartType()` Return an int corresponding to this ChartHandle's Chart Type for the default chart To see possible Chart Types, view the public static int's in ChartHandle.
`int`	`getChartType(int nChart)` Return an int corresponding to this ChartHandle's Chart Type for the specified chart To see possible Chart Types, view the public static int's in ChartHandle.
`short[]`	`getCoords()` returns the coordinates (position, width and height) of this chart in pixels
`org.json.JSONObject`	`getCurrentSeries()` retrieves current series and axis scale info in JSONObject form used upon chart updating This is an internal method that is not useful to the end user.
`int`	`getId()` returns the ordinal id associated with the underlying Chart Object
`String`	`getJSON()` returs the JSON representation of this chart, based upon Dojo-charting-specifics
`String`	`getOOXML(int rId)` Generates OOXML (chartML) for this chart object.
`String`	`getOOXMLName()` return the Excel 7/OOXML-specific name for this chart
`String`	`getPdfXML()` returns the correct XML for Pdf Input
`int`	`getPlotAreaBgColor()` return the background color of this chart's Plot Area as an int
`short[]`	`getRelativeBounds()` get the bounds of the chart using coordinates relative to row/cols and their offsets
`byte[]`	`getSerialBytes()`
`String[]`	`getSeries()` Returns an ordered array of strings representing all the series ranges in the Chart.
`org.json.JSONArray`	`getSeriesJSON()` retrieves the saved Series JSON for comparisons This is an internal method that is not useful to the end user.
`com.extentech.formats.XLS.Boundsheet`	`getSheet()` returns the underlhying Sheet Object this Chart is attached to For Internal Use
`String`	`getSVG()` TODO: Less Common Charts: STOCK RADAR SURFACE COLUMN- 3D, CONE, CYLINDER, PYRAMID BAR- 3D, CONE, CYLINDER, PYRAMID 3D PIE 3D LINE 3D AREA LINE CHART APPEARS THAT STARTS AND ENDS A BIT TOO EARLY ***************** Z Axis CHART OPTIONS: STACKED CLUSTERED
`String`	`getSVG(double scale)` /** Take current Chart object and return the SVG code necessary to define it, scaled to the desired percentage e.g.
`String`	`getThreeDXML()`
`String`	`getTitle()` Returns the title of the Chart
`com.extentech.formats.XLS.Font`	`getTitleFont()` returns the Font associated with the Chart Title
`com.extentech.formats.XLS.WorkBook`	`getWorkBook()`
`String`	`getXAxisLabel()` returns the X axis Label
`String`	`getXML()` returns an XML representation of this chart
`String`	`getYAxisLabel()` returns the Y axis Label
`String`	`getZAxisLabel()` returns the Z axis Label, if any
`boolean`	`hasDataLegend()` returns true if Chart has a Data Legend Key showing
`com.extentech.formats.XLS.charts.ThreeD`	`initThreeD(int nChart)` Make chart 3D if not already
`boolean`	`is100PercentStacked()`
`boolean`	`isClustered()`
`boolean`	`isStacked()`
`boolean`	`isThreeD()`
`void`	`make100PercentStacked(int nChart)` makes this Chart 100% Stacked sets the group of options necessary to create a 100% stacked chart For Chart Types: BAR, COL, LINE, PYRAMID, PYRAMIDBAR, CYLINDER, CYLINDERBAR, CONE, CONEBAR
`void`	`make100PercentStacked3D(int nChart)` makes this Chart 100% Stacked with a 3D Effect sets the group of options necessary to create a 100% Stacked 3D chart For Chart Types: BAR, COL, AREA
`void`	`make3D()` makes the default Chart hava a 3D effect sets the group of options necessary to create a 3D chart For Chart Types: BAR, COL, LINE, PIE, AREA, BUBBLE, PYRAMID, CYLINDER, CONE
`void`	`makeClustered3D(int nChart)` makes this Chart Clusted with a 3D effect sets the group of options necessary to create a Clusted 3D chart For Chart Types: BAR, COL
`void`	`makeExploded()` makes this chart's wedges exploded i.e.
`void`	`makeExploded3D(int nChart)` makes this chart's wedges exploded 3D i.e.
`void`	`makeStacked(int nChart)` makes this Chart Stacked sets the group of options necessary to create a stacked chart For Chart Types: BAR, COL, LINE, AREA, PYRAMID, PYRAMIDBAR, CYLINDER, CYLINDERBAR, CONE, CONEBAR
`void`	`makeStacked3D(int nChart)` makes this Chart Stacked with a 3D Effect sets the group of options necessary to create a Stacked 3D chart For Chart Types: BAR, COL, AREA
`void`	`parseOOXML(InputStream ii)` defines this chart object based on a Chart ML (OOXML) input Stream This is an internal method that is not useful to the end user.
`void`	`removeAxis(int axisType)` removes the desired Axis from the Chart
`void`	`removeSeries(int index)` remove the Series (bar, line or wedge) at the desired index
`void`	`removeSeries(int index, int nChart)` remove the Series (bar, line or wedge) at the desired index
`void`	`setAxisAutomaticScale(boolean b)` Sets the automatic scale option on or off for the Y Axis (Value axis)
`void`	`setAxisAutomaticScale(int axisType, boolean b)` Sets the automatic scale option on or off for the desired Value axis
`void`	`setAxisFont(com.extentech.formats.XLS.Font f)` set the font for all axes on the Chart
`void`	`setAxisFont(String name, int height, boolean bold, boolean italic, boolean underline)` set the font for all axes on the chart
`void`	`setAxisMax(int MaxValue)` Sets the maximum value of the Y Axis (Value Axis) Scale
`void`	`setAxisMax(int axisType, int MaxValue)` Sets the maximum scale value of the desired Value axis
`void`	`setAxisMin(int MinValue)` Sets the minimum value of the Y Axis (Value Axis) Scale
`void`	`setAxisMin(int axisType, int MinValue)` Sets the minimum scale value of the desired Value axis
`void`	`setAxisPlacement(int Axis, int Placement)` Sets the Axis labels position or placement to the desired value (these match Excel placement options)
`void`	`setBounds(short[] bounds)` sets the coordinates or bounds (position, width and height) of this chart in pixels
`void`	`setChartFont(String type, String val)` Set non-axis chart font id for title, default, etc For Internal Use Only
`void`	`setChartOption(String op, String val)` Method for setting Chart-Type-specific options in a generic fashion e.g.
`void`	`setChartType(int chartType)` Sets the Chart type to the specified type To see possible Chart Types, view the public static int's in ChartHandle.
`void`	`setChartType(int chartType, int nChart)` Sets the chart type for multiple or overlay Charts.
`void`	`setCoords(short[] coords)` sets the coordinates (position, width and height) for this chart in pixels
`void`	`setDataLabel(String type, boolean bShowLegendKey)` set DataLabels option for this chart
`void`	`setEditMovement(String editMovement)` Specifies how to resize or move this Chart upon edit This is an internal method that is not useful to the end user.
`boolean`	`setLocationLocked(String loc, boolean l)` Sets the location lock on the Cell Reference at the specified location Used to prevent updating of the Cell Reference when Cells are moved.
`void`	`setMarkerFormat(int imf)` set the marker format style for this chart one of: 0 = no marker 1 = square 2 = diamond 3 = triangle 4 = X 5 = star 6 = Dow-Jones 7 = standard deviation 8 = circle 9 = plus sign For Chart Types: LINE, SCATTER
`void`	`setOOXMLName(String name)` set the Excel 7/OOXML-specific name for this chart
`void`	`setPlotAreaBgColor(int bg)` sets the Plot Area background color
`void`	`setRelativeBounds(short[] bounds)` sets the bounds of the chart using coordinates relative to row/cols and their offsets
`ChartSeriesHandle`	`setSeries(int index, String legendCell, String categoryRange, String seriesRange, String bubbleRange)` Changes or adds a Series to the chart via Series Index.
`ChartSeriesHandle`	`setSeries(int index, String legendCell, String legendText, String categoryRange, String seriesRange, String bubbleRange)` Changes or adds a Series to the chart via Series Index.
`ChartSeriesHandle`	`setSeries(int index, String legendCell, String legendText, String categoryRange, String seriesRange, String bubbleRange, int nChart)` Changes or adds a Series to the desired Chart (either default or overlay) via Series Index.
`void`	`setSeriesJSON(org.json.JSONArray s)` sets the saved Series JSON This is an internal method that is not useful to the end user.
`void`	`setTitle(String title)` Sets the title of the Chart
`void`	`setTitleFont(com.extentech.formats.XLS.Font f)` set the font for the Chart Title
`void`	`setTitleFont(String name, int height, boolean bold, boolean italic, boolean underline)` set the font for the chart title
`void`	`setXAxisLabel(String xLabel)` Sets the XAxisLabel
`void`	`setYAxisLabel(String yLabel)` Sets the Y axis label
`void`	`setZAxisLabel(String zLabel)` set the Z AxisLabel
`void`	`showDataTable(boolean bShow)` shows or removes the Data Table for this chart
`void`	`showLegend(boolean bShow, boolean vertical)` shows or hides the Chart legend key
`String`	`toString()` returns the string representation of this ChartHandle
`void`	`writeChartRecs(String fName)` For internal debugging use only

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

BAR

public static final int BAR

See Also:: Constant Field Values

COL

public static final int COL

See Also:: Constant Field Values

LINE

public static final int LINE

See Also:: Constant Field Values

PIE

public static final int PIE

See Also:: Constant Field Values

AREA

public static final int AREA

See Also:: Constant Field Values

SCATTER

public static final int SCATTER

See Also:: Constant Field Values

RADAR

public static final int RADAR

See Also:: Constant Field Values

SURFACE

public static final int SURFACE

See Also:: Constant Field Values

DOUGHNUT

public static final int DOUGHNUT

See Also:: Constant Field Values

BUBBLE

public static final int BUBBLE

See Also:: Constant Field Values

RADARAREA

public static final int RADARAREA

See Also:: Constant Field Values

PYRAMID

public static final int PYRAMID

See Also:: Constant Field Values

CYLINDER

public static final int CYLINDER

See Also:: Constant Field Values

CONE

public static final int CONE

See Also:: Constant Field Values

PYRAMIDBAR

public static final int PYRAMIDBAR

See Also:: Constant Field Values

CYLINDERBAR

public static final int CYLINDERBAR

See Also:: Constant Field Values

CONEBAR

public static final int CONEBAR

See Also:: Constant Field Values

XAXIS

public static final int XAXIS

See Also:: Constant Field Values

YAXIS

public static final int YAXIS

See Also:: Constant Field Values

ZAXIS

public static final int ZAXIS

See Also:: Constant Field Values

XVALAXIS

public static final int XVALAXIS

See Also:: Constant Field Values

X

public static final int X

See Also:: Constant Field Values

Y

public static final int Y

See Also:: Constant Field Values

WIDTH

public static final int WIDTH

See Also:: Constant Field Values

HEIGHT

public static final int HEIGHT

See Also:: Constant Field Values

Constructor Detail

ChartHandle

public ChartHandle(com.extentech.formats.XLS.charts.Chart c,
                   WorkBookHandle wb)

Constructor which creates a new ChartHandle from an existing Chart Object

Parameters:: Chart - c - the source Chart object; WorkBookHandle - wb - the parent WorkBookHandle

Method Detail

getTitle

public String getTitle()

Returns the title of the Chart

Returns:: String title of the Chart

setTitle

public void setTitle(String title)

Sets the title of the Chart

Parameters:: String - title - Chart title

getId

public int getId()

returns the ordinal id associated with the underlying Chart Object

Returns:: int chart id
See Also:: WorkBookHandle.getChartById

toString

public String toString()

returns the string representation of this ChartHandle

Overrides:: toString in class Object

getSeries

public String[] getSeries()

Returns an ordered array of strings representing all the series ranges in the Chart.
Each series can only represent one bar, line or wedge of data.

Returns:: String[] each item being a Cell Range representing one bar, line or wedge of data in the Chart
See Also:: ChartHandle.getCategories

getCategories

public String[] getCategories()

Returns an ordered array of strings representing all the category ranges in the chart.
This vector corresponds to the getSeries() method so will often contain duplicates, as while the series data changes frequently, category data is the same throughout the chart.

Returns:: String[] each item being a Cell Range representing the Category Data
See Also:: ChartHandle.getSeries

getAllChartSeriesHandles

public ChartSeriesHandle[] getAllChartSeriesHandles()

Returns an array of ChartSeriesHandle Objects, one for each bar, line or wedge of data.

Returns:: ChartSeriesHandle[] Array of ChartSeriesHandle Objects representing Chart Series Data (Series and Categories)
See Also:: ChartSeriesHandle

getAllChartSeriesHandles

public ChartSeriesHandle[] getAllChartSeriesHandles(int nChart)

Returns an array of ChartSeriesHandle Objects for the desired chart, one for each bar, line or wedge of data.
A chart number of 0 means the default chart, 1-9 indicate series for overlay charts
NOTE: using this method returns the series for the desired chart ONLY
You MUST use the corresponding removeSeries(index, nChart) when removing series to properly match the series index. Otherwise a mismatch will occur.

Parameters:: nChart - number and drawing order of the desired chart (default= 0 max=9 where 1-9 indicate an overlay chart)
Returns:: ChartSeriesHandle[] Array of ChartSeriesHandle Objects representing Chart Series Data (Series and Categories)
See Also:: ChartSeriesHandle

getChartSeriesHandle

public ChartSeriesHandle getChartSeriesHandle(String seriesRange)

Get the ChartSeriesHandle representing Chart Series Data (Series and Categories) for the specified Series range

Parameters:: String - seriesRange - For example, "Sheet1!A12:A21"
Returns:: ChartSeriesHandle
See Also:: ChartSeriesHandle

getChartSeriesHandle

public ChartSeriesHandle getChartSeriesHandle(int idx)

Get the ChartSeriesHandle representing Chart Series Data (Series and Categories) for the specified Series index

Parameters:: int - idx - the index (0 based) of the series
Returns:: ChartSeriesHandle
See Also:: ChartSeriesHandle

getChartSeriesHandleByName

public ChartSeriesHandle getChartSeriesHandleByName(String legend)

Get the ChartSeriesHandle representing Chart Series Data (Series and Categories) for the Series specified by label (legend)

Parameters:: String - legend - label for the desired series
Returns:: ChartSeriesHandle
See Also:: ChartSeriesHandle

getYAxisLabel

public String getYAxisLabel()

returns the Y axis Label

Returns:: String label

setYAxisLabel

public void setYAxisLabel(String yLabel)

Sets the Y axis label

Parameters:: String - yLabel - new Y Axis Label

getXAxisLabel

public String getXAxisLabel()

returns the X axis Label

Returns:: String label

setXAxisLabel

public void setXAxisLabel(String xLabel)

Sets the XAxisLabel

Parameters:: String - xLabel - new X Axis Label

getZAxisLabel

public String getZAxisLabel()

returns the Z axis Label, if any

Returns:: String label

setZAxisLabel

public void setZAxisLabel(String zLabel)

set the Z AxisLabel

Parameters:: String - zLabel - new Z Axis Label