Creating and Adding a Chart to a Spreadsheet

From Apache OpenOffice Wiki
< Documentation‎ | DevGuide
Revision as of 12:21, 15 May 2009 by OOoWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search



Charts are used in spreadsheet documents to visualize the data that they contain. A spreadsheet is one single sheet in a spreadsheet document and offers a com.sun.star.table.XTableChartsSupplier interface, that is required by the service com.sun.star.sheet.Spreadsheet. With this interface, a collection of table charts that are a container for the actual charts can be accessed. To retrieve the chart document model from a table chart object, use the method getEmbeddedObject().

The following example shows how to insert a chart into a spreadsheet document and retrieve its chart document model. The example assumes that there is a com.sun.star.sheet.XSpreadsheet to insert the chart and an array of cell range addresses that contain the regions in which the data for the chart can be found. Refer to Spreadsheet Documents for more information about how to get or create these objects. The following snippet shows how to insert a chart into a Calc document.

  import com.sun.star.chart.*;
  import com.sun.star.uno.UnoRuntime;
  import com.sun.star.container.XNameAccess;
  import com.sun.star.document.XEmbeddedObjectSupplier;
 
  final String sChartName = "MyChart";
 
  com.sun.star.table.XTableChartsSupplier aSheet;
  com.sun.star.table.CellRangeAddress[] aAddresses;
 
  // get the sheet in which you want to insert a chart
  // and query it for XTableChartsSupplier and store it in aSheet
  //
  // also get an array of CellRangeAddresses containing
  // the data you want to visualize and store them in aAddresses
  //
  // for details see documentation of Spreadsheets
 
  // ...
 
  XChartDocument aChartDocument = null;
 
  com.sun.star.table.XTableCharts aChartCollection = aSheet.getCharts();
  XNameAccess aChartCollectionNA = (XNameAccess) UnoRuntime.queryInterface(
      XNameAccess.class, aChartCollection );
 
  // only insert the chart if it does not already exist
  if (aChartCollectionNA != null && !aChartCollectionNA.hasByName(sChartName)) {
      // following rectangle parameters are measured in 1/100 mm
      com.sun.star.awt.Rectangle aRect = new com.sun.star.awt.Rectangle(1000, 1000, 15000, 9271);
 
      // first bool: ColumnHeaders
      // second bool: RowHeaders
      aChartCollection.addNewByName(sChartName, aRect, aAddresses, true, false);
 
      try {
          com.sun.star.table.XTableChart aTableChart = (com.sun.star.table.XTableChart)
              UnoRuntime.queryInterface(
                  com.sun.star.table.XTableChart.class,
                  aChartCollectionNA.getByName(sChartName));
 
          // the table chart is an embedded object which contains the chart document
          aChartDocument = (XChartDocument) UnoRuntime.queryInterface(
              XChartDocument.class,
              ((XEmbeddedObjectSupplier) UnoRuntime.queryInterface(
                  XEmbeddedObjectSupplier.class,
                  aTableChart )).getEmbeddedObject());
 
      } catch (com.sun.star.container.NoSuchElementException ex) {
          System.out.println("Couldn't find chart with name " + sChartName + ": " + ex); 
      }
  }
 
  // now aChartDocument should contain an XChartDocument representing the newly inserted chart
Content on this page is licensed under the Public Documentation License (PDL).
Personal tools
In other languages