Doughnut Chart Widget

class DoughnutChartWidget

Fully qualified name: \TYPO3\CMS\Dashboard\Widgets\DoughnutChartWidget

Widgets using this class will show a doughnut chart with the provided data.

This kind of widgets are useful if you want to show the relational proportions between data.

Doughnut chart widget with the proportion of normal and admin users — The widget "Type of backend users" shipped with the dashboard extension is a doughnut chart widget.

Example

Excerpt from EXT:dashboard/Configuration/Services.yaml

services:
 dashboard.widget.typeOfUsers:
    class: 'TYPO3\CMS\Dashboard\Widgets\DoughnutChartWidget'
    arguments:
      $dataProvider: '@TYPO3\CMS\Dashboard\Widgets\Provider\TypeOfUsersChartDataProvider'
      $options:
         refreshAvailable: true
    tags:
      - name: dashboard.widget
        identifier: 'typeOfUsers'
        groupNames: 'systemInfo'
        title: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.typeOfUsers.title'
        description: 'LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.typeOfUsers.description'
        iconIdentifier: 'content-widget-chart-pie'
        height: 'medium'

Options

refreshAvailable

Type: boolean
Default: false

Boolean value, either false or true.

Provides a refresh button to backend users to refresh the widget. If the option is omitted false is assumed.

Dependencies

$dataProvider

Type: \TYPO3\CMS\Dashboard\Widgets\ChartDataProviderInterface

To add data to a Bar Chart widget, you need to have a DataProvider that implements the interface ChartDataProviderInterface.

See Implement graph widget for further information.

$buttonProvider

Type: \TYPO3\CMS\Dashboard\Widgets\ButtonProviderInterface

Optionally you can add a button with a link to some additional data. This button should be provided by a ButtonProvider that implements the interface ButtonProviderInterface.

See Adding button to Widget for further info and configuration options.