Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	HSSFChart.HSSFChartType
public static class	HSSFChart.HSSFSeries A series in a chart

Field Summary

Modifier and Type	Field and Description
private ChartRecord	chartRecord
private ChartTitleFormatRecord	chartTitleFormat
private SeriesTextRecord	chartTitleText
private LegendRecord	legendRecord
private List<HSSFChart.HSSFSeries>	series
private HSSFSheet	sheet
private HSSFChart.HSSFChartType	type
private List<ValueRangeRecord>	valueRanges

Constructor Summary

Access	Constructor and Description
private	HSSFChart(HSSFSheet sheet, ChartRecord chartRecord)

Method Summary

Modifier and Type	Method and Description
private TextRecord	createAllTextRecord()
private AreaFormatRecord	createAreaFormatRecord1()
private AreaFormatRecord	createAreaFormatRecord2()
private AxisLineFormatRecord	createAxisLineFormatRecord(short format)
private AxisOptionsRecord	createAxisOptionsRecord()
private AxisParentRecord	createAxisParentRecord()
private AxisRecord	createAxisRecord(short axisType)
private void	createAxisRecords(List<Record> records)
private AxisUsedRecord	createAxisUsedRecord(short numAxis)
public void	createBarChart(HSSFWorkbook workbook, HSSFSheet parentSheet) Creates a bar chart.
private BarRecord	createBarRecord()
private BeginRecord	createBeginRecord()
private BOFRecord	createBOFRecord()
private LinkedDataRecord	createCategoriesLinkedDataRecord()
private CategorySeriesAxisRecord	createCategorySeriesAxisRecord()
private ChartFormatRecord	createChartFormatRecord()
private ChartRecord	createChartRecord(int x, int y, int width, int height)
private DataFormatRecord	createDataFormatRecord()
private DefaultDataLabelTextPropertiesRecord	createDefaultTextRecord(short categoryDataType)
private DimensionsRecord	createDimensionsRecord()
private LinkedDataRecord	createDirectLinkRecord()
private EndRecord	createEndRecord()
private FontBasisRecord	createFontBasisRecord1()
private FontBasisRecord	createFontBasisRecord2()
private FontIndexRecord	createFontIndexRecord(int index)
private FrameRecord	createFrameRecord1()
private FrameRecord	createFrameRecord2()
private HCenterRecord	createHCenterRecord()
private LegendRecord	createLegendRecord()
private LineFormatRecord	createLineFormatRecord(boolean drawTicks)
private LineFormatRecord	createLineFormatRecord2()
private LinkedDataRecord	createLinkedDataRecord()
private UnknownRecord	createMSDrawingObjectRecord()
private UnknownRecord	createOBJRecord()
private PlotAreaRecord	createPlotAreaRecord()
private PlotGrowthRecord	createPlotGrowthRecord(int horizScale, int vertScale)
private PrintSetupRecord	createPrintSetupRecord()
private SCLRecord	createSCLRecord(short numerator, short denominator)
public HSSFChart.HSSFSeries	createSeries()
private SeriesIndexRecord	createSeriesIndexRecord(int index)
private SeriesRecord	createSeriesRecord()
private SeriesChartGroupIndexRecord	createSeriesToChartGroupRecord()
private SheetPropertiesRecord	createSheetPropsRecord()
private TextRecord	createTextRecord()
private TickRecord	createTickRecord1()
private TickRecord	createTickRecord2()
private LinkedDataRecord	createTitleLinkedDataRecord()
private UnitsRecord	createUnitsRecord()
private TextRecord	createUnknownTextRecord()
private ValueRangeRecord	createValueRangeRecord()
private LinkedDataRecord	createValuesLinkedDataRecord()
private VCenterRecord	createVCenterRecord()
public int	getChartHeight() Get the height of the chart.
public String	getChartTitle() Returns the chart's title, if there is one, or null if not
public int	getChartWidth() Get the width of the chart.
public int	getChartX() Get the X offset of the chart
public int	getChartY() Get the Y offset of the chart
public HSSFChart.HSSFSeries[]	getSeries() Returns the series of the chart
public static HSSFChart[]	getSheetCharts(HSSFSheet sheet) Returns all the charts for the given sheet.
public HSSFChart.HSSFChartType	getType()
public boolean	removeSeries(HSSFChart.HSSFSeries remSeries)
public void	setChartHeight(int height) Sets the height of the chart.
public void	setChartTitle(String title) Changes the chart's title, but only if there was one already.
public void	setChartWidth(int width) Sets the width of the chart.
public void	setChartX(int x) Sets the X offset of the chart
public void	setChartY(int y) Sets the Y offset of the chart
public void	setValueRange(int 0 - primary axis, 1 - secondary axis axisIndex, Double minimum value; Double.NaN - automatic; null - no change minimum, Double maximum value; Double.NaN - automatic; null - no change maximum, Double major unit value; Double.NaN - automatic; null - no change majorUnit, Double minor unit value; Double.NaN - automatic; null - no change minorUnit) Set value range (basic Axis Options)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

chartRecord	back to summary
private ChartRecord chartRecord

chartTitleFormat	back to summary
private ChartTitleFormatRecord chartTitleFormat Annotations @SuppressWarnings:unused

chartTitleText	back to summary
private SeriesTextRecord chartTitleText

legendRecord	back to summary
private LegendRecord legendRecord

series	back to summary
private List<HSSFChart.HSSFSeries> series

sheet	back to summary
private HSSFSheet sheet

type	back to summary
private HSSFChart.HSSFChartType type

valueRanges	back to summary
private List<ValueRangeRecord> valueRanges

Constructor Detail

HSSFChart	back to summary
private HSSFChart(HSSFSheet sheet, ChartRecord chartRecord)

Method Detail

createAllTextRecord	back to summary
private TextRecord createAllTextRecord()

createAreaFormatRecord1	back to summary
private AreaFormatRecord createAreaFormatRecord1()

createAreaFormatRecord2	back to summary
private AreaFormatRecord createAreaFormatRecord2()

createAxisLineFormatRecord	back to summary
private AxisLineFormatRecord createAxisLineFormatRecord(short format)

createAxisOptionsRecord	back to summary
private AxisOptionsRecord createAxisOptionsRecord()

createAxisParentRecord	back to summary
private AxisParentRecord createAxisParentRecord()

createAxisRecord	back to summary
private AxisRecord createAxisRecord(short axisType)

createAxisRecords	back to summary
private void createAxisRecords(List<Record> records)

createAxisUsedRecord	back to summary
private AxisUsedRecord createAxisUsedRecord(short numAxis)

createBarChart	back to summary
public void createBarChart(HSSFWorkbook workbook, HSSFSheet parentSheet) Creates a bar chart. API needs some work. :) Note Does not yet work... checking it in just so others can take a look.

createBarRecord	back to summary
private BarRecord createBarRecord()

createBeginRecord	back to summary
private BeginRecord createBeginRecord()

createBOFRecord	back to summary
private BOFRecord createBOFRecord()

createCategoriesLinkedDataRecord	back to summary
private LinkedDataRecord createCategoriesLinkedDataRecord()

createCategorySeriesAxisRecord	back to summary
private CategorySeriesAxisRecord createCategorySeriesAxisRecord()

createChartFormatRecord	back to summary
private ChartFormatRecord createChartFormatRecord()

createChartRecord	back to summary
private ChartRecord createChartRecord(int x, int y, int width, int height)

createDataFormatRecord	back to summary
private DataFormatRecord createDataFormatRecord()

createDefaultTextRecord	back to summary
private DefaultDataLabelTextPropertiesRecord createDefaultTextRecord(short categoryDataType)

createDimensionsRecord	back to summary
private DimensionsRecord createDimensionsRecord()

createDirectLinkRecord	back to summary
private LinkedDataRecord createDirectLinkRecord()

createEndRecord	back to summary
private EndRecord createEndRecord()

createFontBasisRecord1	back to summary
private FontBasisRecord createFontBasisRecord1()

createFontBasisRecord2	back to summary
private FontBasisRecord createFontBasisRecord2()

createFontIndexRecord	back to summary
private FontIndexRecord createFontIndexRecord(int index)

createFrameRecord1	back to summary
private FrameRecord createFrameRecord1()

createFrameRecord2	back to summary
private FrameRecord createFrameRecord2()

createHCenterRecord	back to summary
private HCenterRecord createHCenterRecord()

createLegendRecord	back to summary
private LegendRecord createLegendRecord()

createLineFormatRecord	back to summary
private LineFormatRecord createLineFormatRecord(boolean drawTicks)

createLineFormatRecord2	back to summary
private LineFormatRecord createLineFormatRecord2()

createLinkedDataRecord	back to summary
private LinkedDataRecord createLinkedDataRecord()

createMSDrawingObjectRecord	back to summary
private UnknownRecord createMSDrawingObjectRecord()

createOBJRecord	back to summary
private UnknownRecord createOBJRecord()

createPlotAreaRecord	back to summary
private PlotAreaRecord createPlotAreaRecord()

createPlotGrowthRecord	back to summary
private PlotGrowthRecord createPlotGrowthRecord(int horizScale, int vertScale)

createPrintSetupRecord	back to summary
private PrintSetupRecord createPrintSetupRecord()

createSCLRecord	back to summary
private SCLRecord createSCLRecord(short numerator, short denominator)

createSeries	back to summary
public HSSFChart.HSSFSeries createSeries() throws Exception

createSeriesIndexRecord	back to summary
private SeriesIndexRecord createSeriesIndexRecord(int index)

createSeriesRecord	back to summary
private SeriesRecord createSeriesRecord()

createSeriesToChartGroupRecord	back to summary
private SeriesChartGroupIndexRecord createSeriesToChartGroupRecord()

createSheetPropsRecord	back to summary
private SheetPropertiesRecord createSheetPropsRecord()

createTextRecord	back to summary
private TextRecord createTextRecord()

createTickRecord1	back to summary
private TickRecord createTickRecord1()

createTickRecord2	back to summary
private TickRecord createTickRecord2()

createTitleLinkedDataRecord	back to summary
private LinkedDataRecord createTitleLinkedDataRecord()

createUnitsRecord	back to summary
private UnitsRecord createUnitsRecord()

createUnknownTextRecord	back to summary
private TextRecord createUnknownTextRecord()

createValueRangeRecord	back to summary
private ValueRangeRecord createValueRangeRecord()

createValuesLinkedDataRecord	back to summary
private LinkedDataRecord createValuesLinkedDataRecord()

createVCenterRecord	back to summary
private VCenterRecord createVCenterRecord()

getChartHeight	back to summary
public int getChartHeight() Get the height of the chart. `ChartRecord`

getChartTitle	back to summary
public String getChartTitle() Returns the chart's title, if there is one, or null if not

getChartWidth	back to summary
public int getChartWidth() Get the width of the chart. `ChartRecord`

getChartX	back to summary
public int getChartX() Get the X offset of the chart

getChartY	back to summary
public int getChartY() Get the Y offset of the chart

getSeries	back to summary
public HSSFChart.HSSFSeries[] getSeries() Returns the series of the chart

getSheetCharts	back to summary
public static HSSFChart[] getSheetCharts(HSSFSheet sheet) Returns all the charts for the given sheet. Note You won't be able to do very much with these charts yet, as this is very limited support

getType	back to summary
public HSSFChart.HSSFChartType getType()

removeSeries	back to summary
public boolean removeSeries(HSSFChart.HSSFSeries remSeries)

setChartHeight	back to summary
public void setChartHeight(int height) Sets the height of the chart. `ChartRecord`

setChartTitle	back to summary
public void setChartTitle(String title) Changes the chart's title, but only if there was one already. TODO - add in the records if not

setChartWidth	back to summary
public void setChartWidth(int width) Sets the width of the chart. `ChartRecord`

setChartX	back to summary
public void setChartX(int x) Sets the X offset of the chart

setChartY	back to summary
public void setChartY(int y) Sets the Y offset of the chart

setValueRange

back to summary

public void setValueRange(int axisIndex, Double minimum, Double maximum, Double majorUnit, Double minorUnit)

Set value range (basic Axis Options)

Parameters

axisIndex:int: 0 - primary axis, 1 - secondary axis
minimum:Double: minimum value; Double.NaN - automatic; null - no change
maximum:Double: maximum value; Double.NaN - automatic; null - no change
majorUnit:Double: major unit value; Double.NaN - automatic; null - no change
minorUnit:Double: minor unit value; Double.NaN - automatic; null - no change

org.apache.poi.hssf.usermodel back to summary

public sealed Enum HSSFChart.HSSFChartType

Class Inheritance

extends Enum<HSSFChart.HSSFChartType>

java.lang.Object
java.lang.Enum
org.apache.poi.hssf.usermodel.HSSFChart.HSSFChartType

Field Summary

Modifier and Type	Field and Description
public static final HSSFChart.HSSFChartType	Area
public static final HSSFChart.HSSFChartType	Bar
public static final HSSFChart.HSSFChartType	Line
public static final HSSFChart.HSSFChartType	Pie
public static final HSSFChart.HSSFChartType	Scatter
public static final HSSFChart.HSSFChartType	Unknown

Constructor Summary

Access	Constructor and Description
private	HSSFChartType()

Method Summary

Modifier and Type	Method and Description
public abstract short	getSid()
public static HSSFChart.HSSFChartType	valueOf(String name)
public static HSSFChart.HSSFChartType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

Area	back to summary
public static final HSSFChart.HSSFChartType Area

Bar	back to summary
public static final HSSFChart.HSSFChartType Bar

Line	back to summary
public static final HSSFChart.HSSFChartType Line

Pie	back to summary
public static final HSSFChart.HSSFChartType Pie

Scatter	back to summary
public static final HSSFChart.HSSFChartType Scatter

Unknown	back to summary
public static final HSSFChart.HSSFChartType Unknown

Constructor Detail

HSSFChartType	back to summary
private HSSFChartType()

Method Detail

getSid	back to summary
public abstract short getSid()

valueOf	back to summary
public static HSSFChart.HSSFChartType valueOf(String name)

values	back to summary
public static HSSFChart.HSSFChartType[] values()

org.apache.poi.hssf.usermodel back to summary

public Class HSSFChart.HSSFSeries

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.hssf.usermodel.HSSFChart.HSSFSeries

A series in a chart

Field Summary

Modifier and Type	Field and Description
private LinkedDataRecord	dataCategoryLabels
private LinkedDataRecord	dataName
private LinkedDataRecord	dataSecondaryCategoryLabels
private LinkedDataRecord	dataValues
private SeriesRecord	series
private SeriesTextRecord	seriesTitleText

Constructor Summary

Access	Constructor and Description
pack-priv	HSSFSeries(SeriesRecord series)

Method Summary

Modifier and Type	Method and Description
public CellRangeAddressBase	getCategoryLabelsCellRange()
private CellRangeAddressBase	getCellRange(LinkedDataRecord linkedDataRecord)
public LinkedDataRecord	Returns: record with data category labels getDataCategoryLabels()
public LinkedDataRecord	Returns: record with data names getDataName()
public LinkedDataRecord	Returns: record with data secondary category labels getDataSecondaryCategoryLabels()
public LinkedDataRecord	Returns: record with data values getDataValues()
public short	getNumValues()
public SeriesRecord	Returns: record with series getSeries()
public String	getSeriesTitle() Returns the series' title, if there is one, or null if not
public CellRangeAddressBase	getValuesCellRange()
public short	getValueType() See `SeriesRecord`
pack-priv void	insertData(LinkedDataRecord data)
public void	setCategoryLabelsCellRange(CellRangeAddressBase range)
public void	setSeriesTitle(String title) Changes the series' title, but only if there was one already.
pack-priv void	setSeriesTitleText(SeriesTextRecord seriesTitleText)
public void	setValuesCellRange(CellRangeAddressBase range)
private Integer	setVerticalCellRange(LinkedDataRecord linkedDataRecord, CellRangeAddressBase range)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dataCategoryLabels	back to summary
private LinkedDataRecord dataCategoryLabels

dataName	back to summary
private LinkedDataRecord dataName

dataSecondaryCategoryLabels	back to summary
private LinkedDataRecord dataSecondaryCategoryLabels

dataValues	back to summary
private LinkedDataRecord dataValues

series	back to summary
private SeriesRecord series

seriesTitleText	back to summary
private SeriesTextRecord seriesTitleText

Constructor Detail

HSSFSeries	back to summary
pack-priv HSSFSeries(SeriesRecord series)

Method Detail

getCategoryLabelsCellRange	back to summary
public CellRangeAddressBase getCategoryLabelsCellRange()

getCellRange	back to summary
private CellRangeAddressBase getCellRange(LinkedDataRecord linkedDataRecord)

getDataCategoryLabels	back to summary
public LinkedDataRecord getDataCategoryLabels() Returns:LinkedDataRecord record with data category labels

getDataName	back to summary
public LinkedDataRecord getDataName() Returns:LinkedDataRecord record with data names

getDataSecondaryCategoryLabels	back to summary
public LinkedDataRecord getDataSecondaryCategoryLabels() Returns:LinkedDataRecord record with data secondary category labels

getDataValues	back to summary
public LinkedDataRecord getDataValues() Returns:LinkedDataRecord record with data values

getNumValues	back to summary
public short getNumValues()

getSeries	back to summary
public SeriesRecord getSeries() Returns:SeriesRecord record with series

getSeriesTitle	back to summary
public String getSeriesTitle() Returns the series' title, if there is one, or null if not

getValuesCellRange	back to summary
public CellRangeAddressBase getValuesCellRange()

getValueType	back to summary
public short getValueType() See `SeriesRecord`

insertData	back to summary
pack-priv void insertData(LinkedDataRecord data)

setCategoryLabelsCellRange	back to summary
public void setCategoryLabelsCellRange(CellRangeAddressBase range)

setSeriesTitle	back to summary
public void setSeriesTitle(String title) Changes the series' title, but only if there was one already. TODO - add in the records if not

setSeriesTitleText	back to summary
pack-priv void setSeriesTitleText(SeriesTextRecord seriesTitleText)

setValuesCellRange	back to summary
public void setValuesCellRange(CellRangeAddressBase range)

setVerticalCellRange	back to summary
private Integer setVerticalCellRange(LinkedDataRecord linkedDataRecord, CellRangeAddressBase range)

public final Class HSSFChart

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public sealed Enum HSSFChart.HSSFChartType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class HSSFChart.HSSFSeries

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail