java.lang.Objectcom.aspose.words.Chart
public class Chart
Example:
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a chart shape with a document builder and get its chart.
Shape chartShape = builder.insertChart(ChartType.BAR, 400.0, 300.0);
Chart chart = chartShape.getChart();
// Use the "Title" property to give our chart a title, which appears at the top center of the chart area.
ChartTitle title = chart.getTitle();
title.setText("My Chart");
// Set the "Show" property to "true" to make the title visible.
title.setShow(true);
// Set the "Overlay" property to "true" Give other chart elements more room by allowing them to overlap the title
title.setOverlay(true);
doc.save(getArtifactsDir() + "Charts.ChartTitle.docx");
Property Getters/Setters Summary | ||
---|---|---|
ChartAxis | getAxisX() | |
Provides access to properties of the X axis of the chart. | ||
ChartAxis | getAxisY() | |
Provides access to properties of the Y axis of the chart. | ||
ChartAxis | getAxisZ() | |
Provides access to properties of the Z axis of the chart. | ||
ChartLegend | getLegend() | |
Provides access to the chart legend properties. | ||
ChartSeriesCollection | getSeries() | |
Provides access to series collection. | ||
java.lang.String | getSourceFullName() | |
Gets the path and name of an xls/xlsx file this chart is linked to. | ||
ChartTitle | getTitle() | |
Provides access to the chart title properties. |
Property Getters/Setters Detail |
---|
getAxisX | |
public ChartAxis getAxisX() |
Example:
Shows how to insert a chart and modify the appearance of its axes.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Shape shape = builder.insertChart(ChartType.COLUMN, 500.0, 300.0); Chart chart = shape.getChart(); // Clear the chart's demo data series to start with a clean chart. chart.getSeries().clear(); // Insert a chart series with categories for the X-axis and respective numeric values for the Y-axis. chart.getSeries().add("Aspose Test Series", new String[]{"Word", "PDF", "Excel", "GoogleDocs", "Note"}, new double[]{640.0, 320.0, 280.0, 120.0, 150.0}); // Chart axes have various options that can change their appearance, // such as their direction, major/minor unit ticks, and tick marks. ChartAxis xAxis = chart.getAxisX(); xAxis.setCategoryType(AxisCategoryType.CATEGORY); xAxis.setCrosses(AxisCrosses.MINIMUM); xAxis.setReverseOrder(false); xAxis.setMajorTickMark(AxisTickMark.INSIDE); xAxis.setMinorTickMark(AxisTickMark.CROSS); xAxis.setMajorUnit(10.0d); xAxis.setMinorUnit(15.0d); xAxis.setTickLabelOffset(50); xAxis.setTickLabelPosition(AxisTickLabelPosition.LOW); xAxis.setTickLabelSpacingIsAuto(false); xAxis.setTickMarkSpacing(1); ChartAxis yAxis = chart.getAxisY(); yAxis.setCategoryType(AxisCategoryType.AUTOMATIC); yAxis.setCrosses(AxisCrosses.MAXIMUM); yAxis.setReverseOrder(true); yAxis.setMajorTickMark(AxisTickMark.INSIDE); yAxis.setMinorTickMark(AxisTickMark.CROSS); yAxis.setMajorUnit(100.0d); yAxis.setMinorUnit(20.0d); yAxis.setTickLabelPosition(AxisTickLabelPosition.NEXT_TO_AXIS); // Column charts do not have a Z-axis. Assert.assertNull(chart.getAxisZ()); doc.save(getArtifactsDir() + "Charts.AxisProperties.docx");
getAxisY | |
public ChartAxis getAxisY() |
Example:
Shows how to insert a chart and modify the appearance of its axes.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Shape shape = builder.insertChart(ChartType.COLUMN, 500.0, 300.0); Chart chart = shape.getChart(); // Clear the chart's demo data series to start with a clean chart. chart.getSeries().clear(); // Insert a chart series with categories for the X-axis and respective numeric values for the Y-axis. chart.getSeries().add("Aspose Test Series", new String[]{"Word", "PDF", "Excel", "GoogleDocs", "Note"}, new double[]{640.0, 320.0, 280.0, 120.0, 150.0}); // Chart axes have various options that can change their appearance, // such as their direction, major/minor unit ticks, and tick marks. ChartAxis xAxis = chart.getAxisX(); xAxis.setCategoryType(AxisCategoryType.CATEGORY); xAxis.setCrosses(AxisCrosses.MINIMUM); xAxis.setReverseOrder(false); xAxis.setMajorTickMark(AxisTickMark.INSIDE); xAxis.setMinorTickMark(AxisTickMark.CROSS); xAxis.setMajorUnit(10.0d); xAxis.setMinorUnit(15.0d); xAxis.setTickLabelOffset(50); xAxis.setTickLabelPosition(AxisTickLabelPosition.LOW); xAxis.setTickLabelSpacingIsAuto(false); xAxis.setTickMarkSpacing(1); ChartAxis yAxis = chart.getAxisY(); yAxis.setCategoryType(AxisCategoryType.AUTOMATIC); yAxis.setCrosses(AxisCrosses.MAXIMUM); yAxis.setReverseOrder(true); yAxis.setMajorTickMark(AxisTickMark.INSIDE); yAxis.setMinorTickMark(AxisTickMark.CROSS); yAxis.setMajorUnit(100.0d); yAxis.setMinorUnit(20.0d); yAxis.setTickLabelPosition(AxisTickLabelPosition.NEXT_TO_AXIS); // Column charts do not have a Z-axis. Assert.assertNull(chart.getAxisZ()); doc.save(getArtifactsDir() + "Charts.AxisProperties.docx");
getAxisZ | |
public ChartAxis getAxisZ() |
Example:
Shows how to insert a chart and modify the appearance of its axes.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Shape shape = builder.insertChart(ChartType.COLUMN, 500.0, 300.0); Chart chart = shape.getChart(); // Clear the chart's demo data series to start with a clean chart. chart.getSeries().clear(); // Insert a chart series with categories for the X-axis and respective numeric values for the Y-axis. chart.getSeries().add("Aspose Test Series", new String[]{"Word", "PDF", "Excel", "GoogleDocs", "Note"}, new double[]{640.0, 320.0, 280.0, 120.0, 150.0}); // Chart axes have various options that can change their appearance, // such as their direction, major/minor unit ticks, and tick marks. ChartAxis xAxis = chart.getAxisX(); xAxis.setCategoryType(AxisCategoryType.CATEGORY); xAxis.setCrosses(AxisCrosses.MINIMUM); xAxis.setReverseOrder(false); xAxis.setMajorTickMark(AxisTickMark.INSIDE); xAxis.setMinorTickMark(AxisTickMark.CROSS); xAxis.setMajorUnit(10.0d); xAxis.setMinorUnit(15.0d); xAxis.setTickLabelOffset(50); xAxis.setTickLabelPosition(AxisTickLabelPosition.LOW); xAxis.setTickLabelSpacingIsAuto(false); xAxis.setTickMarkSpacing(1); ChartAxis yAxis = chart.getAxisY(); yAxis.setCategoryType(AxisCategoryType.AUTOMATIC); yAxis.setCrosses(AxisCrosses.MAXIMUM); yAxis.setReverseOrder(true); yAxis.setMajorTickMark(AxisTickMark.INSIDE); yAxis.setMinorTickMark(AxisTickMark.CROSS); yAxis.setMajorUnit(100.0d); yAxis.setMinorUnit(20.0d); yAxis.setTickLabelPosition(AxisTickLabelPosition.NEXT_TO_AXIS); // Column charts do not have a Z-axis. Assert.assertNull(chart.getAxisZ()); doc.save(getArtifactsDir() + "Charts.AxisProperties.docx");
getLegend | |
public ChartLegend getLegend() |
Example:
Shows how to edit the appearance of a chart's legend.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Shape shape = builder.insertChart(ChartType.LINE, 450.0, 300.0); Chart chart = shape.getChart(); Assert.assertEquals(3, chart.getSeries().getCount()); Assert.assertEquals("Series 1", chart.getSeries().get(0).getName()); Assert.assertEquals("Series 2", chart.getSeries().get(1).getName()); Assert.assertEquals("Series 3", chart.getSeries().get(2).getName()); // Move the chart's legend to the top right corner. ChartLegend legend = chart.getLegend(); legend.setPosition(LegendPosition.TOP_RIGHT); // Give other chart elements, such as the graph, more room by allowing them to overlap the legend. legend.setOverlay(true); doc.save(getArtifactsDir() + "Charts.ChartLegend.docx");
getSeries | |
public ChartSeriesCollection getSeries() |
Example:
Shows how to create an appropriate type of chart series for a graph type.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // There are several ways of populating a chart's series collection. // Different series schemas are intended for different chart types. // 1 - Column chart with columns grouped and banded along the X-axis by category: Chart chart = appendChart(builder, ChartType.COLUMN, 500.0, 300.0); String[] categories = {"Category 1", "Category 2", "Category 3"}; // Insert two series of decimal values containing a value for each respective category. // This column chart will have three groups, each with two columns. chart.getSeries().add("Series 1", categories, new double[]{76.6, 82.1, 91.6}); chart.getSeries().add("Series 2", categories, new double[]{64.2, 79.5, 94.0}); // Categories are distributed along the X-axis, and values are distributed along the Y-axis. Assert.assertEquals(ChartAxisType.CATEGORY, chart.getAxisX().getType()); Assert.assertEquals(ChartAxisType.VALUE, chart.getAxisY().getType()); // 2 - Area chart with dates distributed along the X-axis: chart = appendChart(builder, ChartType.AREA, 500.0, 300.0); Date[] dates = {DocumentHelper.createDate(2014, 3, 31), DocumentHelper.createDate(2017, 1, 23), DocumentHelper.createDate(2017, 6, 18), DocumentHelper.createDate(2019, 11, 22), DocumentHelper.createDate(2020, 9, 7) }; // Insert a series with a decimal value for each respective date. // The dates will be distributed along a linear X-axis, // and the values added to this series will create data points. chart.getSeries().add("Series 1", dates, new double[]{15.8, 21.5, 22.9, 28.7, 33.1}); Assert.assertEquals(ChartAxisType.CATEGORY, chart.getAxisX().getType()); Assert.assertEquals(ChartAxisType.VALUE, chart.getAxisY().getType()); // 3 - 2D scatter plot: chart = appendChart(builder, ChartType.SCATTER, 500.0, 300.0); // Each series will need two decimal arrays of equal length. // The first array contains X-values, and the second contains corresponding Y-values // of data points on the chart's graph. chart.getSeries().add("Series 1", new double[]{3.1, 3.5, 6.3, 4.1, 2.2, 8.3, 1.2, 3.6}, new double[]{3.1, 6.3, 4.6, 0.9, 8.5, 4.2, 2.3, 9.9}); chart.getSeries().add("Series 2", new double[]{2.6, 7.3, 4.5, 6.6, 2.1, 9.3, 0.7, 3.3}, new double[]{7.1, 6.6, 3.5, 7.8, 7.7, 9.5, 1.3, 4.6}); Assert.assertEquals(ChartAxisType.VALUE, chart.getAxisX().getType()); Assert.assertEquals(ChartAxisType.VALUE, chart.getAxisY().getType()); // 4 - Bubble chart: chart = appendChart(builder, ChartType.BUBBLE, 500.0, 300.0); // Each series will need three decimal arrays of equal length. // The first array contains X-values, the second contains corresponding Y-values, // and the third contains diameters for each of the graph's data points. chart.getSeries().add("Series 1", new double[]{1.1, 5.0, 9.8}, new double[]{1.2, 4.9, 9.9}, new double[]{2.0, 4.0, 8.0}); doc.save(getArtifactsDir() + "Charts.ChartSeriesCollection.docx"); } /// <summary> /// Insert a chart using a document builder of a specified ChartType, width and height, and remove its demo data. /// </summary> private static Chart appendChart(DocumentBuilder builder, /*ChartType*/int chartType, double width, double height) throws Exception { Shape chartShape = builder.insertChart(chartType, width, height); Chart chart = chartShape.getChart(); chart.getSeries().clear(); return chart; }
getSourceFullName | |
public java.lang.String getSourceFullName() |
getTitle | |
public ChartTitle getTitle() |
Example:
Shows how to insert a chart and set a title.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a chart shape with a document builder and get its chart. Shape chartShape = builder.insertChart(ChartType.BAR, 400.0, 300.0); Chart chart = chartShape.getChart(); // Use the "Title" property to give our chart a title, which appears at the top center of the chart area. ChartTitle title = chart.getTitle(); title.setText("My Chart"); // Set the "Show" property to "true" to make the title visible. title.setShow(true); // Set the "Overlay" property to "true" Give other chart elements more room by allowing them to overlap the title title.setOverlay(true); doc.save(getArtifactsDir() + "Charts.ChartTitle.docx");