SAV Charts

Extension key: sav_charts
Version: 14.6
Language: en
Description: Extension which displays charts using the Charts.js library
Keywords: sav_charts
Copyright: 2026
Author: Laurent Foulloy
Email: yolf.typo3@orange.fr
License: This document is published under the Open Content License available from www.opencontent.org/openpub.
Rendered: Fri, 11 Sep 2026 08:31:42 +0000

The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from www.typo3.org.

This extension displays charts using the Chart.js library.

Screen Shoots

SAV Charts is provided with several basic templates and more advanced templates which simplify the implementation of charts with several sets of data.

Tutorial

Everything you need to know to develop and use SAV charts.

Reference

Tags for the XML paser and viewHelpers for the Fluid parser are detailled.

Introduction

What Does it Do?

This extension displays charts using the Chart.js library.

SAV Charts was originally designed to build chart configurations through XML tags instead of JavaScript. Markers can be introduced in templates. Data can also be changed through XML either manually or using query managers.

Since version 14.6.0, data can also come from spreadsheets when using the Fluid parser, thanks to PhpSpreadsheet.

Important

Starting with version 14.5.0 of SAV Charts, a new parser based solely on Fluid and specific viewHelpers has been introduced. Thanks to Fluid syntax, it simplifies writing complex charts and using references.

While generating charts is faster with the XML parser, writing complex code is much simpler with the Fluid parser.

Screenshots

SAV Charts is provided with several basic templates and more advanced templates which simplify the implementation of charts with several sets of data.

XML Templates are in the directory Resources/Private/Templates/ChartsExamples.

XML templates were also converted to Fluid templates and are available in Resources/Private/Templates/ChartsExamples/FluidParser.

The following charts type are available screenshots are obtained with the provided basic templates:

Bar charts
Bubble charts
Doughnut charts
Line charts
Pie charts
Polar area charts
Radar charts
Stacked bar charts
Horizontal bar charts
Scatter Line Charts
Charts can also be combined (Combo charts), e.g. a bar chart with a line chart

Bar Chart

Bubble Chart

Doughnut Chart

Horizontal Bar Chart

Horizontal Stacked Bar Chart

Line Chart

Pie Chart

Polar Area Chart

Radar Chart

Scatter Chart

Stacked Bar Chart

Combination Chart

Chart built from a Spreadsheet

Sponsoring

If you find this extension helpful, please consider supporting its development with a donation via PayPal.com — it only takes a click!

Users Manual

Download and install the extension in your site's dependencies. The extension comes with default site settings.
Read the tutorial section.

Administration

Important

The flag Allow queries (Admin) must be set by an Admin user in the content Flexform to execute queries.

Warning

This extension generates raw JavaScript codes from the chart configurations in the backend.

Most often, simple configurations are taken from the Chart.js documentation. However, more complex configurations can be entered. As stated in the TYPO3 Security Guide, "Even if editors do not insert malicious code intentionally, sometimes the lack of knowledge, expertise or security awareness could put your website under risk".

Admin users should be careful before granting the rights for backend users to enter charts.

The SAV Charts is provided with an upgrade wizard that converts the existing Flexforms on your website. The upgrade wizard adds three sheets to the Flexforms (see Plugin Interface). It also duplicates existing XML parser configurations as closely as possible to Fluid parser configurations.

Tutorials

Starting with version 14.5.0, SAV Charts comes with two template parsers and a new plugin interface in the backend.

Plugin Interface

The plugin contains a Flexform for configuring the XML and Fluid parsers. Both codes can exist simultaneously. If you already have XML code on your web server, an updater will transfer the original to the XML parser tab. An automatic conversion will also be introduced to the Fluid parser tab. A debug feature has been introduced in the Fluid parser.

Parsers

Based mainly on the PHP class SimpleXMLElement, The XML parser provides fast chart generation.

The Fluid Parser is a new parser based solely on Fluid syntax and specific viewHelpers.

Plugin Interface

In layout mode, the SAV Charts plugins are displayed with a modified header that provides additional information about the parser in use and the possible debug mode for the Fluid parser.

The plugin options contain three tabs. The first tab is for general configuration. This includes selecting the parser type and granting the right to use queries. The latter must be granted by an admin user.

The second tab is for XML parser configuration. It contains the same fields as the previous version of the SAV Charts extension.

The third tab is for the Fluid parser configuration. This contains the same fields as the second tab, plus a debug feature.

Parsers

The XML parser is a parser that was developed for TYPO3 6.2 and later versions. Based mainly on the PHP class SimpleXMLElement, it provides fast chart generation. However, the PHP code is complex. XML templates lack readability when iterative processing is required.

The new Fluid parser is entirely based on Fluid syntax and viewHelpers. Since all Fluid viewHelpers can be used (e.g. <f:for>, <f:if>, and <f:variable>) the Fluid parser results in simpler templates when iterative processing is required. It also provides simpler PHP code and makes it possible to use or develop other viewHelpers.

Designing Templates From Examples

Introduction

The Chart.js documentation provides examples of various chart types.

The SAV Charts extension includes templates for all chart types. These templates can be found in Resources/Private/Templates/ChartExamples for the XML parser and Resources/Private/Templates/ChartExamples/FluidParser for the Fluid parser.

To display a template, simply create an SAV Charts plugin content element on a page.

Then click on the plugin tab and select the parser type.

Fill in the template field of the Flexform corresponding to the selected parser type, then save.

Important

Use the EXT: prefix to reference the template file from the extension.

<template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/LineChart.xml
</template>

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/LineChart.fluid
</c:template>

<c:template id="1" fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/LineChart.fluid" />

Go to the front-end and you should see the following image.

Writing Templates

The templates provided with the extension were adapted from the examples given in the Chart.js documentation. Let us illustrate the principle for the line chart.

The JavaScript code to display the line graph is as follows:

var data = {
    labels: ["January", "February", "March", "April", "May", "June", "July"],
    datasets: [
        {
            label: "My First dataset",
            fillColor: "rgba(220,220,220,0.2)",
            strokeColor: "rgba(220,220,220,1)",
            pointColor: "rgba(220,220,220,1)",
            pointStrokeColor: "#fff",
            pointHighlightFill: "#fff",
            pointHighlightStroke: "rgba(220,220,220,1)",
            data: [65, 59, 80, 81, 56, 55, 40]
        },
        {
            label: "My Second dataset",
            fillColor: "rgba(151,187,205,0.2)",
            strokeColor: "rgba(151,187,205,1)",
            pointColor: "rgba(151,187,205,1)",
            pointStrokeColor: "#fff",
            pointHighlightFill: "#fff",
            pointHighlightStroke: "rgba(151,187,205,1)",
            data: [28, 48, 40, 19, 86, 27, 90]
        }
    ]
};

The template is created by converting the JavaScript code into an XML structure with the data tag. Thanks to the data tag ID, references can be used and applied. These references provide an easy way to split the data, making it possible to overload them in the FlexForm data section or with queries.

The following codes are the XML or Fluid translations of the previous JavaScript code. Data tags with the IDs "labels," "dataSet1," and "dataSet2" can be easily overloaded, as explained in the next section.

<?xml version="1.0" encoding="UTF-8"?>
<charts>        
    <lineChart id="1" data="data#lineChartData" options="data#lineChartOptions" >

        <marker id="labelSet0">My First dataset</marker>
        <marker id="labelSet1">My Second dataset</marker>       

        <data id="labels">
            January, February, March, April, May, June, July
        </data>

        <data id="dataSet0">
            65, 59, 80, 81, 56, 55, 40
        </data>
    
        <data id="dataSet1">
            28, 48, 40, 19, 86, 27, 90
        </data>         

        <data id="set0">
            <item key="label" value="marker#labelSet0" />
            <item key="backgroundColor">rgba(220,220,220,0.2)</item>
            <item key="pointColor">rgba(220,220,220,1)</item>
            <item key="pointBackgroundColor">#fff</item>
            <item key="pointHoverBackgroundColor">rgba(220,220,220,1)</item>
            <item key="data" value="data#dataSet0" />
        </data> 

        <data id="set1">
            <item key="label" value="marker#labelSet12" />
            <item key="backgroundColor">rgba(151,187,205,0.2)</item>
            <item key="pointColor">rgba(151,187,205,1)</item>
            <item key="pointBackgroundColor">#fff</item>
            <item key="pointHoverBackgroundColor">rgba(151,187,205,1)</item>            
            <item key="data" value="data#dataSet1" />
        </data>     

        <data id="dataSets">
            <item key="0" value="data#set0" />
            <item key="1" value="data#set1" />
        </data>     

        <data id="lineChartData">
            <item key="labels" value="data#labels" />           
            <item key="datasets" value="data#dataSets" />       
        </data> 
    
        <data id="lineChartOptions">
        </data>     
    
    </lineChart>
</charts>

<c:charts>        
    <c:chart.line id="1" data="data__lineChartData" options="data__lineChartOptions" >

        <c:marker id="labelSet0">My First dataset</c:marker>
        <c:marker id="labelSet1">My Second dataset</c:marker>       

        <c:data id="labels">
            January, February, March, April, May, June, July
        </c:data>

        <c:data id="dataSet0">
            65, 59, 80, 81, 56, 55, 40
        </c:data>

        <c:data id="dataSet1">
            28, 48, 40, 19, 86, 27, 90
        </c:data>         

        <c:data id="set0">
            <c:item key="label" value="{marker__labelSet0}" />
            <c:item key="backgroundColor">rgba(220,220,220,0.2)</c:item>
            <c:item key="pointColor">rgba(220,220,220,1)</c:item>
            <c:item key="pointBackgroundColor">#fff</c:item>
            <c:item key="pointHoverBackgroundColor">rgba(220,220,220,1)</c:item>
            <c:item key="data" value="{data__dataSet0}" />
        </c:data> 

        <c:data id="set1">
            <c:item key="label" value="{marker__labelSet1}" />
            <c:item key="backgroundColor">rgba(151,187,205,0.2)</c:item>
            <c:item key="pointColor">rgba(151,187,205,1)</c:item>
            <c:item key="pointBackgroundColor">#fff</c:item>
            <c:item key="pointHoverBackgroundColor">rgba(151,187,205,1)</c:item>            
            <c:item key="data" value="{data__dataSet1}" />
        </c:data>     

        <c:data id="dataSets">
            <c:item key="0" value="{data__set0}" />
            <c:item key="1" value="{data__set1}" />
        </c:data>     

        <c:data id="lineChartData">
            <c:item key="labels" value="{data__labels}" />           
            <c:item key="datasets" value="{data__dataSets}" />       
        </c:data> 
    
        <c:data id="lineChartOptions">
        </c:data>     

    </c:chart.line>
