addChart

2D
- Bar (clustered, stacked and 100% stacked).
- Column (clustered, stacked and 100% stacked).
- Pie (simple, exploded, pie of pie and bar of pie).
- Doughnut.
- Line.
- Area.
- Surface.
- Radar.
- XY(scatter).
- Bubble.
3D
- Bar: box (default), cylinder, cone, and pyramid (clustered, stacked and 100% stacked).
- Column: box (default), cylinder, cone, and pyramid (clustered, stacked and 100% stacked).
- Pie (simple and exploded).
- Surface.
- Line.

This method also allows adding combo charts, trendlines, grids, labels and many other chart features.

Parameters

options

Key	Type	Description
dataLegends	ArrayList<String>	Legend values.
dataNames	ArrayList<String>	Name values.
dataValues	ArrayList<ArrayList<Double>>	Data values.
type	String	The possible values are: barChart bar3DChart bar3DChartCylinder bar3DChartCone bar3DChartPyramid colChart col3DChart col3DChartCylinder col3DChartCone bar3DChartPyramid pieChart pie3DChart ofPieChart (pie of pie and bar of pie charts) lineChart line3DChart areaChart area3DChart radarChart scatterChart bubbleChart doughnutChart surfaceChart
title	String	The chart title (if any).
border	Integer	Border width in points.
chartAlign	String	Chart alignment: left (default), right or center.
color	String	Word color scheme for charts: 1: greyscale. 2: default Word color scheme for charts. 3: blue scheme. For the remaining color schemes (up to 48) check the Word interface.
comboChart	String	Chart to add a as combo chart. Use with the returnChart option. Global styles and properties are shared with the base chart. For bar, col, line, area, and radar charts.
floatChart	String	Floating chart: left, right or center. It only applies if textWrap is not inline (default value).
font	String	The font to be used. Arial, Calibri...
returnChart	Boolean	False as default, if true return the XML of the chart. To be used with the comboChart option.
sizeX	Integer	The chart width in centimeters (default value aprox 8.5 cm).
sizeY	Integer	The chart height in centimeters (default value aprox 6.0 cm).
textWrap	Integer	The way text shoud wrap the chart. Possible values are (check in the Word interface for the graphical explanation of the different terms): 0 (inline) 1 (square) 2 (front) 3 (back) 4 (up and bottom)
trendline	ArrayList<HashMap<String, String>>	Adds trendlines. Compatible with line, bar, col and area 2D charts. Possible keys and values are: color => (string) 0000ff. display_equation => (bool) display equation on chart. display_rSquared => (bool) display R-squared value on chart. intercept => (float) set intercept. line_style => (string) solid, dot, dash, lgDash, dashDot, lgDashDot, lgDashDotDot, sysDash, sysDot, sysDashDot, sysDashDotDot. type => (string) exp, linear, log, poly, power, movingAvg. type_order => (int) for poly and movingAvg types.

Chart display properties

Key	Type	Description
formatCode	String	Number format.
formatDataLabels	HashMap<String, String>	Possible keys and values are: rotation position
haxLabel	String	Label for the horizontal axis.
haxLabelDisplay	String	How to display the label of the horizontal axis. Possible values are: vertical, horizontal, rotated.
hgrid	Integer	Horizontal grid. Possible values are: 0 (no grid) 1 (only major grid lines - default) 2 (only minor grid lines) 3 (both major and minor grid lines)
horizontalOffset	Integer	Given in emus (1cm = 360000 emus).
majorUnit	String	Major unit value for bar, col, line, area, radar and scatter charts.
minorUnit	String	Minor unit value for bar, col, line, area, radar and scatter charts.
scalingMax	Double	Scaling max value for bar, col, line, area, radar and scatter charts.
scalingMin	Double	Scaling max value for bar, col, line, area, radar and scatter charts.
stylesTitle	HashMap<String, String>	Possible keys and values are: bold color font fontSize italic
vaxLabel	String	Label for the vertical axis.
vaxLabelDisplay	String	How to display the label of the horizontal axis. Possible values are: vertical, horizontal, rotated.
verticalOffset	Integer	Given in emus (1cm = 360000 emus).
vgrid	Integer	Vertical grid. Possible values are: 0 (no grid) 1 (only major grid lines - default) 2 (only minor grid lines) 3 (both major and minor grid lines)

The available parameters to display legends and data include:

Key	Type	Description
legendOverlay	Boolean	If true the legend may overlay the chart. This option may hinder the legibility of tha data so it is only recommended if it is crucial to "save space".
legendPos	String	The possible values are: b (bottom) l (left) r (right) t (top) none
showCategory	Boolean	If true shows the categories inside the chart.
showLegendKey	Boolean	If true shows the legend values.
showPercent	Boolean	If true shows the percentage values.
showSeries	Boolean	If true shows the series values.
showTable	Boolean	If true shows the chart data in an associated table.
showValue	Boolean	If true shows the chart data values.

Further configuration options for specific chart types are:

Key	Type	Description
Bar and column charts
gapWidth	Integer	Distance between the two charts.
groupBar	String	Different ways to group the data. Possible values are: clustered, stacked, percentStacked and standard.
overlap	String	Overlap.
tickLblPos	String	Tick label position.
Pie and doughnut charts
explosion	Integer	Distance among different sectors.
holeSize	Integer	Size of the inner hole (only doughnut charts).
ofPieCharts: pie of pie and bar of pie charts
custSplit	ArrayList<Integer>	Custom split.
gapWidth	Integer	Distance between the two charts.
secondPieSize	Integer	Percentage size of the auxiliary chart.
splitType	String	How to split the two charts. Possible values are: auto (default split type) cust (custom Split) percent (split by percentage) pos (split by position) val (split by value)
splitPos	Double	Determines the threshold value to split the charts.
subtype	String	Defines if the auxiliary chart is a pie or bar chart. Possible values are pie or bar.
Line and scatter (XY) charts
smooth	Boolean	If true it smooths the line (only scatter charts).
symbol	String	The possible symbol values are: Line charts: none, dot, plus, square, star, triangle, x, diamond, circle and dash. Scatter charts: dot and line.
symbolSize	Integer	The size of the symbol used.
Radar charts
style	String	Defines the radar chart style. Possible values are: radar (lines without dots) marker (lines with dots) filled (filled enclosed area)
Surface charts
wireframe	Boolean	If true the surface is shown as a wireframe.

Additional available options for 3D charts:

Key	Type	Description
perspective	Integer	Perspective angle. Angles beyond 25 degrees provoke a big distortion in the 3D chart representation.
rotX	Integer	Rotation angle respect the vertical axis. Standard values are between 10 and 20 degrees.
rotY	Integer	Rotation angle respect the horizontal axis. Standard values are between 10 and 20 degrees.

Return values

String. To be used as combo chart.

Code samples

Example #1

package examples.Core.addChart;

import java.util.ArrayList;

import com.javadocx.CreateDocx;
import com.javadocx.elements.*;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();

        docx.addText("We will now add a 3D pie chart to the Word document:");

        ArrayList<String> dataNames = new ArrayList<String>();
        dataNames.add("data 1");
        dataNames.add("data 2");
        dataNames.add("data 3");
        dataNames.add("data 4");

        ArrayList<Double> dataValuesA = new ArrayList<Double>();
        dataValuesA.add(10.0);

        ArrayList<Double> dataValuesB = new ArrayList<Double>();
        dataValuesB.add(20.0);

        ArrayList<Double> dataValuesC = new ArrayList<Double>();
        dataValuesC.add(50.0);

        ArrayList<Double> dataValuesD = new ArrayList<Double>();
        dataValuesD.add(25.0);

        ArrayList<ArrayList<Double>> dataValues = new ArrayList<ArrayList<Double>>();
        dataValues.add(dataValuesA);
        dataValues.add(dataValuesB);
        dataValues.add(dataValuesC);
        dataValues.add(dataValuesD);

        OptionsChart chartOptions = new OptionsChart();
        chartOptions.setDataNames(dataNames)
                    .setDataValues(dataValues)
                    .setType("pie3DChart")
                    .setRotX(20)
                    .setRotY(20)
                    .setPerspective(30)
                    .setColor("2")
                    .setSizeX(10)
                    .setSizeY(5)
                    .setChartAlign("center")
                    .setShowPercent(true);

        docx.addChart(chartOptions);

        docx.addText("And now the same chart in 2D with a different color scheme and without the percentages:");

        chartOptions = new OptionsChart();
        chartOptions.setDataNames(dataNames)
                    .setDataValues(dataValues)
                    .setType("pieChart")
                    .setColor("3")
                    .setSizeX(10)
                    .setSizeY(5)
                    .setChartAlign("center");

        docx.addChart(chartOptions);

        docx.createDocx("example_addChart_1");
    }
}

The resulting Word document looks like:

Example #2

package examples.Core.addChart;

import java.util.ArrayList;

import com.javadocx.CreateDocx;
import com.javadocx.elements.*;

public class Sample2 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();

        docx.addText("We will now add a 3D horizontal bar chart to the Word document:");

        ArrayList<String> dataLegends = new ArrayList<String>();
        dataLegends.add("Legend 1");
        dataLegends.add("Legend 2");
        dataLegends.add("Legend 3");

        ArrayList<String> dataNames = new ArrayList<String>();
        dataNames.add("data 1");
        dataNames.add("data 2");
        dataNames.add("data 3");

        ArrayList<Double> dataValuesA = new ArrayList<Double>();
        dataValuesA.add(10.0);
        dataValuesA.add(20.0);
        dataValuesA.add(5.0);

        ArrayList<Double> dataValuesB = new ArrayList<Double>();
        dataValuesB.add(20.0);
        dataValuesB.add(60.0);
        dataValuesB.add(3.0);

        ArrayList<Double> dataValuesC = new ArrayList<Double>();
        dataValuesC.add(50.0);
        dataValuesC.add(33.0);
        dataValuesC.add(7.0);

        ArrayList<ArrayList<Double>> dataValues = new ArrayList<ArrayList<Double>>();
        dataValues.add(dataValuesA);
        dataValues.add(dataValuesB);
        dataValues.add(dataValuesC);

        OptionsChart chartOptions = new OptionsChart();
        chartOptions.setDataLegends(dataLegends)
                    .setDataNames(dataNames)
                    .setDataValues(dataValues)
                    .setType("bar3DChart")
                    .setRotX(20)
                    .setRotY(20)
                    .setPerspective(20)
                    .setColor("2")
                    .setSizeX(15)
                    .setSizeY(10)
                    .setChartAlign("center")
                    .setLegendOverlay(false)
                    .setBorder(1)
                    .setHgrid(1)
                    .setVgrid(2);

        docx.addChart(chartOptions);

        docx.addText("And now the same chart in 2D with a different color scheme and with the table data:");

        chartOptions = new OptionsChart();
        chartOptions.setDataLegends(dataLegends)
                    .setDataNames(dataNames)
                    .setDataValues(dataValues)
                    .setType("barChart")
                    .setColor("5")
                    .setSizeX(15)
                    .setSizeY(10)
                    .setChartAlign("center")
                    .setLegendPos("none")
                    .setLegendOverlay(false)
                    .setBorder(1)
                    .setHgrid(1)
                    .setVgrid(0)
                    .setShowTable(true);

        docx.addChart(chartOptions);

        docx.createDocx("example_addChart_2");
    }
}

The resulting Word document looks like:

Example #3

package examples.Core.addChart;

import java.util.ArrayList;

import com.javadocx.CreateDocx;
import com.javadocx.elements.*;

public class Sample3 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();

        docx.addText("We will now add a 3D column chart \"100% stacked\" to the Word document:");

        ArrayList<String> dataLegends = new ArrayList<String>();
        dataLegends.add("Series 1");
        dataLegends.add("Series 2");
        dataLegends.add("Series 3");

        ArrayList<String> dataNames = new ArrayList<String>();
        dataNames.add("data 1");
        dataNames.add("data 2");
        dataNames.add("data 3");
        dataNames.add("data 4");

        ArrayList<Double> dataValuesA = new ArrayList<Double>();
        dataValuesA.add(10.0);
        dataValuesA.add(7.0);
        dataValuesA.add(5.0);

        ArrayList<Double> dataValuesB = new ArrayList<Double>();
        dataValuesB.add(20.0);
        dataValuesB.add(60.0);
        dataValuesB.add(3.0);

        ArrayList<Double> dataValuesC = new ArrayList<Double>();
        dataValuesC.add(50.0);
        dataValuesC.add(33.0);
        dataValuesC.add(7.0);

        ArrayList<Double> dataValuesD = new ArrayList<Double>();
        dataValuesD.add(25.0);
        dataValuesD.add(0.0);
        dataValuesD.add(14.0);

        ArrayList<ArrayList<Double>> dataValues = new ArrayList<ArrayList<Double>>();
        dataValues.add(dataValuesA);
        dataValues.add(dataValuesB);
        dataValues.add(dataValuesC);
        dataValues.add(dataValuesD);

        OptionsChart chartOptions = new OptionsChart();
        chartOptions.setDataLegends(dataLegends)
                    .setDataNames(dataNames)
                    .setDataValues(dataValues)
                    .setType("col3DChart")
                    .setPerspective(40)
                    .setColor("2")
                    .setSizeX(10)
                    .setSizeY(10)
                    .setChartAlign("center")
                    .setLegendOverlay(false)
                    .setBorder(1)
                    .setHgrid(0)
                    .setVgrid(0)
                    .setShowTable(true)
                    .setLegendPos("t")
                    .setBorder(1)
                    .setGroupBar("percentStacked");

        docx.addChart(chartOptions);

        docx.addText("And now the same chart with a different color scheme and perspective, without the data table and simply stacked:");

        chartOptions = new OptionsChart();
        chartOptions.setDataLegends(dataLegends)
                    .setDataNames(dataNames)
                    .setDataValues(dataValues)
                    .setType("col3DChart")
                    .setColor("3")
                    .setPerspective(10)
                    .setRotX(10)
                    .setRotY(10)
                    .setChartAlign("center")
                    .setSizeX(10)
                    .setSizeY(10)
                    .setLegendPos("b")
                    .setLegendOverlay(false)
                    .setBorder(1)
                    .setHgrid(3)
                    .setVgrid(0)
                    .setGroupBar("stacked");

        docx.addChart(chartOptions);

        docx.createDocx("example_addChart_3");
    }
}

The resulting Word document looks like: