Class HSSFChart

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

public final class HSSFChart extends Object
Has methods for construction of a chart object.
Author:
Glen Stampoultzis (glens at apache.org)
  • Method Details

    • createBarChart

      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.

    • getSheetCharts

      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
    • getChartX

      public int getChartX()
      Get the X offset of the chart
    • getChartY

      public int getChartY()
      Get the Y offset of the chart
    • getChartWidth

      public int getChartWidth()
      Get the width of the chart. ChartRecord
    • getChartHeight

      public int getChartHeight()
      Get the height of the chart. ChartRecord
    • setChartX

      public void setChartX(int x)
      Sets the X offset of the chart
    • setChartY

      public void setChartY(int y)
      Sets the Y offset of the chart
    • setChartWidth

      public void setChartWidth(int width)
      Sets the width of the chart. ChartRecord
    • setChartHeight

      public void setChartHeight(int height)
      Sets the height of the chart. ChartRecord
    • getSeries

      public HSSFChart.HSSFSeries[] getSeries()
      Returns the series of the chart
    • getChartTitle

      public String getChartTitle()
      Returns the chart's title, if there is one, or null if not
    • setChartTitle

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

      public void setValueRange(int axisIndex, Double minimum, Double maximum, Double majorUnit, Double minorUnit)
      Set value range (basic Axis Options)
      Parameters:
      axisIndex - 0 - primary axis, 1 - secondary axis
      minimum - minimum value; Double.NaN - automatic; null - no change
      maximum - maximum value; Double.NaN - automatic; null - no change
      majorUnit - major unit value; Double.NaN - automatic; null - no change
      minorUnit - minor unit value; Double.NaN - automatic; null - no change
    • createSeries

      public HSSFChart.HSSFSeries createSeries() throws Exception
      Throws:
      Exception
    • removeSeries

      public boolean removeSeries(HSSFChart.HSSFSeries remSeries)
    • getType

      public HSSFChart.HSSFChartType getType()