</c:charts>

Tip

<data> were inserted inside the <lineChart> tag just by personal choice. They could have been provided before the <lineChart> tag. In that case, the tag would have no content and would simply be written as follows:

<lineChart id="1" data="data#lineChartData" options="data#lineChartOptions" />

<c:chart.line id="1" data="data__lineChartData" options="data__lineChartOptions" />

Overloading Data

Open the plugin in the backend, fill out the Data section of the Flexform as follows, and then save.

<data id="dataSet0">
    20,22,24,20,19
</data>
<data id="dataSet1">
    55,50,51,53,60
</data>
<data id="labels">
    Monday, Tuesday, Wednesday, Thursdat, Friday            
</data>

<c:data id="dataSet0">
    20,22,24,20,19
</c:data>
<c:data id="dataSet1">
    55,50,51,53,60
</c:data>
<c:data id="labels">
    Monday, Tuesday, Wednesday, Thursdat, Friday            
</c:data>

Go in the front-end and you should see the following figure.

In SAV Charts, the principle is that the first definition is used for a given tag with a given ID. In the previous example, for instance, the dataSet0 and dataSet1 tags are defined in the data section before the template section. Consequently, they will not be replaced by the same data tags in the template. The tags in the data section overload the same tags in the template.

This provides a simple way to work with generic templates and adapt their behavior to your data. For example, with the same "LineChart.xml" template, you may want to display only one curve. This can easily be achieved by defining the "dataSets" tag in the data section, as shown below.

<data id="dataSet0">
    20,22,24,20,19
<data>
<data id="labels">
    Monday, Tuesday, Wednesday, Thursdat, Friday            
<data>
<data id="dataSets">
    <item key="0" value="data#set0" />
</data>

<c:data id="dataSet0">
    20,22,24,20,19
<c:data>
<c:data id="labels">
    Monday, Tuesday, Wednesday, Thursdat, Friday            
<c:data>
<c:data id="dataSets">
    <c:item key="0" value="{data__set0}" />
</c:data>

Enter the previous code in the FlexForm Data section. Then, save and go to the front end.

Note

In very specific cases, you can explicitly allow overloading of a given tag by setting the Overload attribute to 1. This feature is used to build a flexible XML template in the file Resources/Private/Templates/ChartExamples/LineChartAdvanced.xml.

Overloading Markers

Markers are tags that can be used to create strings. In the line chart template, two markers are used to define the labels that are displayed in the legend. You can overlay the markers in the Markers section of the Flexform. Enter the following code in the Markers and Data sections. Then, save and go to the front-end.

Markers section

<marker id="labelSet0">Temperature</marker>
<marker id="labelSet1">Humidity</marker>

Data section

        
<data id="dataSet0">
    20,22,24,20,19
</data>
<data id="dataSet1">
    55,50,51,53,60
</data>
<data id="labels">
    Monday, Tuesday, Wednesday, Thursdat, Friday            
</data>

Markers section

<c:marker id="labelSet0">Temperature</c:marker>
<c:marker id="labelSet1">Humidity</c:marker>

Data section

        
<c:data id="dataSet0">
    20,22,24,20,19
</c:data>
<c:data id="dataSet1">
    55,50,51,53,60
</c:data>
<c:data id="labels">
    Monday, Tuesday, Wednesday, Thursdat, Friday            
</c:data>

Options

Options are defined in the Chart.js documentation. They can be set by overloading the <data> tag associated with the options attribute of the chart. In the LineChart.xml template, for example, the chart is defined as follows:

<lineChart id="1" data="data#lineChartData" options="data#lineChartOptions" >
    ....
</lineChart>

<c:chart.line id="1" data="data__lineChartData" options="data__lineChartOptions" >
    ....
</c:chart.line>

The options attribute is a reference to the <data> tag whose ID is lineChartOptions.

Overloading this tag in the Data section of the Flexform will set the options. Assume that the Data section is still configured with a modified label. Add the following code to the Data section of the Flexform. This will cancel the animation, set a linear interpolation between points, and display the line a width of 10 points.

<data id="lineChartOptions" >
    <item key="animation"></item>
    <item key="elements">
        <item key="line">
            <item key="tension" value="0" />
            <item key="borderWidth" value="10" />
        </item>
    </item>
</data>

<c:data id="lineChartOptions" >
    <c:item key="animation"></c:item>
    <c:item key="elements">
        <c:item key="line">
            <c:item key="tension" value="0" />
            <c:item key="borderWidth" value="10" />
        </c:item>
    </c:item>
</c:data>

Note

A linear interpolation is obtained by setting the tension to 0 in Chart.defaults.global.elements.line (see Chart.js documentation). Since the global options are in the <data> whose ID is lineChartOptions, nested items whose keys are elements and line provide access to Chart.defaults.global.elements.line.

Tip

To generate a Boolean value, set the attribute value to true or false.

Using Advanced Templates

SAV Charts provides more complex templates. They can display up to nine items on the same chart.

The colors are defined in a specific template, either DefaultColors.xml for the XML parser or FluidParser/DefaultColors.fluid for the Fluid parser. These colors were chosen to provide contrast between items.

To illustrate the use of advanced templates, consider the LineChartAdvanced.xml template or the FluidParser/LineChartAdvanced.fluid template.

Enter the following code in the template section, then save and go to the front end.

<template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/LineChartAdvanced.xml
</template>

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/LineChartAdvanced.fluid
</c:template>

The chart has nine superimposed curves with the same data, as well as predefined colors, labels, and a title. Click on the legend to hide a curve.

In the data section enter the following code, save, and go to the front-end.

<data id="data">
    <item key="0" values="10, 6, 7, 2, 1, 5, 3" />     
</data>

<c:data id="data">
    <c:item key="0" values="10, 6, 7, 2, 1, 5, 3" />     
</c:data>

Modify the data section as follows:

<data id="data">
    <item key="0" values="10, 6, 7, 2, 1, 5, 3" />
    <item key="1" values="5, 3, 8, 1, 6, 9, 2" />
</data>  

<data id="labels">
    1, 2, 3, 4, 5, 6, 7
</data>

<c:data id="data">
    <c:item key="0" values="10, 6, 7, 2, 1, 5, 3" />
    <c:item key="1" values="5, 3, 8, 1, 6, 9, 2" />
</c:data>  

<c:data id="labels">
    1, 2, 3, 4, 5, 6, 7
</c:data>

Enter the following code in the marker section, then save and go to the front-end.

<marker id="title">A line chart with two curves</marker> 
<marker id="labelSet0">Curve 1</marker> 
<marker id="labelSet1">Curve 2</marker>

<c:marker id="title">A line chart with two curves</c:marker> 
<c:marker id="labelSet0">Curve 1</c:marker> 
<c:marker id="labelSet1">Curve 2</c:marker>

Using and Developing Query Managers

Query managers are used in <query> tags to execute queries that can be used in charts.

The SAV Charts extension comes with an internal query manager named savcharts that can handle TYPO3 database queries as well as queries from other databases.

Using the Query Manager

In the backend in Records mode create a new record in a page or a folder.

Select Database if you need to access to an external database, fill the different fields and save.

Tip

You do not need to create a new database access if you only need to access to the current TYPO3 database.

Select Query to create a query. Select a database (default is TYPO3 Database), fill the different clauses and save.

The following configuration is an example of how to obtain the number of pages created per year.

In SELECT clause field

COUNT(*) AS Count,
YEAR(FROM_UNIXTIME(crdate)) AS Year

In FROM clause field
```
pages
```
Copied!
In WHERE clause field
```
NOT deleted AND NOT hidden
```
Copied!
In GROUP BY clause field
```
year
```
Copied!

The following query is generated by this configuration.

SELECT
    COUNT(*) AS Count,
    YEAR(FROM_UNIXTIME(crdate)) AS Year
FROM
    pages
WHERE
    NOT deleted AND NOT hidden
GROUP BY
    Year

If the new query has ID 1, the following FlexForm configurations will display a bar chart showing the number of pages per year.

Important

The flag Allow queries (Admin) must be set by an Admin user in the content Flexform to execute queries.

In the Markers Flexform field

<marker id="title">Analysis of the site</marker>
<marker id="labelSet0">Pages per year</marker>

<c:marker id="title">Analysis of the site</c:marker>
<c:marker id="labelSet0">Pages per year</c:marker>

In the Queries Flexform field

<query id="1">
    <setQueryManager name="savcharts" uid="1" />
</query>

<c:query id="1"  manager="savcharts" uid="1" />

In the Data Flexform field

<data id="data0" >
  <setDataFromQuery query="1" field="Count" />
</data>
<data id="labels" >
  <setDataFromQuery query="1" field="Year" />
</data>
<data id="data">
  <item key="0" value="data#data0" />
</data>

<c:data id="labels" values="{query__1.Year}" />

<c:data id="data">
  <c:item key="0" value="{query__1.Count}" />
</c:data>

In the Templates Flexform field

<template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/BarChartAdvanced.xml
</template>

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/BarChartAdvanced.fluid
</c:template>

The default query manager, savcharts, is used in the Queries section. It calls the query with the UID 1.

The Data section of the FlexForm overloads the template to display a single bar chart with data from the query, as explained in Using Advanced Templates.

Go to the front-end to view the resulting chart.

Using Markers in Queries

Markers can be used in queries. For example, assume that the previous query should return the number of pages created between the years yearMin and yearMax.

First, insert the syntax ###marker### into the WHERE clause of the previous content element in the query.

NOT deleted AND NOT hidden AND YEAR(FROM_UNIXTIME(crdate)) BETWEEN ###yearMin### AND ###yearMax###

Add markers to the Flexform field of your chart, then save and go to the front-end.

<marker id="title">Analysis of the site</marker>
<marker id="labelSet0">Pages per year</marker>

<marker id="yearMin">2010</marker>
<marker id="yearMax">2020</marker>

<c:marker id="title">Analysis of the site</c:marker>
<c:marker id="labelSet0">Pages per year</c:marker>

<c:marker id="yearMin">2010</c:marker>
<c:marker id="yearMax">2020</c:marker>

You can also introduce markers in TypoScript. For example, add the following TypoScript to your page to modify only the value of the ###yearMin### marker, then clear the cache and go to the front-end. The syntax customQuery.1 refers to the query with the UID of 1.

plugin.tx_savcharts.settings.customQuery.1 {
  yearMin = TEXT
  yearMin.value = 2009
}

Developing Your Query Manager

Query managers are implemented by means of hooks.The hook for the internal query manager is in Classes/Hooks/SavChartsQueryManager.php. This class extends the abstract class AbstractQueryManager (Classes/Hooks/AbstractQueryManager.php) which itself implements the interface QueryManagerInterface (Classes/Hooks/QueryManagerInterface.php).

You can develop your own query manager by providing a hook which must be added in the file ext_localconf.php of your extension.

Assuming that your vendor name is MyVendorName and your extension name is my_extension. Assuming also that you have written your manager as the class MyQueryManager in Classes/Hooks/MyQueryManager.php. Finally, assuming that you want to name your query manager myManager, you should add the following code in ext_localconf.php of your extension.

$TYPO3_CONF_VARS['EXTCONF'][$_EXTKEY]['queryManagerClass']['myManager'] = \MyVendorName\MyExtension\Hooks\MyQueryManager::class;

Exporting Data in CSV

You can easily export data associated with any chart using the exportCSV method associated with the <charts> tag (see Chart Tags).

Assuming that you want to export data associated with the line chart template with a row header containing the x-axis labels and a column header containing the legend labels of the two curves. Add the following code to the Templates field of the Flexform.

<template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/LineChart.xml
</template>

<data id="data">
  <item key="0" value="data#dataSet0" />
  <item key="1" value="data#dataSet1" />    
</data>

<data id="exportRowHeader">
  <item key="0" value="marker#labelSet0" />
  <item key="1" value="marker#labelSet1" />
</data>
                
<exportCSV reference="lineChart#1" rowHeader="data#exportRowHeader" columnHeader="data#labels" data="data#data" />

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/LineChart.fluid
</c:template>

<c:data id="data">
  <c:item key="0" value="{data__dataSet0}" />
  <c:item key="1" value="{data__dataSet1}" />   
</c:data>

<c:data id="exportRowHeader">
  <c:item key="0" value="{marker__labelSet0}" />
  <c:item key="1" value="{marker__labelSet1}" />
</c:data>

<c:exportCSV fileName="LineChart_1.csv" rowHeader="{data__exportRowHeader}" columnHeader="{data__labels}" data="{data__data}" />

The CSV file is saved in typo3temp/sav_charts.

With the XML parser, the file name is img_ContentId_ChartNumber, where ContentId is the UID of the content element and ChartNumber is the ID of the chart, starting from 0. In the front-end you should see an icon to open the file.

With the Fluid parser, the file name is provided in the argument fileName.

Note

No icon is displayed in the front-end.

Converting Basic XML Templates to Fluid Templates

Introduction

The conversion process is quite simple.

Prefix all tags with c:.
References are written as tag__id instead of tag#id. This change is because the character # is not permitted in Fluid variable names.
To get the value associated with a reference, use the conventional Fluid accessor for variables, i.e. {tag__id}.

Note

Parameters in chart tags (data, options, width, and height), can be values or references.

If they are values, they must be specified directly, for example width="600", or obtained using an accessor. For example {data__width} can be used if <c:data id="width" value="600"/> is called before the chart tag.
As references, the related tags can be defined before or inside the chart tag. Therefore, the best practice for data and options is to always use references.

See Designing Templates from Examples.

Converting Advanced XML Templates to Fluid Templates

Advanced templates are designed to display multiple sets of data on the same chart. Between one and nine sets of data can be displayed on the same chart.

As colour label sets and data sets are built iteratively, a special "<for>" was introduced in the XML parser. This leads to complex statements and poor readability.

In Fluid-based templates, however, conventional Fluid syntax and viewHelpers can be used. Therefore, using the "<f:for>" viewHelper greatly improves readability.

Let us illustrate this point with part of the "LineChartsAdvanced.xml" template. The "<for>" tags in the following excerpt contain data with ids "data" and "labels", as well as intermediate data tags with ids "initData" and "initLabels", which are used to build them.

The Fluid-based version uses simpler code thanks to the "<f:for>" viewHelper.

<!-- Defines the data -->
<for id="initData" each="data#lowIntensityColors">
    <data id="initData" overload="1">
        <item key="for#initData:key" value="data#sampleData" />
    </data>
</for>
<data id="data">
    <setData values="data#initData" />
</data>

<!-- Defines the labels -->
<for id="initLabels" each="data#data">
    <marker id="labelSetId" overload="1">
        <setMarkerByPieces part1="labelSet" part2="for#initLabels:key" />
    </marker>
    <marker id="marker#labelSetId">
        <setMarkerByPieces part1="Label " part2="for#initLabels:key" />
    </marker>
</for>

<!-- Defines the data -->
<c:data id="data">
    <f:for each="{data__lowIntensityColors}" as="color" key="key">
        <c:item key="{key}" value="{data__sampleData}" />
    </f:for>
</c:data>

<!-- Defines the labels for the set -->
<f:for each="{data__data}" as="value" key="key"> 
    <c:marker id="labelSet{key}" value="labelSet {key}"/>       
</f:for>

Similarly, the following excerpt shows how data with the id "dataSets" were set, using markers with ids "setId" and "labelSetId". They are needed to generate new markers with ids "labelSet0", "labelSet1"... and the items with ids 0, 1... for "dataSets".

Once again, Fluid syntax makes it simpler because accessors can be used in accessors. For example, "{data__lowIntensityColors.{key}}" returns the value at the position given by "key" in the data with the id "lowIntensityColors".

         
<!-- Defines the sets -->
<for id="initSets" each="data#data">     
    <marker id="setId" overload="1">
        <setMarkerByPieces part1="set" part2="for#initSets:key" />                
    </marker>  
    <marker id="labelSetId" overload="1">
        <setMarkerByPieces part1="labelSet" part2="for#initSets:key" />                
    </marker>
          
    <data id="marker#setId">
        <item key="label" value="marker#marker#labelSetId" />
        <item key="backgroundColor" value="data#lowIntensityColors:for#initSets:key" />
        <item key="borderColor" value="data#fullIntensityColors:for#initSets:key" />                
        <item key="pointColor" value="data#middleIntensityColors:for#initSets:key" />
        <item key="pointBackgroundColor">#fff</item>
        <item key="pointHoverBackgroundColor" value="data#fullIntensityColors:for#initSets:key" />
        <item key="lineTension" value="false" />
        <item key="data" value="for#initSets:value" />
    </data> 
    <data id="dataSets" overload="1">
        <item key="for#initSets:key" value="data#marker#setId" />
    </data>                         
</for>

  
<!-- Defines the sets -->
<c:data id="dataSets">
    <f:for each="{data__data}" as="value" key="key">
        <c:item key="{key}">
            <c:item key="label" value="{marker__labelSet{key}}" />
            <c:item key="backgroundColor" value="{data__lowIntensityColors.{key}}" />
            <c:item key="borderColor" value="{data__fullIntensityColors.{key}}" />                
            <c:item key="pointColor" value="{data__middleIntensityColors.{key}}" />
            <c:item key="pointBackgroundColor">#fff</c:item>
            <c:item key="pointHoverBackgroundColor" value="{data__fullIntensityColors.{key}}" />
            <c:item key="lineTension" value="false" />
            <c:item key="data" value="{data__data.{key}}" />
        </c:item>
    </f:for>
</c:data>

Including Charts in HTML Templates

SAV Charts viewHelpers can be used in any HTML template processed by Fluid.

The following example illustrates how to integrate a bar chart that displays the number of pages created per year (see Using and Developing Query Managers).

{namespace c=YolfTypo3\SavCharts\ViewHelpers}
<c:marker id="title">Analysis of the site</c:marker>
<c:marker id="labelSet0">Pages per year</c:marker>
<c:query id="1"  manager="savcharts" uid="1" />
<c:data id="labels" values="{query__1.Year}" />
<c:data id="data">
  <c:item key="0" value="{query__1.Count}" />
</c:data>
<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/BarChartAdvanced.fluid
</c:template>

<canvas id="canvas{canvases.0.chartId}" width="{canvases.0.width}" height="{canvases.0.height}"></canvas>

Note

The Fluid variable canvases contains information on the created charts, starting from 0. Therefore, canvases.0.chartId is the ID of the first chart in EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/BarChartAdvanced.fluid.

Using Spreadsheets

SAV Charts makes it possible to create charts from spreadsheets thanks to PhpSpreadsheet.

Important

Use composer to install PhpSpreadsheet into your project in order to use this feature.

composer require phpoffice/phpspreadsheet

Line Chart from Worksheet

Assume we want to generate a line chart from the data provided by the following Excel worksheet.

Enter the following code into the template field of the Flexform. Then save and go to the front.

<c:marker id ="title">Worksheet Example1</c:marker>
    
<c:spreadsheet  fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 
    <c:worksheet name="Example1">

        <!-- Sets the legend -->
        <c:marker id="labelSet0" value="{c:cell.value(address:'B1')}" />
        <c:marker id="labelSet1" value="{c:cell.value(address:'C1')}" />
        <c:marker id="labelSet2" value="{c:cell.value(address:'D1')}" />

        <!-- Gets the colors from the worksheet -->
        <c:data id="worksheetColors">
            <c:item key="0" value="{c:cell.backgroundcolor(address:'B1')}" />
            <c:item key="1" value="{c:cell.backgroundcolor(address:'C1')}" />
            <c:item key="2" value="{c:cell.backgroundcolor(address:'D1')}" />
        </c:data>

        <!-- Sets the color in the datasets -->
        <c:data id="dataSets">
        <f:for each="{data__worksheetColors}" as="color" key="key">
            <c:item key="{key}">
                <c:item key="backgroundColor" value="{color}" />
                <c:item key="borderColor" value="{color}" />
            </c:item>
        </f:for>  
        </c:data> 

        <!-- Sets data and labels -->
        <c:data id="labels" values="{c:cell.range(range:'A2:A13')}" />            
        <c:data id="data" values="{c:cell.range(range:'B2:D13')->c:transpose()}" />

    </c:worksheet>
</c:spreadsheet>

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/LineChartAdvanced.fluid
</c:template>

Note

The viewHelper <c:cell.range> gets the data from the worksheet line by line. Therefore, the data must be transposed before being inserted into the data with ID data.

Note

The different fields in the Flexform are just a simple means of organising the code. Therefore, you can also split the preceding code into three parts:

The marker title in the Markers field of the Flexform.
The spreadsheet part in the Data field of the Flexform.
The template part in the Templates field of the Flexform.

Pie Chart from Values in Worksheet

Assume that we want to generate a pie chart showing customer satisfaction, using the value column in the following worksheet.

Enter the following code into the template field of the Flexform. Then save and go to the front.

       
<c:spreadsheet  fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 
    <c:worksheet name="Example2">

        <!-- Gets the colors from the worksheet -->
        <c:data id="backgroundColor">
            <c:item key="0" value="{c:cell.backgroundcolor(address:'B14')}" />
            <c:item key="1" value="{c:cell.backgroundcolor(address:'B15')}" />
            <c:item key="2" value="{c:cell.backgroundcolor(address:'B16')}" />
            <c:item key="3" value="{c:cell.backgroundcolor(address:'B17')}" />                
        </c:data>
        
        <c:data id="hoverBackgroundColor">
            <c:item key="0" value="{c:cell.backgroundcolor(address:'B14', alpha:50)}" />
            <c:item key="1" value="{c:cell.backgroundcolor(address:'B15', alpha:50)}" />
            <c:item key="2" value="{c:cell.backgroundcolor(address:'B16', alpha:50)}" />
            <c:item key="3" value="{c:cell.backgroundcolor(address:'B17', alpha:50)}" />                
        </c:data>         

        <!-- Sets data and labels -->
        <c:data id="labels" values="{c:cell.range(range:'B14:B17')}" />  
        <c:data id="dataSet0" values="{c:cell.range(range:'C14:C17')}" />

        <!-- Sets options -->
        <c:data id="pieChartOptions">
            <c:item key="plugins">
                <c:item key="title">
                    <c:item key="display" value="true" />
                    <c:item key="text" value="{c:cell.value(address:'A14')}" />
                </c:item>
            </c:item>                               
        </c:data>
        
    </c:worksheet>
</c:spreadsheet>

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/PieChart.fluid
</c:template>

As it can be seen in the following figure, the tiptool provides the value as entered in the worksheet.

Pie Chart from Percentages in Worksheet

Now assume we want to generate the pie chart from the percentage column. The values in this column are calculated using formulas. For example, the value in cell D14 is obtained using the formula =C14/C18. The result is actually 0.5, but it is displayed as 50% because this cell uses the percentage format.

This has consequences for the range view helper, in that several arguments must be taken into account:

The argument calculateFormulas must be set to true, which is the default value.
If the argument formatData is set to false (the default value), the imported data for cell D14 will be 0.5. This will need to be multiplied by 100 to obtain the percentage, and the % sign will need to be added in the tooltip. If it is set to true, the imported data will be 50%. In this case, the % sign will have to be removed from the chart data, but kept in the tip tool.

The following code illustrates the case where default values are kept for both previous arguments. The tiptool is modified by a callback function.

       
<c:spreadsheet  fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 
    <c:worksheet name="Example2">

        <!-- Gets the colors from the worksheet -->
        <c:data id="backgroundColor">
            <c:item key="0" value="{c:cell.backgroundcolor(address:'B14')}" />
            <c:item key="1" value="{c:cell.backgroundcolor(address:'B15')}" />
            <c:item key="2" value="{c:cell.backgroundcolor(address:'B16')}" />
            <c:item key="3" value="{c:cell.backgroundcolor(address:'B17')}" />                
        </c:data>
        
        <c:data id="hoverBackgroundColor">
            <c:item key="0" value="{c:cell.backgroundcolor(address:'B14', alpha:50)}" />
            <c:item key="1" value="{c:cell.backgroundcolor(address:'B15', alpha:50)}" />
            <c:item key="2" value="{c:cell.backgroundcolor(address:'B16', alpha:50)}" />
            <c:item key="3" value="{c:cell.backgroundcolor(address:'B17', alpha:50)}" />                
        </c:data>         

        <!-- Sets data and labels -->
        <c:data id="labels" values="{c:cell.range(range:'B14:B17')}" />  
        <c:data id="dataSet0" values="{c:cell.range(range:'D14:D17')}" />

        <!-- Sets options -->
        <c:data id="pieChartOptions">
            <c:item key="plugins">
                <c:item key="title">
                    <c:item key="display" value="true" />
                    <c:item key="text" value="{c:cell.value(address:'A14')}" />
                </c:item>
                <c:item key="tooltip">
                    <c:item key="backgroundColor">rgba(0,0,0,0.7)</c:item>
                    <c:item key="callbacks">
                        <c:callback key="label">
                            function(context) {
                                return (' ' + parseFloat((context.formattedValue).replace(',', '.')) * 100.0) + '%';
                            }
                        </c:callback>
                    </c:item>
                </c:item>                    
            </c:item>                               
        </c:data>
        
    </c:worksheet>
</c:spreadsheet>

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/PieChart.fluid
</c:template>

Bar Chart from Percentages in Worksheet

This example illustrates a case in which the formatData argument is set to true in the range viewHelper. It deals with the sales represented as a bar chart. Fluid processing removes the percentage sign.

<c:marker id="labelSet0">Percentage</c:marker>

<c:spreadsheet  fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 
    <c:worksheet name="Example2">

        <c:marker id="title">{c:cell.value(address:'A2')}</c:marker>

        <!-- Gets the colors from the worksheet -->
        <c:data id="backgroundColor">
            <c:item key="0" value="{c:cell.color(address:'B2')}" />
            <c:item key="1" value="{c:cell.color(address:'B3')}" />
            <c:item key="2" value="{c:cell.color(address:'B4')}" />
            <c:item key="3" value="{c:cell.color(address:'B5')}" />                
        </c:data>
        
        <c:data id="hoverBackgroundColor">
            <c:item key="0" value="{c:cell.color(address:'B2', alpha:50)}" />
            <c:item key="1" value="{c:cell.color(address:'B3', alpha:50)}" />
            <c:item key="2" value="{c:cell.color(address:'B4', alpha:50)}" />
            <c:item key="3" value="{c:cell.color(address:'B5', alpha:50)}" />                
        </c:data>   
        
        <!-- Sets data and labels -->
        <c:data id="labels" values="{c:cell.range(range:'B2:B5')}" />  
        <c:data id="data" values="{c:cell.range(range:'D2:D5', formatData:true, search:{0:'%',1:','}, replace:{0:'',1:'.'})->c:transpose()}" />

        <c:data id="dataSets">
            <c:item key="0">
                <c:item key="data" value="{data__data.0}" />
                <c:item key="backgroundColor" value="{data__backgroundColor}" />
                <c:item key="hoverBackgroundColor" value="{data__hoverBackgroundColor}" />
            </c:item>
        </c:data>             

    </c:worksheet>
</c:spreadsheet>

<c:data id="barChartOptions">
    <c:item key="plugins">
        <c:item key="title">
            <c:item key="display" value="true" />
            <c:item key="text" value="{marker__title}" />
        </c:item>
        <c:item key="tooltip">
            <c:item key="backgroundColor">rgba(0,0,0,0.7)</c:item>
            <c:item key="callbacks">
                <c:callback key="label">
                    function(context) {
                        return context.formattedValue + '%';
                    }
                </c:callback>
            </c:item>
        </c:item>
    </c:item>
</c:data> 

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/barChartAdvanced.fluid
</c:template>

In this example, the range viewHelper retains the cell format.The arguments search and replace are used to search for the percent and comma signs, respectively replacing them with an empty space and a period. As previously explained, the data must be transposed.

The search and replace arguments behave exactly like the corresponding arguments in the PHP str_replace() function. They are used here as arrays. Here, they are used as arrays.

The bar chart colors are taker from the font color of the items.

Reference

Starting with version 14.5.0, SAV Charts is provided with two template parsers.

XML Parser Tags

XML parser is the historic parser developed for TYPO3 6.2. and later.

The general syntax for references is tag#id.

Fluid Parser ViewHelpers

Fluid parser is the new parser based on Fluid syntax.

The general syntax for references is tag__id. The value associated with the reference is obtained by the Fluid accessor {tag__id}.

XML Parser Tags

All tag attributes can take a value or be a reference to a specific tag. The allowed syntaxes are:

tag#id. The attribute value will be replaced by the tag whose ID is id (tags can be any allowed tag as marker, data, barChart...). See for example the provided template barCharts.xml in which there is the following line. The attribute value is replaced by the marker whose ID is labelSet1.
```
<item key="label" value="marker#labelSet1" />
```
Copied!
tag#id:integer1. The tag whose ID is id must be an array. The attribute value will be replaced by the item at the position given by integer1.
tag#id:integer1-integer2. The tag whose ID is id must be an array. The attribute value will be replaced by the sub-array starting at integer1 and ending at integer2.
for#id:value. The tag is replaced by the curent value of the attribute each in the <for> tag.
for#id:key. The tag is replaced by the curent key of the attribute each in the <for> tag.
tag#id:for#idFor:key. The tag whose ID is id must be an array. The attribute value will be replaced by the item at the position given by key of the current each attribute of the <for> tag whose ID is IdFor.
tag#id:for#idFor:value. The tag whose ID is id must be an array. The attribute value will be replaced by the item at the position given by value of the current each attribute of the <for> tag whose ID is IdFor.

Tip

Examples of such syntaxes can be found in the file Resources/Private/ChartsExamples/BarChartAdvanced.xml which builds a flexible template able to display upto 9 data sets with 9 different colors in the same charts as explained in the tutorial section.

Chart Tags

charts

<charts>...</charts>

Type: Root object
Description: Creates a charts object. The tag <charts> is the root xml element.

addItem

<addItem reference="object#id" key="myKey" value="myValue" />

Type

Root method

Description

Method associated with the root tag <charts> which adds an item in an array.

Attributes

reference (required): the object reference.
key (required): the key of the item in the array.
value(required): the value associated with the item.

exportCsv

<exportCvs reference="object#id" data="object#id" />

Type

Root method

Description

Method associated with the root tag <charts> which makes it possible to export data in the CSV format.

Attributes

reference (required): the object reference.
data (required): the reference to data.
rowHeader: if set, the reference to the row header.
columnHeader: if set, the reference to the column header.
encoding: if set, the encoding is used to convert the output. By default, the CSV output is converted to ISO-8859-1.

setId

<setId reference="object#id" newId="myNewId" />

Type

Root method

Description

Method associated with the root tag <charts> which makes it possible to change the id of the object given in the reference attribute.

Attributes

reference (required): the object reference.
newId (required): the new id.

barChart

<barChart id="myBarChartId" data="data#myBarChartData">...</barChart>

Type

Object

Description

Creates a bar chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

bubbleChart

<bubbleChart id="myBubbleChartId" data="data#myBubbleChartData">...</bubbleChart>

Type

Object

Description

Creates a buble chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

doughnutChart

<doughnutChart id="myDoughnutChartId" data="data#myDoughnutChartData">...</doughnutChart>

Type

Object

Description

Creates a doughnut chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

horizontalBarChart

<horizontalBarChart id="myhorizontalBarChartId" data="data#myhorizontalBarChartData">...</horizontalBarChart>

Type

Object

Description

Creates an horizontal bar chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

horizontalStackedBarChart

<horizontalStackedBarChart id="myhorizontalStackedBarChartId" data="data#myhorizontalStackedBarChartData">...</horizontalStackedBarChart>

Type

Object

Description

Creates an horizontal stacked bar chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

lineChart

<lineChart id="myLineChartId" data="data#myLineChartData">...</lineChart>

Type

Object

Description

Creates a doughnut chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

pieChart

<pieChart id="myPieChartId" data="data#myPieChartData">...</pieChart>

Type

Object

Description

Creates a pie chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

polarAreaChart

<polarAreaChart id="myPolarAreaChartId" data="data#myPolarAreaChartData">...</polarAreaChart>

Type

Object

Description

Creates a polar Area chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

radarChart

<radarChart id="myRadarChartId" data="data#myRadarChartData">...</radarChart>

Type

Object

Description

Creates a radar chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

scatterChart

<scatterChart id="myScatterChartId" data="data#myScatterChartData">...</radarChart>

Type

Object

Description

Creates a scatter chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

stackedBarChart

<stackedBarChart id="myStackedBarChartId" data="data#myStackedBarChartData">...</stackedBarChart>

Type

Object

Description

Creates a stacked bar chart object.

Attributes

id (required): the identifier.
data (required): a reference to the data used for the chart (in general a reference to a data object).
options: a reference to the options (in general a reference to a data object).
width: the canvas width. If this attribute is not provided, the default width is 400.
height: the canvas height. If this attribute is not provided, the default height is 300.

Data Tags

data

<data id="myDataId">5,6,7</data>

Type

Object

Description

Creates a data object from a comma separated list of data.

Attributes

id (required): the identifier.

It is equivalent to:

<data id="myDataId">
    <setData values="5,6,7"/>
</template>

setData

<setData values="5,6,7" />

Type

Default method

Description

Sets the values from a comma separated list of data.

Attributes

values (required): comma separated list of data.

callback

<callback key="callbackKey">callbackFileName.js</callback>
<callback key="callbackKey"><!-- JavaScript function --></callback>

Type

Method

Description

Defines a callback. The javacript function can be provided by means of a file name or inserted inserted inline inside an XML comment (see the FAQ section for an example).

Attributes

key (required): the key for the callback.

changeToPercentage

<changeToPercentage />

Type

Method

Description

Changes the data to percentage.

Attributes

precision: the precision for rounding floats (default value is 1).

item

<item key="myKey" value="tag#id" /> or
<item key="myKey" value="5" /> or
<item key="myKey" values="1, 3, 5" /> or
<item key="myKey">5</item>

Type

Method

Description

Sets a data item either by means of a reference, a value or a comma-separated list of values.

Attributes

key (required): the key for the item.
value: if set, the value is defined directly or by the reference, for example data#myDataId. If value is equal to true or false then a boolean value is generated for this item.
type: if this attribute is equal to function, the value attribute is taken as the name of a JavaScript function.
values: if set, a comma-sparated list of values is assumed.
if no value or values attribute is provided, the tag childs can be a value or other <item> tags.

setDataFromQuery

<setDataFromQuery query="myQueryId" field="fieldName" />

Type

Method

Description

Defines the data from a query.

Attributes

query (required): the query identifier.
field (required): the field to extract from the query result.
groupby: it set, either the size of the reference defined by the tag and the id, for example "data#myDataId", or the given integer, will be used to group the data. It means that an new array element will be generated each time the count is reached. This option is useful to display data when GROUP BY clause is used in the query.

setDataFromQueryRow

<setDataFromQueryRow query="myQueryId" fields="fieldName1, fieldName2, fieldName3" />

Type

Method

Description

Defines the data from the row of a query.

Attributes

query (required): the query identifier.
fields (required): the comma-separated list of fields to extract from the query row.

For Tags

for

<for each="data#myData">...</for>

Type

Object

Description

Repeats the sequence inside the tag for each element provided by means of the each attribute.

Attributes

each (required): the element for the repetition.

Marker Tags

marker

<marker id="myMarkerId">marker value</marker>

Type

Object

Description

Creates a marker object

Attributes

id (required): the identifier.

It is equivalent to:

<marker id="myMarkerId">
    <setMarker value="marker value"/>
</template>

setMarker

<setMarker value="marker value" />

Type

Default method

Description

Defines the marker.

Attributes

value (required): the value for the marker.

setMarkerByPieces

<setMarkerByPieces attribute1 .. AttributeN />

Type

Default method

Description

Defines the markerby concatenating the attributes.

Attributes

Any attribute name can be used. The resulting marker is the concatenation of all attribute values.

In the following exemple, the marker myMarkerId has the value Number of pages created per year.

<marker id="myMarkerId">
   <setMarkerByPieces part1="Number of " part2="pages created " part3="per year" />
</marker>

This method is useful when markers include information from a query, for example. In this case, a part is a reference to the data generated by the query.

Tip

Using \n in an attribute value generates a newline break.

Plugin Tags

plugin

<plugin chartId="myChart#id" key="pluginKey" fileName="pluginFileName" /">

Type: Object
Description: Loads the JavaScript file (see the FAQ section).
Attributes: chartId (required): the chart identifier.

- fileName (required): The file name of the JavaScript function.

Query Tags

query

<query id="myQueryId">...</query>

Type: Object
Description: Creates a query object.
Attributes: required): the identifier.

setQueryManager

<setQueryManager name="savcharts" uid="queryUid" marker1="myMarker" ... />

Type

Object

Description

Defines the query manager associated with the query.

Attributes

name (required): Unless you have define you own query manager, use savcharts.
uid (required): The uid of your query. Queries are defined in the backend.
other attributes define markers that can be used in the query clauses. In these clauses ###myMarker### will be replaced by the value of the marker myMarker. Any attribute name, except name and uid can be used.

Markers can be directly defined as, for example, myMarker#myValue. In that case, the marker name will be myMarker and its value is myValue.

Markers can be defined as a reference to a marker tag, for example marker#myMarker. In that case, the marker name will be myMarker and its value is the value of the marker whose id is myMarker.

Markers can also be defined as a reference to a specific element in a data or marker array, for example myMarker#data#myData:0. In that case, the marker name will be myMarker and its value is obtained from the data with index 0 and whose id is myData.

Template Tags

template

<template id="myTemplateId">yourFileName.xml</template>

Type

Object

Description

Loads the XML template file given inside the XML tag. The file name is relative to the site path.

Attributes

id (required): the identifier.

It is equivalent to:

<template id="myTemplateId">
   <loadTemplate fileName="yourFileName.xml"/>
</template>

loadTemplate

<loadTemplate fileName="yourFileName.xml"/>

Type

Default method

Description

Loads the XML template file given in the fileName attribute.

Attributes

fileName (required): the file name is relative to the site path.

Fluid Parser ViewHelpers

The general syntax for references is tag__id. The value associated with the reference is obtained by the Fluid accessor {tag__id}.

Cell ViewHelpers

BackgroundColor ViewHelper <c:cell.backgroundColor>

ViewHelper that returns the background color of a cell.

Go to the source code of this ViewHelper: BackgroundColorViewHelper.php (GitHub).

Arguments

The following arguments are available for the backgroundColor ViewHelper:

address

Required: true
Type: string

Address of the cell

alpha

Type: int [0..100]

If set, it modifies the transparency

Examples

Inline

<c:spreadsheet fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 
    <c:worksheet name="Example2">

        <c:data id="backgroundColor">
            <c:item key="0" value="{c:cell.backgroundcolor(address:'B14')}" />
        </c:data>
        
        <c:data id="hoverBackgroundColor">
            <c:item key="0" value="{c:cell.backgroundcolor(address:'B14', alpha:50)}" />
        </c:data>   
        
    </c:worksheet> 
</c:spreadsheet>

Color ViewHelper <c:cell.color>

ViewHelper that returns the font color of a cell.

Go to the source code of this ViewHelper: ColorViewHelper.php (GitHub).

Arguments

The following arguments are available for the color ViewHelper:

address

Required: true
Type: string

Address of the cell

alpha

Type: int [0..100]

If set, it modifies the transparency

Examples

Inline

<c:spreadsheet fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 
    <c:worksheet name="Example2">

        <c:data id="backgroundColor">
            <c:item key="0" value="{c:cell.color(address:'B2')}" />
        </c:data>
        
        <c:data id="hoverBackgroundColor">
            <c:item key="0" value="{c:cell.color(address:'B2', alpha:50)}" />
        </c:data>   
        
    </c:worksheet> 
