replaceChartData

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

replaceChartData

ADVANCED / PREMIUM

TRIAL

Replaces the data associated with a given chart (titles, categories, legends, sections and values).

Description

public replaceChartData (string $source, string $target, array $data)

This method allows to replace the chart data in an existing Word document. You may fully customize the chart via the Word interface before inserting the real data with the help of phpdocx.

The chart type to be updated must be supported by addChart. Extended charts are not supported.

Parameters

source

Path to the DOCX.

target

Path to the resulting DOCX.

data

The keys are the numbers of the charts to replace and the values are arrays of data as described in the addChart method.

Exceptions

Error while trying to open the (base) template as a zip file.

The index chart does not exist.

Code samples

Example #1

require_once 'classes/DocxUtilities.php';

$docx = new DocxUtilities();

$source = 'example_area_chart.docx';
$target = 'example_area_chart_replace_data.docx';

$data = array();
$data[0] = array(
    'title' => 'New title',
    'legends' => array(
        'new legend',
    ),
    'categories' => array(
        'cat 1',
        'cat 2',
        'cat 3',
        'cat 4',
    ),
    'values' => array(
        array(25),
        array(20),
        array(15),
        array(10)
    ),
);
$data[1] = array(
    'title' => 'Other title',
    'legends' => array(
        'legend 1',
        'legend 2',
        'legend 3',
    ),
    'categories' => array(
        'other cat 1',
        'other cat 2',
        'other cat 3',
        'other cat 4',
    ),
    'values' => array(
        array(25, 10, 5),
        array(20, 5, 4),
        array(15, 0, 3),
        array(10, 15, 2),
    ),
);

$docx->replaceChartData($source, $target, $data);

Release notes

phpdocx 15.5:
- removed @ (shut-up) operator to get categories.

phpdocx 14.0:
- return DOCXStructure.

phpdocx 13.5:
- DOCXStructure and in-memory DOCX documents.

phpdocx 12.0:
- use the default temp folder to generate XLSX files.

phpdocx 8.0:
- add editable XLSX.

phpdocx 7.0:
- improved to support titles, legends and categories.