XML API - pdx:addChart

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addChart

Inserts a chart into a Word document.

Note

You are reading the XML API documentation. For the PHP API method please go to addChart.

Description

Element definition

<pdx:content>
    <pdx:addChart pdx:chartType="barChart|bar3DChart|bar3DChartCylinder|bar3DChartCone|bar3DChartPyramid|colChart|col3DChart|col3DChartCylinder|col3DChartCone|bar3DChartPyramid|pieChart|pie3DChart|lineChart|line3DChart|areaChart|area3DChart|radar|scatterChart|surfaceChart|ofpiechar|doughnut|bublechart" pdx:wordFragmentName="">
        <pdx:data pdx:dataId="" pdx:type="chart">
            <pdx:legend>
                <pdx:seriesLegend pdx:value="" />
                <pdx:seriesLegend pdx:value="" />
            </pdx:legend>
            <pdx:chartData>
                <pdx:series pdx:name="">
                    <pdx:dataValue pdx:value="" />
                    <pdx:dataValue pdx:value="" />
                </pdx:series>
                <pdx:series pdx:name="">
                    <pdx:dataValue pdx:value="" />
                    <pdx:dataValue pdx:value="" />
                </pdx:series>
            </pdx:chartData>
        </pdx:data>
        <pdx:axisX pdx:label="" pdx:display="vertical|horizontal|rotated" />
        <pdx:axisY pdx:label="" pdx:display="vertical|horizontal|rotated" />
        <pdx:border pdx:color="" pdx:width="" />
        <pdx:chartAlign pdx:value="left|center|right" />
        <pdx:color pdx:value="" />
        <pdx:externalXLSX pdx:src="" pdx:occurrences="" />
        <pdx:float pdx:value="left|center|right" />
        <pdx:font pdx:value="" />
        <pdx:formatCode pdx:value="" />
        <pdx:formatDataLabels pdx:rotation="" pdx:position="" />
        <pdx:groupBar pdx:value="clustered|stacked|percentStacked" />
        <pdx:hgrid pdx:vale="" />
        <pdx:haxLabel pdx:value="" />
        <pdx:haxLabelDisplay pdx:value="rotated|vertical|horizontal" />
        <pdx:legendDisplay pdx:position="b|tr|l|r|t" pdx:overlay="" pdx:showCategory="" pdx:showTable="" pdx:showPercent="" pdx:showValue="" />
        <pdx:legendOverlay pdx:value="" />
        <pdx:legendPos pdx:value="r|l|t|b|none" />
        <pdx:majorUnit pdx:value="" />
        <pdx:minorUnit pdx:value="" />
        <pdx:perspective pdx:value="" />
        <pdx:rotX pdx:value="" />
        <pdx:rotY pdx:value="" />
        <pdx:scalingMax pdx:value="" />
        <pdx:scalingMin pdx:value="" />
        <pdx:showCategory pdx:value="" />
        <pdx:showLegendKey pdx:value="" />
        <pdx:showPercent pdx:value="" />
        <pdx:showSeries pdx:value="" />
        <pdx:showTable pdx:value="" />
        <pdx:showValue pdx:value="" />
        <pdx:sizeX pdx:value="" />
        <pdx:sizeY pdx:value="" />
        <pdx:textWrap pdx:value="" />
        <pdx:tickLblPos pdx:value="" />
        <pdx:title pdx:value="" />
        <pdx:vaxLabel pdx:value="" />
        <pdx:vaxLabelDisplay pdx:value="rotated|vertical|horizontal" />
        <pdx:verticalOffset pdx:value="" />
        <pdx:vgrid pdx:vale="" />
        <pdx:advancedProperties>
            <pdx:barChart pdx:groupBar="clustered|stacked|percentStacked|standard" />
            <pdx:colChart pdx:groupBar="clustered|stacked|percentStacked|standard" />
            <pdx:pieChart pdx:explosion="" />
            <pdx:doughnutChart pdx:explosion="" pdx:holeSize="" />
            <pdx:ofPieChart pdx:subtype="bar|pie" pdx:gapWidth="" pdx:secondPieSize="" pdx:splitType="auto|custom|percent|position|value" pdx:splitValue="" pdx:customSplit="" />
            <pdx:lineChart pdx:lineSymbol="none|dot|plus|square|star|triangle|x|diamond|circle|dash" pdx:symbolSize="" pdx:smooth="" />
            <pdx:scatterChart pdx:scatterSymbol="dot|line" pdx:symbolSize="" pdx:smooth="" />
            <pdx:radarChart pdx:radarStyle="radar|marker|filled" />
            <pdx:surfaceChart pdx:wireframe="" />
        </pdx:advancedProperties>
        <pdx:theme>
            <pdx:chartArea>
                <pdx:backgroundColor pdx:value="" />
            </pdx:chartArea>
            <pdx:horizontalAxis>
                <pdx:textBold pdx:val="" />
                <pdx:textDirection pdx:val="" />
                <pdx:textItalic pdx:val="" />
                <pdx:textSize pdx:val="" />
                <pdx:textUnderline pdx:val="" />
            </pdx:horizontalAxis>
            <pdx:legendArea>
                <pdx:backgroundColor pdx:value="" />
            </pdx:legendArea>
            <pdx:plotArea>
                <pdx:backgroundColor pdx:value="" />
            </pdx:plotArea>
            <pdx:serRgbColors>
                <pdx:dataValue pdx:value="" />
                <pdx:dataValue pdx:value="" />
            </pdx:serRgbColors>
            <pdx:valueRgbColors>
                <pdx:valueRgbColorsValues>
                    <pdx:dataValue pdx:value="" />
                    <pdx:dataValue pdx:value="" />
                </pdx:valueRgbColorsValues>
                <pdx:valueRgbColorsValues>
                    <pdx:dataValue pdx:value="" />
                    <pdx:dataValue pdx:value="" />
                </pdx:valueRgbColorsValues>
            </pdx:valueRgbColors>
            <pdx:verticalAxis>
                <pdx:textBold pdx:val="" />
                <pdx:textDirection pdx:val="" />
                <pdx:textItalic pdx:val="" />
                <pdx:textSize pdx:val="" />
                <pdx:textUnderline pdx:val="" />
            </pdx:verticalAxis>
        </pdx:theme>
    </pdx:addChart>
</pdx:content>

This element allows the insertion of a chart into the Word document.

You may insert many different types of 2D and 3D charts:

2D
- Bar (clustered, stacked and 100% stacked).
- Column (clustered, stacked and 100% stacked).
- 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.

Attributes and sub-elements

Key	Description
chartType	The possible values are: barChart bar3DChart bar3DChartCylinder bar3DChartCone bar3DChartPyramid 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	The chart title (if any).
border	Border width in points.
color	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
chartAlign	Chart alignment: left (default), right or center.
externalXLSX	Possible attributes and values are: src => (string) path to the external file. occurrences => (array) (optional) by default the option adds all charts of the source file. If occurrences is not empty, it adds the referenced positions. Value from 1.
float	Floating chart: left, right or center. It only applies if textWrap is not inline (default value).
font	The font to be used. Arial, Calibri...
sizeX	The chart width in centimeters (default value aprox 8.5 cm).
sizeY	The chart height in centimeters (default value aprox 6.0 cm).
textWrap	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)

Chart display properties

Key	Description
formatCode	Number format.
formatDataLabels	Possible attributes and values are: rotation => int value position => center, insideEnd, insideBase, outsideEnd
haxLabel	Label for the horizontal axis.
haxLabelDisplay	How to display the label of the horizontal axis. Possible values are: vertical, horizontal, rotated.
hgrid	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	Given in emus (1cm = 360000 emus).
majorUnit	Major unit value for bar, col, line, area, radar and scatter charts.
minorUnit	Minor unit value for bar, col, line, area, radar and scatter charts.
scalingMax	Scaling max value for bar, col, line, area, radar and scatter charts.
scalingMin	Scaling max value for bar, col, line, area, radar and scatter charts.
vaxLabel	Label for the vertical axis.
vaxLabelDisplay	How to display the label of the horizontal axis. Possible values are: vertical, horizontal, rotated.
verticalOffset	Given in emus (1cm = 360000 emus).
vgrid	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	Description
legendOverlay	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	The possible values are: b (bottom) l (left) r (right) t (top) none
showCategory	If true shows the categories inside the chart.
showLegendKey	If true shows the legend values.
showPercent	If true shows the percentage values.
showSeries	If true shows the series values.
showTable	If true shows the chart data in an associated table.
showValue	If true shows the chart data values.

Further configuration options for specific chart types are:

Key	Description
Bar and column charts
groupBar	Different ways to group the data. Possible values are: clustered, stacked, percentStacked and standard.
tickLblPos	Tick label position.
Pie and doughnut charts
explosion	Distance among different sectors.
holeSize	Size of the inner hole (only doughnut charts).
ofPieCharts: pie of pie and bar of pie charts
custSplit	Custom split. Array (zero based) of values that go in the second chart. For example: array(3,4,7) will pick the fourth, fifth and eighth value.
gapWidth	Distance between the two charts.
secondPieSize	Percentage size of the auxiliary chart.
splitPos	Determines the threshold value to split the charts.
splitType	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)
subtype	Defines if the auxiliary chart is a pie or bar chart. Possible values are pie or bar.
Line and scatter (XY) charts.
smooth	If true it smooths the line (only scatter charts)
symbol	The possible symbol values: Line charts: none, dot, plus, square, star, triangle, x, diamond, circle and dash. Scatter charts: dot and line.
symbolSize	The size of the symbol used.
Radar charts.
style	Defines the radar chart style. Possible values are: radar (lines without dots) marker (lines with dots) filled (filled enclosed area)
Surface charts
wireframe	If true the surface is shown as a wireframe.

Additional available options for 3D charts:

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

Theme options (Only available in Premium linceses):

key	Description
chartArea	backgroundColor
gridLines	capType, color, dashType, width
horizontalAxis	textBold, textDirection (horizontal, rotate90, rotate270), textItalic, textSize, textUnderline (DrawingML values such as none, sng, dash)
legendArea	backgroundColor, textBold, textItalic, textSize, textUnderline
plotArea	backgroundColor
serRgbColors	series colors
valueRgbColors	values colors
verticalAxis	textBold, textDirection (horizontal, rotate90, rotate270), textItalic, textSize, textUnderline (DrawingML values such as none, sng, dash)

Code samples

Example #1

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:output pdx:name="output" pdx:type="docx" />
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main" >
    <pdx:content>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">We will now add a 3D pie chart to the Word document:</pdx:data>
                <pdx:textRunStyle>
                    <pdx:font pdx:value="Arial" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addChart pdx:chartType="pie3DChart">
            <pdx:data pdx:dataId="" pdx:type="chart">
                <pdx:chartData>
                    <pdx:series pdx:name="data 1">
                        <pdx:dataValue pdx:value="20" />
                    </pdx:series>
                    <pdx:series pdx:name="data 2">
                        <pdx:dataValue pdx:value="30" />
                    </pdx:series>
                    <pdx:series pdx:name="data 3">
                        <pdx:dataValue pdx:value="40" />
                    </pdx:series>
                </pdx:chartData>
            </pdx:data>
            <pdx:rotX pdx:value="20" />
            <pdx:rotY pdx:value="20" />
            <pdx:perspective pdx:value="30" />
            <pdx:chartAlign pdx:value="center" />
            <pdx:color pdx:value="2" />
            <pdx:showPercent pdx:value="1" />
            <pdx:sizeX pdx:value="10"/>
            <pdx:sizeY pdx:value="5"/>
            <pdx:chartAlign pdx:value="center"/>
        </pdx:addChart>
         <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">And now the same chart in 2D with a different color scheme and without the percentages:</pdx:data>
                <pdx:textRunStyle>
                    <pdx:font pdx:value="Arial" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addChart pdx:chartType="pieChart">
            <pdx:data pdx:dataId="" pdx:type="chart">
                <pdx:chartData>
                    <pdx:series pdx:name="data 1">
                        <pdx:dataValue pdx:value="20" />
                    </pdx:series>
                    <pdx:series pdx:name="data 2">
                        <pdx:dataValue pdx:value="30" />
                    </pdx:series>
                    <pdx:series pdx:name="data 3">
                        <pdx:dataValue pdx:value="40" />
                    </pdx:series>
                </pdx:chartData>
            </pdx:data>
            <pdx:chartAlign pdx:value="center" />
            <pdx:color pdx:value="3" />
            <pdx:sizeX pdx:value="10"/>
            <pdx:sizeY pdx:value="5"/>
            <pdx:chartAlign pdx:value="center"/>
        </pdx:addChart>
    </pdx:content>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:settings>
    </pdx:settings>
</pdx:document>

PHP code

require_once 'path_to_phpdocx/classes/CreateDocx.php';

$docx = new XMLAPI('config.xml');
$docx->setDocumentProperties('settings.xml');
$docx->addContent('content.xml');

$docx->render();

The resulting Word document looks like: