Practical javadocx

Charts

Introduction

Working with charts is as easy as with pictures. You just need to choose the kind of graphic to insert and add the values and legends.

There are 2D and 3D graphic available, with many formats like cylinder, cone or pyramid, column type, pie format, line, area, radar, surface, doughnut...

Adding charts

For adding charts in a document, call addChart:

public String addChart(OptionsChart options) throws Exception

It counts with multiple options to use in the array of parameters. The most important are:

"type": Type of chart
"dataNames": ArrayList
"dataValues": ArrayList
"title": Text used as a title

Beside these attributes, you can define other properties as rotation with rotX and rotY, perspective, distance between values, sizes, and so on.

For example, to add a pie type chart, first define names and values:

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);

Next, define the options of the chart:

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

Finally, add the chart:

docx.addChart(chartOptions);

Adding charts in templates

You can create a chart as a WordFragment and substitute it instead of a specific placehoder. This procedure is similar to the placeholder template replacement for text and images.

replaceVariableByWordFragment is the same method as the one explained for images:

public void replaceVariableByWordFragment(HashMap<String, WordFragment> variables)

public void replaceVariableByWordFragment(HashMap<String, WordFragment> variables, OptionsReplaceVariableByWordFragment options)

For example, you can create as a WordFragment the same chart seen before.

WordFragment chart = new WordFragment(docx, "document");
chart->addChart(chartOptions);

Then, replace it in the template:

OptionsReplaceVariableByWordFragment replaceVariableByWordFragmentOptions = new OptionsReplaceVariableByWordFragment();
replaceVariableByWordFragmentOptions.setType("block");

HashMap<String, WordFragment> variables = new HashMap<String, WordFragment>();
variables.put("CHART", chart);

docx.replaceVariableByWordFragment(variables, replaceVariableByWordFragmentOptions);

Tips and tricks

javadocx includes the color schemes used in MS Word for charts. You can define this property through the "color" option of the addChart method.

Next - HTML and CSS