.. include:: /Includes.rst.txt .. _doughnut-chart-widget: ===================== Doughnut Chart Widget ===================== .. php:namespace:: TYPO3\CMS\Dashboard\Widgets .. php:class:: 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-example: Example ------- .. code-block:: yaml :caption: 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' .. _doughnut-chart-widget-options: Options ------- .. include:: Options/RefreshAvailable.rst.txt .. _doughnut-chart-widget-dependencies: Dependencies ------------ .. confval:: $dataProvider :type: :php:`\TYPO3\CMS\Dashboard\Widgets\ChartDataProviderInterface` :name: doughnut-chart-widget-dataProvider To add data to a Bar Chart widget, you need to have a DataProvider that implements the interface :php-short:`\TYPO3\CMS\Dashboard\Widgets\ChartDataProviderInterface`. See :ref:`graph-widget-implementation` for further information. .. confval:: $buttonProvider :type: :php:`\TYPO3\CMS\Dashboard\Widgets\ButtonProviderInterface` :name: doughnut-chart-widget-buttonProvider 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 :php-short:`\TYPO3\CMS\Dashboard\Widgets\ButtonProviderInterface`. See :ref:`adding-buttons` for further info and configuration options.