..  include:: ../../../../Includes.txt

..  _apexchart.gaugeViewHelper:

:navigation-title: apexchart.gauge

====================================
Gauge ViewHelper <c:apexchart.gauge>
====================================

ViewHelper to include a gauge chart with `ApexCharts`.

Go to the source code of this ViewHelper: 
`GaugeViewHelper.php
<https://github.com/YolfTypo3/SavCharts/blob/main/Classes/ViewHelpers/ApexChart/GaugeViewHelper.php>`_ (GitHub). 

Quick Test
==========

..  code-block:: xml 
    
    <c:template id="1">
    EXT:sav_charts/Resources/Private/Templates/ApexChartsExamples/GaugeChart.fluid"
    </c:template>

..  figure:: ../../../../Images/ScreenShots/ApexCharts/gaugeChart.png
    :width: 40%  

Arguments
=========

..  confval:: id
    :name: apexchart.gaugeId
    :Type: string
    :required: true
    
    Chart ID    
    
..  confval:: options
    :name: apexchart.gaugeOptions
    :Type: mixed
    :required: true
    
    Options, or a reference to options    
    
..  confval:: width
    :name: apexchart.gaugeWidth
    :Type: string
    :Default: 600

    Width value, or a reference to the width value
        
..  confval:: height
    :name: apexchart.gaugeHeight
    :Type: string
    :Default: 400

    Height value, or a reference to the height value

Examples
========

Defining a Gauge Chart
-----------------------

..  code-block:: xml    

    <c:apexcharts>
        <c:apexchart.gauge id="1" options="data__gaugeChartOptions" >
            ...
        </c:apexchart.gauge>
    </c:apexcharts>