</c:spreadsheet>

Range ViewHelper <c:cell.range>

ViewHelper that returns a range of cells.

Go to the source code of this ViewHelper: RangeViewHelper.php (GitHub).

Arguments

The following arguments are available for the range ViewHelper:

range

Required: true
Type: string

Range of cells

nullValue

Default: null
Type: mixed

Value returned in the array entry if a cell doesn't exist

calculateFormulas

Default: true
Type: boolean

If true, formulas are calculated

formatData

Default: false
Type: boolean

If true, formatting is applied to the cell values

returnCellRef

Default: false
Type: boolean

If false, it returns a simple array of rows and columns indexed by number counting from zero. If true, row and column IDs are kept

ignoreHidden

Default: false
Type: boolean

If false, values for rows/columns are returned even if they are defined as hidden

search

Default: null
Type: mixed

If formatData is true, it provides search string or array

replace

Default: null
Type: mixed

If formatData is true, it provides replacement string or array

Examples

Inline

<c:spreadsheet  fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 
    <c:worksheet name="Example2">

        <c:data id="labels" values="{c:cell.range(range:'B2:B5')}" />  
        <c:data id="data" values="{c:cell.range(range:'D2:D5', formatData:true, search:{0:'%',1:','}, replace:{0:'',1:'.'})->c:transpose()}" />

    </c:worksheet>
</c:spreadsheet>

Value ViewHelper <c:cell.value>

ViewHelper that returns the value of a cell.

Go to the source code of this ViewHelper: ValueViewHelper.php (GitHub).

Arguments

The following arguments are available for the value ViewHelper:

address

Required: true
Type: string

Address of the cell

Examples

Inline

<c:spreadsheet fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 
    <c:worksheet name="Example2">
        <c:marker id="title">{c:cell.value(address:'A2')}</c:marker>        
    </c:worksheet> 
</c:spreadsheet>

Chart ViewHelpers

Note

For compatibility with XML parser tags, all <c:chart.type> can also be called as <c:typeChart>. For example, <c:chart.bar> can be called <c:barChart>.

Bar ViewHelper <c:chart.bar>

ViewHelper to include a bar chart.

Go to the source code of this ViewHelper: BarViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a Bar Chart

<c:charts>
    <c:chart.bar id="1" data="data__barChartData" options="data__barChartOptions" >
        ...
    </c:chart.bar>
</c:charts>

Bar ViewHelper <c:chart.bubble>

ViewHelper to include a bubble chart.

Go to the source code of this ViewHelper: BubbleViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a Bubble Chart

<c:charts>
    <c:chart.bubble id="1" data="data__bubbleChartData" options="data__bubbleChartOptions" >
        ...
    </c:chart.bubble>
</c:charts>

Doughnut ViewHelper <c:chart.doughnut>

ViewHelper to include a doughnut chart.

Go to the source code of this ViewHelper: DoughnutViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a Doughnut Chart

<c:charts>
    <c:chart.doughnut id="1" data="data__doughnutChartData" options="data__doughnutChartOptions" >
        ...
    </c:chart.doughnut>
</c:charts>

HorizontalBar ViewHelper <c:chart.horizontalBar>

ViewHelper to include a horizontalBar chart.

Go to the source code of this ViewHelper: HorizontalBarViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a horizontalBar Chart

<c:charts>
    <c:chart.horizontalBar id="1" data="data__horizontalBarChartData" options="data__horizontalBarChartOptions" >
        ...
    </c:chart.horizontalBar>
</c:charts>

HorizontalStackedBar ViewHelper <c:chart.horizontalStackedBar>

ViewHelper to include a horizontalStackedBar chart.

Go to the source code of this ViewHelper: HorizontalStackedBarViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a horizontalStackedBar Chart

<c:charts>
    <c:chart.horizontalStackedBar id="1" data="data__horizontalStackedBarChartData" options="data__horizontalStackedBarChartOptions" >
        ...
    </c:chart.horizontalStackedBar>
</c:charts>

Pie ViewHelper <c:chart.line>

ViewHelper to include a line chart.

Go to the source code of this ViewHelper: LineViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a Line Chart

<c:charts>
    <c:chart.line id="1" data="data__lineChartData" options="data__lineChartOptions" >
        ...
    </c:chart.line>
</c:charts>

Pie ViewHelper <c:chart.pie>

ViewHelper to include a pie chart.

Go to the source code of this ViewHelper: PieViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a Pie Chart

<c:charts>
    <c:chart.pie id="1" data="data__pieChartData" options="data__pieChartOptions" >
        ...
    </c:chart.pie>
</c:charts>

PolarArea ViewHelper <c:chart.polarArea>

ViewHelper to include a polarArea chart.

Go to the source code of this ViewHelper: PolarAreaViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a PolarArea Chart

<c:charts>
    <c:chart.polarArea id="1" data="data__polarAreaChartData" options="data__polarAreaChartOptions" >
        ...
    </c:chart.polarArea>
</c:charts>

Radar ViewHelper <c:chart.radar>

ViewHelper to include a radar chart.

Go to the source code of this ViewHelper: RadarViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a Radar Chart

<c:charts>
    <c:chart.radar id="1" data="data__radarChartData" options="data__radarChartOptions" >
        ...
    </c:chart.radar>
</c:charts>

Scatter ViewHelper <c:chart.scatter>

ViewHelper to include a scatter chart.

Go to the source code of this ViewHelper: ScatterViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a Scatter Chart

<c:charts>
    <c:chart.scatter id="1" data="data__scatterChartData" options="data__scatterChartOptions" >
        ...
    </c:chart.scatter>
</c:charts>

StackedBar ViewHelper <c:chart.stackedBar>

ViewHelper to include a stackedBar chart.

Go to the source code of this ViewHelper: StackedBarViewHelper.php (GitHub).

Arguments

id

Required: true
Type: string

Chart ID

data

Required: true
Type: mixed

Data, or a reference to data

options

Required: true
Type: mixed

Options, or a reference to options

width

Type: string
Default: 600

Width value, or a reference to the width value

height

Type: string
Default: 400

Height value, or a reference to the height value

Examples

Defining a stackedBar Chart

<c:charts>
    <c:chart.stackedBar id="1" data="data__stackedBarChartData" options="data__stackedBarChartOptions" >
        ...
    </c:chart.stackedBar>
</c:charts>

Charts ViewHelper <c:charts>

Root ViewHelper to include charts.

Go to the source code of this ViewHelper: ChartsViewHelper.php (GitHub).

Arguments

The charts ViewHelper has no argument.

Examples

Defining a Bar Chart

<c:charts>
    <c:chart.bar id="1" data="data__barChartData" options="data__barChartOptions" >
        ...
    </c:chart.bar>
</c:charts>

Callback ViewHelper `<c:callback>`

ViewHelper that includes a JavaScript function.

Go to the source code of this ViewHelper: CallbackViewHelper.php (GitHub).

Arguments

The following arguments are available for the callback ViewHelper:

key

Required: true
Type: string

Callback key

fileName

Default: ''
Type: string

File name containing the JavaScript function

Examples

With fileName attribute

The JavaScript function must be in the given file name.

<c:item key="tooltip">
    <c:item key="callbacks">
        <c:callback key="label" fileName="EXT:sav_charts/Resources/Public/Callbacks/TooltipLabel.js" />
    </c:item>
</c:item>

Child nodes

The JavaScript function is provided in the child node.

<c:item key="tooltip">
    <c:item key="callbacks">
        <c:callback key="label">
            function(context) {
                return context.label + ' - ' + context.formattedValue + ' €';
            }
        </c:callback>        
    </c:item>            
</c:item>

Data ViewHelper <c:data>

ViewHelper which defines data.

Go to the source code of this ViewHelper: DataViewHelper.php (GitHub).

Arguments

The following arguments are available for the data ViewHelper:

id

Required: true
Type: string

Data ID

values

Type: mixed

Examples

With values attribute

<c:data id="size" values="12" />
<c:data id="columnHeader" values="{data__labels}" />

Child nodes

<c:data id="dataSets">
    <c:item key="0" value="{data__set0}" />
    <c:item key="1" value="{data__set1}" />
</c:data>

<c:data id="labels">
    January, February, March, April, May, June, July
</c:data>

Note

<c:data id="example1" values="A, B, C, D" />

is equivalent to

<f:variable name="data__example1" value="A, B, C, D" />

but

<c:data id="example2">A, B, C, D</c:data>

is equivalent to

        
<f:variable name="data__example2" value="{0:'A', 1:'B', 2:'C', 3:'D'}" />

ExportCsv ViewHelper `<c:exportCsv>`

ViewHelper that exports data in CSV format.

Go to the source code of this ViewHelper: ExportCsvViewHelper.php (GitHub).

Arguments

The following arguments are available for the exportCsv ViewHelper:

data

Required: true
Type: mixed

Data to export

fileName

Required: true
Type: string

File name to save the CSV in typo3temp/sav_charts

columnHeader

Type: array

Column header

rowHeader

Type: array

Row header

Examples

Exporting data with a column header

<c:data id="data">
      <c:item key="0" values="65, 59, 80, 81, 56, 55, 40" />
      <c:item key="1"values="1.5, 3, 5, 10, 17, 20, 24" />  
</c:data>

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/HorizontalBarChartAdvanced.fluid
</c:template>

         
<c:exportCSV fileName="Export_1.csv" columnHeader="{data__labels}" data="{data__data}" />

Exporting data with a column header and a row header

<c:marker id="labelSet0">Humidity</c:marker>
<c:marker id="labelSet1">Temperature</c:marker>

<c:exportCSV fileName="Export_2.csv" rowHeader="{0:'', 1:marker__labelSet0, 2:marker__labelSet1}" columnHeader="{data__labels}" data="{data__data}" />

Exporting transposed data with a column header

<c:exportCSV fileName="Export_3.csv" columnHeader="{0:marker__labelSet0, 1:marker__labelSet1}" data="{data__data->c:transpose()}" />

Item ViewHelper <c:item>

ViewHelper which defines items.

Go to the source code of this ViewHelper: ItemViewHelper.php (GitHub).

Arguments

The following arguments are available for the item ViewHelper:

key

Required: true
Type: string

Item key

value

Type: mixed

Item value

values

Type: string

Item comma-separated values

Examples

With values attribute

<c:data id="data">
    <item key="0" values="1, 6, 8, 3" />
    <item key="1" values="2, 4,10, 5" />
</c:data>

With value attribute

<c:data id="data">
    <c:item key="0" value="{data__set0}" />
    <c:item key="1" value="{data__set1}" />
</c:data>

Child nodes

<c:data id="lowIntensityColors">
    <c:item key="0">rgba(77, 77, 77, 0.2)</c:item>
    <c:item key="1">rgba(93, 165, 218, 0.2)</c:item>
    <c:item key="2">rgba(250, 164, 58, 0.2)</c:item>
</c:data>

<c:data id="lineChartOptions">
    <c:item key="scales"> 
        <c:item key="y">
            <c:item key="max" value="100" /> 
            <c:item key="min" value="10" />
            <c:item key="ticks">      
                <c:item key="stepSize" value="5" />
            </c:item>
        </c:item>
         <c:item key="x">
            <c:item key="ticks">
                 <c:item key="font">
                       <c:item key="size" value="15" />
                       <c:item key="style" value="italic" />
                 </c:item>
                 <c:item key="color" value="rgb(200, 0, 0)" />
                 <c:callback key="callback">
                    function(value, index, values) {
                        return '- ' + this.getLabelForValue(value) + ' -';
                    }
                 </c:callback>
              </c:item>
        </c:item>
    </c:item>
</c:data>

Marker ViewHelper <c:marker>

ViewHelper that defines markers.

Go to the source code of this ViewHelper: MarkerViewHelper.php (GitHub).

Arguments

The following arguments are available for the marker ViewHelper:

id

Required: true
Type: string

Marker ID

value

Type: string

Marker value

reload

Default: false
Type: boolean

If true, the marker is reloaded if it exists

Examples

With value attribute

<c:marker id="width" value="600" />

Child nodes -----------

<c:marker id="width">600</c:marker>

Template ViewHelper `<c:plugin>`

ViewHelper that includes a plugin.

Go to the source code of this ViewHelper: PluginViewHelper.php (GitHub).

Arguments

The following arguments are available for the plugin ViewHelper:

chartId

Required: true
Type: string

key

Required: true
Type: string

Plugin key

fileName

Default: ''
Type: string

File name containing the JavaScript function

Examples

The following examples should be included in the "Templates" field of the "Fluid Parser" tab of the plugin.

With fileName attribute

<c:plugin chartId="pie__1" key="chartAreaBorder" fileName="EXT:sav_charts/Resources/Public/Plugins/ChartAreaBorder.js" />

Child nodes

The JavaScript function is directly inserted in the child.

<c:plugin chartId="pie__1" key="chartAreaBorder">
    beforeDraw(chart, args, options) {
        const { 
            ctx, 
            chartArea: { left, top, width, height } 
        } = chart;
    
        ctx.save();
        ctx.strokeStyle = options.borderColor;
        ctx.lineWidth = options.borderWidth;
        ctx.setLineDash(options.borderDash || []);
        ctx.lineDashOffset = options.borderDashOffset;
        ctx.strokeRect(left, top, width, height);
        ctx.restore();
    }
</c:plugin>

Query ViewHelper <c:query>

ViewHelper which defines queries.

Go to the source code of this ViewHelper: QueryViewHelper.php (GitHub).

Arguments

The following arguments are available for the query ViewHelper:

id

Required: true
Type: string

Query ID

manager

Type: string

Query manager

uid

Type: string

UID of the query record

Note

The query will only be processed if the manager and UID arguments are provided. These arguments are not defined as required for compatibility with the XML parser.

Example

<c:query id="1"  manager="savcharts" uid="1" />    

<c:data id="labels" values="{query__1.Year}" />
<c:data id="data">
      <c:item key="0" value="{query__1.Count}" />
</c:data>

Spreadsheet ViewHelper <c:spreadsheet>

ViewHelper that defines the spreadsheet to use.

Go to the source code of this ViewHelper: SpreadsheetViewHelper.php (GitHub).

Arguments

The following arguments are available for the spreadsheet ViewHelper:

fileName

Required: true
Type: string

Spreadsheet file name

Examples

<c:spreadsheet fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 

</c:spreadsheet>

Template ViewHelper `<c:template>`

ViewHelper that includes a SAV Charts template.

Go to the source code of this ViewHelper: TemplateViewHelper.php (GitHub).

Arguments

The following arguments are available for the template ViewHelper:

id

Required: true
Type: string

Template id.

fileName

Default: ''
Type: string

File name containing the template

Examples

The following examples should be included in the "Templates" field of the "Fluid Parser" tab of the plugin.

With fileName attribute

<c:template id="1" fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/BarChart.fluid" />

Child nodes

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/BarChart.fluid
</c:template>

Transpose ViewHelper <c:transpose>

ViewHelper that transposes data.

Go to the source code of this ViewHelper: TransposeViewHelper.php (GitHub).

Arguments

The following arguments are available for the transpose ViewHelper:

data

Required: true
Type: array

Data to transpose

Examples

With data attribute

<c:data id="data">
    <c:item key="0" values="65, 59, 80, 81, 56, 55, 40" />
    <c:item key="1"values="1.5, 3, 5, 10, 17, 20, 24" />  
</c:data>

<f:variable name="tranposedData"><c:transpose data="{data__data}" /></f:variable>

Inline

<c:data id="data">
    <c:item key="0" values="65, 59, 80, 81, 56, 55, 40" />
    <c:item key="1"values="1.5, 3, 5, 10, 17, 20, 24" />  
</c:data>

<f:variable name="tranposedData" value="{data__data->c:transpose()}" />

Worksheet ViewHelper <c:worksheet>

ViewHelper that defines the worksheet to use in a spreadsheet.

Go to the source code of this ViewHelper: WorksheetViewHelper.php (GitHub).

Arguments

The following arguments are available for the worksheet ViewHelper:

name

Required: true
Type: string

Worksheet name

Examples

<c:spreadsheet fileName="EXT:sav_charts/Resources/Private/Templates/ChartsExamples/Spreadsheet.xlsx"> 
    <c:worksheet name="Example2">
    
    </c:worksheet> 
</c:spreadsheet>

Frequently Asked Questions

Warning

SAV Charts is now using Chart.js 4.x. Several breaking changes were made in Chart.js 3.0 and Chart.js 4.0 (see 3.x Migration Guide and 4.x Migration Guide). All templates in Resources/Private/Templates/ChartsExamples were modified to take these changes into consideration.

If you are upgrading Sav Charts, you may have to modify your templates.

How to Generate a Boolean Value?

Set the attribute value to true or false.

<data id="barChartOptions">
    <item key="animation" value="false" />
    <item key="responsive" value="false" />
    <item key="plugins">
        <item key="title">
            <item key="display" value="true" />
            <item key="text" value="marker#title" />
        </item>
        <item key="tooltip">
            <item key="backgroundColor">rgba(0,0,0,0.7)</item>
        </item>
    </item>                        
</data>

<c:data id="barChartOptions">
    <c:item key="animation" value="false" />
    <c:item key="responsive" value="false" />
    <c:item key="plugins">
        <c:item key="title">
            <c:item key="display" value="true" />
            <c:item key="text" value="{marker__title}" />
        </c:item>
        <c:item key="tooltip">
            <c:item key="backgroundColor">rgba(0,0,0,0.7)</c:item>
        </c:item>
    </c:item>                        
</c:data>

How to Set the y-Axis Properties?

You can change the default y-axis (or x-axis) properties using the options for the chart. For example, assume that the y-axis for the lineChart example has to be changed so that the minimum is 10, the maximum is 100 and the step is 5.

Add the following configuration in the data section or in your template.

<data id="lineChartOptions">
    <item key="scales"> 
        <item key="y">
            <item key="max" value="100" />
            <item key="min" value="10" />
            <item key="ticks">   
                <item key="stepSize" value="5" />
            </item>
        </item>
    </item>
</data>

<c:data id="lineChartOptions">
    <c:item key="scales"> 
        <c:item key="y">
            <c:item key="max" value="100" />
            <c:item key="min" value="10" />
            <c:item key="ticks">   
                <c:item key="stepSize" value="5" />
            </c:item>
        </c:item>
    </c:item>
</c:data>

Save, clear the cache and go to the front-end.

Tip

You can easily adapt the previous configuration to other cases by translating the JavaScript configuration examples given in the Charts.js documentation.

The translation is simple:

Replace options by a <data id="..."> ... </data> where the id is the identifier for the chart options (it is defined in the template).
Replace opening braces by <item> tags with attributes as keys.
Replace open brackets, if any, by <item> tags with keys equal to 0.
Replace simple attributes inside braces by <item /> tags with key and value attributes.
Replace closing braces or brackets by </item> tags.

Replace options by a <c:data id="..."> ... </c:data> where the id is the identifier for the chart options (it is defined in the template).
Replace opening braces by <c:item> tags with attributes as keys.
Replace open brackets, if any, by <c:item> tags with keys equal to 0.
Replace simple attributes inside braces by <c:item /> tags with key and value attributes.
Replace closing braces or brackets by </c:item> tags.

For example, the following code changes also the label style of the x-axis. A callback is used to modify the tick labels.

<data id="lineChartOptions">
    <item key="scales"> 
        <item key="y">
            <item key="max" value="100" /> 
            <item key="min" value="10" />
            <item key="ticks">      
                <item key="stepSize" value="5" />
            </item>
        </item>
        <item key="x">
            <item key="ticks">
                <item key="font">
                    <item key="size" value="15" />
                    <item key="tyle" value="italic" />
                </item>
                <item key="color" value="rgb(200, 0, 0)" />
                <callback key="callback">
                    <!--
                    function(value, index, values) {
                        return '- ' + this.getLabelForValue(value) + ' -';
                    }
                    -->
                </callback>
            </item>
        </item>
    </item>
</data>

Note

The JavaScript function must be in an XML comment.

<c:data id="lineChartOptions">
    <c:item key="scales"> 
        <c:item key="y">
            <c:item key="max" value="100" /> 
            <c:item key="min" value="10" />
            <c:item key="ticks">      
                <c:item key="stepSize" value="5" />
            </c:item>
        </c:item>
        <c:item key="x">
            <c:item key="ticks">
                <c:item key="font">
                    <c:item key="size" value="15" />
                    <c:item key="tyle" value="italic" />
                </c:item>
                <c:item key="color" value="rgb(200, 0, 0)" />
                <c:callback key="callback">
                    function(value, index, values) {
                        return '- ' + this.getLabelForValue(value) + ' -';
                    }
                </c:callback>
            </c:item>
        </c:item>
    </c:item>
</c:data>

Note

In Chart.js 3.0 , the former xAxes and yAxes arrays in scales were removed.

How to Modify the Tooltip Format?

The tooltip format can be modified using callbacks that are provided with Chart.js. For example let us assume that data provided with the Pie Chart example are in €. Let us also assume that we want to change the tiptool content in order to have label - value € instead of the defaut format label:value.

Chart.js library allows to modify several behaviors by means of callbacks. Please consult the Chart.js documentation for details.

The tooltip label can been changed by means of the label callback in tooltip options.

Inline JavaScript Function

Add the following configuration in the data section or in your template.

<data id="pieChartOptions">
    <item key="plugins">
        <item key="tooltip">
            <item key="callbacks">
                <callback key="label">
                    <!--
                    function(context) {
                        return context.label + ' - ' + context.formattedValue + ' €';
                    }
                    -->
                </callback>
            </item>
        </item>
    </item>   
</data>

Note

The JavaScript function must be in an XML comment.

<c:data id="pieChartOptions">
    <c:item key="plugins">
        <c:item key="tooltip">
            <c:item key="callbacks">
                <c:callback key="label">
                    function(context) {
                        return context.label + ' - ' + context.formattedValue + ' €';
                    }
                </c:callback>
            </c:item>
        </c:item>
    </c:item>   
</c:data>

Save, clear the cache and go to the front-end.

The configuration is simply the translation of the following JavaScript configuration.

    
options: {
    plugins: { 
        tooltip: {
            callbacks: {
                label: function(context) {
                    return context.label + ' - ' + context.formattedValue + ' €';
                }
            }
        }
    }
}

Note

In Chart.js 3.0 tooltips was renamed tooltip and is now in the plugins item of the options. A tooltip item context is avaible in callbacks. For more information see the tooltip section in Chart.js documentation.

JavaScript Function in a File

When the JavaScript function associated with the callback is more complex, you can also put it in a file and call that file in the callback as shown in the following configuration.

<data id="pieChartOptions">
    <item key="plugins">
        <item key="tooltip">
            <item key="callbacks">
                <callback key="label">
                    EXT:sav_charts/Resources/Public/Callbacks/TooltipLabel.js                                
                </callback>
            </item>
        </item>
    </item>   
</data>

<c:data id="pieChartOptions">
    <c:item key="plugins">
        <c:item key="tooltip">
            <c:item key="callbacks">
                <c:callback key="label">
                    EXT:sav_charts/Resources/Public/Callbacks/TooltipLabel.js                                
                </c:callback>
            </c:item>
        </c:item>
    </c:item>   
</c:data>

How to call a JavaScript Function on Events?

The following configuration shows how to associate the JavaScript function newLegendClickHandler with the onClick event of the legend.

<data id="barChartOptions">
    <item key="plugins">
        <item key="legend">
            <item key="onClick" type="function" value="newLegendClickHandler" />
        </item> 
    </item>                        
</data>  

<template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/BarChart.xml
</template>

<c:data id="barChartOptions">
    <c:item key="plugins">
        <c:item key="legend">
            <c:callback key="onClick">newLegendClickHandler</c:callback>
        </c:item> 
    </c:item>                        
</c:data> 

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/BarChart.fluid
</c:template>

The function newLegendClickHandler is available in ResourcesPublicCallbacksNewLegendClickHandler.js and must be inserted by TypoScript.

page.includeJSFooter{
    newLegendClickHandler = EXT:sav_charts/Resources/Public/Callbacks/NewLegendClickHandler.js
}

Open the console and click on the chart legend.

How to Create a Combination Chart?

An example which combines a bar chart and a line chart is provided in the directory Resources/Private/Templates/ChartsExamples. Create a new graph then, in the template section, enter the following code, save and go to the front-end.

<template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/ComboChart.xml
</template>

<c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/ComboChart.xml
</c:template>

The file ComboChart.xml is very similar to the file BarChart.xml. Only slight changes were made. The type attribute of the second dataset is set to line and the fill attribute to false.

<data id="set1">
    <item key="type">line</item>
    <item key="fill" value="false"/>
        ...
</data>

<c:data id="set1">
    <c:item key="type">line</c:item>
    <c:item key="fill" value="false"/>
        ...
</c:data>

The value for the type attribute of each chart is given in the Chart.js documentation.

How to use Plugins?

A plugin to draw a border around the chart is available in ResourcesPublicPluginsCharAreaBorder.js.

<plugin chartId="pieChart#1" key="chartAreaBorder" fileName="EXT:sav_charts/Resources/Public/Plugins/ChartAreaBorder.js" />

<data id="pieChartOptions">
  <item key="plugins">
    <item key="chartAreaBorder">
      <item key="borderColor">red</item>
      <item key="borderWidth">2</item>
    </item>
  </item>
</data>
  
<template id="1">
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/PieChart.xml
</template>

<c:plugin chartId="pie__1" key="chartAreaBorder" fileName="EXT:sav_charts/Resources/Public/Plugins/ChartAreaBorder.js" />

<c:data id="pieChartOptions">
  <c:item key="plugins">
    <c:item key="chartAreaBorder">
      <c:item key="borderColor">red</c:item>
      <c:item key="borderWidth">2</c:item>
    </c:item>
  </c:item>
</c:data>

<c:template id="1"> 
    EXT:sav_charts/Resources/Private/Templates/ChartsExamples/FluidParser/PieChart.fluid
</c:template>

Note

The argument chartId is pie__1 if you use <c:chart.pie>. It becomes pieChart__1 if you use <c:pieChart> (a viewHelper for compatibility with the XML parser).

Entity Relationship Diagram

The Entity Relationship Diagram is generated by the SAV Library Kickstarter in Graphviz DOT language and included using PlantUML.

New tables with their fields are represented with a Black border.
Existing tables are represented with a Dark green border. Only existing fields uid and pid are shown. If new fields are created, they are shown in Light blue.
1-n relations are in Dark blue.
n-n relationships are in Dark red with the name of the associated mm table.

Changelog

Version	Changes
14.6.0	ViewHelpers to use spreadsheets added.
14.5.0	New parser based on Fluid and viewHelpers added. Version of Chart.js changed to 4.5.1.
14.4.0	Compatibility changed to TYPO3 13.4.x and 14.3.x.
13.4.0	Compatibility changed to TYPO3 12.4.x and 13.4.x. Version of Chart.js changed to 4.4.5.
11.5.0	Compatibility changed to TYPO3 11.5.x. Version of Chart.js changed to 3.6.0.
11.2.0	Compatibility changed to TYPO3 11.2.x. Version of Chart.js changed to 3.2.1. Scatter graph added with example. Combination graph example added.
10.4.0	Compatibility changed to TYPO3 10.4.x.
10.3.0	Compatibility changed to TYPO3 10.3.x. Version of Chart.js changed to 2.9.3. True or false values and use of functions outside callbacks added (issue #1).
9.5.0	Version of Chart.js changed to 2.9.2. Compatibility changed to TYPO3 9.5.x. Documentation updated to docker.
0.5.0	Version of Chart.js changed to 2.7.0. Compatibility to TYPO3 6.2 removed. Compatibility changed to TYPO3 9.0.
0.4.0	Version of Chart.js changed to 2.7.0. composer.json added. Vendor name changed.
0.3.2	Default type for stacked option changed to boolean.
0.3.1	Small bug corrected in the use of file callback functions (thanks to Holger Birkner for reporting this bug).
0.3.0	Processing of callback functions and plugins added. Documentation updated. Version of Chart.js changed to 2.5.0.
0.2.1	Documentation updated. Version of Chart.js changed to 2.4.0. Compatibility changed to TYPO3 8.9.
0.2.0	BeginAtZero becomes the default option for line charts. Subitems may contain data items like setDataFromQuery. New templates added for horizontal bar charts, horizontal stacked bar charts and bubble bar charts. Compatibility changed to TYPO3 8.3. Version of Chart.js changed to 2.2.2
0.1.0	SAV Charts modified for Version 2.1.6 of Chart.js Advanced templates added.
0.0.2	Small changes to remove the use of deprecated methods. Compatibility changed to TYPO3 8.0.
0.0.1	1st public release.

SAV Charts

Table of Contents

Introduction

What Does it Do?

Screenshots

Bar Chart

Bubble Chart

Doughnut Chart

Horizontal Bar Chart

Horizontal Stacked Bar Chart

Line Chart

Pie Chart

Polar Area Chart

Radar Chart

Scatter Chart

Stacked Bar Chart

Combination Chart

Chart built from a Spreadsheet

Sponsoring

Users Manual

Administration

Tutorials

Plugin Interface

Parsers

Table of Contents

Designing Templates From Examples

Introduction

Writing Templates

Overloading Data

Overloading Markers

Options

Using Advanced Templates

Using and Developing Query Managers

Using the Query Manager

Using Markers in Queries

Developing Your Query Manager

Exporting Data in CSV

Converting Basic XML Templates to Fluid Templates

Introduction

Converting Advanced XML Templates to Fluid Templates

Including Charts in HTML Templates

Using Spreadsheets

Line Chart from Worksheet

Pie Chart from Values in Worksheet

Pie Chart from Percentages in Worksheet

Bar Chart from Percentages in Worksheet

Reference

XML Parser Tags

Table of Contents

Chart Tags

charts

addItem

exportCsv

setId

barChart

bubbleChart

doughnutChart

horizontalBarChart

horizontalStackedBarChart

lineChart

pieChart

polarAreaChart

radarChart

scatterChart

stackedBarChart

Data Tags

data

setData

callback

changeToPercentage

item

setDataFromQuery

setDataFromQueryRow

For Tags

for

Marker Tags

marker

setMarker

setMarkerByPieces

Plugin Tags