Public Member Functions
	__construct ($id, $width=300, $height=300, $value=0, $label='', $palette="standard")

	setSize ($width, $height)

	setContainerSize ($width, $height="0")

	setCenter ($cx, $cy)

	setRadius ($r)

	setLabelSize ($size, $targetLabelSize="inherit")

	setLabelPosition ($lx, $ly)

	setRange ($min, $max)

	setColorRange ($min, $max=null)

	setStrokeWidth ($s)

	setFontFamily ($font)

	showTarget ($target, $targetLabel)

	draw ()

Public Attributes
	$width

	$height

	$containerWidth

	$containerHeight

	$cx

	$cy

	$radius = 0

	$value = 0

	$label = ""

	$palette

	$labelSize = 12

	$labelX

	$labelY

	$strokeWidth = 1

	$animate = true

	$shadow = true

	$scaleToFit = false

	$fontFamily = 'Arial, Helvetica'

	$min = 0

	$max = 100

	$minColor = '#f00'

	$maxColor = '#0f0'

	$colorMode = 'fixed'

	$showTarget = false

	$target = 0

	$targetLabel = ""

	$targetLabelSize = "inherit"

	$cssClass = null

	$onDrawChart = "null"

	$onDrawChartComplete = "null"

	$onDrawLegend = "null"

	$onDrawLegendComplete = "null"

Detailed Description

Definition at line 41 of file dial.inc.

Constructor & Destructor Documentation

◆ __construct()

Dial::__construct	(	$id,
		$width = `300`,
		$height = `300`,
		$value = `0`,
		$label = `''`,
		$palette = `"standard"`
	)

Definition at line 76 of file dial.inc.

      {
           $this->id = $id;
           $this->setSize($width, $height);
           $this->setContainerSize($width, $height);
           $this->value = $value;
           $this->label = $label;
           $this->palette = $palette;
      }

Member Function Documentation

◆ draw()

Dial::draw ( )

Definition at line 167 of file dial.inc.

      {
           global $script;
           $animate = $this->animate ? "true" : "false";
           $shadow = $this->shadow ? "true": "false";
           $legend = $this->legend ? "true" : "false";
           $percentages = $this->showPercentages ? "true" : "false";
           $download = $this->enableDownload ? "true" : "false";
           $showTarget = $this->showTarget ? "true" : "false";
           $targetLabel = jsSafe($this->targetLabel);
           $target = ($this->target == '') ? 0 : $this->target;
           
           $containerWidth = is_numeric($this->containerWidth) ? $this->containerWidth . "px" : $this->containerWidth;
           $containerHeight = is_numeric($this->containerHeight) ? $this->containerHeight . "px" : $this->containerHeight;
  
           $script .= <<<ENDSCRIPT
 <script type="text/javascript">
 window.addEvent('domready', function ()
 {
      var {$this->id} = new Dial('{$this->id}', $this->value, '{$this->label}', 
      {
           width: {$this->width},
           height: {$this->height},
           cx: {$this->cx},
           cy: {$this->cy},
           radius: {$this->radius},
           palette: '{$this->palette}',
           labelSize: {$this->labelSize},
           labelx: {$this->labelX},
           labely: {$this->labelY},
           fontFamily: '{$this->fontFamily}',
           strokeWidth: {$this->strokeWidth},
           animate: {$animate},
           shadow: {$shadow},
           enableDownload: {$download},
           min: {$this->min},
           max: {$this->max},
           minColor: '{$this->minColor}',
           maxColor: '{$this->maxColor}',
           colorMode: '{$this->colorMode}',
           showTarget: {$showTarget},
           target: {$target},
           targetLabel: '{$targetLabel}',
           targetLabelSize: '{$this->targetLabelSize}',
           onDrawChart: {$this->onDrawChart},
          onDrawChartComplete: {$this->onDrawChartComplete},
          onDrawLegend: {$this->onDrawLegend},
           onDrawLegendComplete: {$this->onDrawLegendComplete}
      });
  
      {$this->id}.draw();
 });
 </script>
 ENDSCRIPT;
  
           if ($this->scaleToFit)
           {
                $dimensions = "width: 100%; height: auto";
           }
           else
           {
                $dimensions = "width: {$containerWidth}; height: {$containerHeight};";
           }
      
           $cssClass = ($this->cssClass) ? " class='{$this->cssClass}'" : "";
           echo "<div id='{$this->id}'{$cssClass} style='$dimensions'></div>";
      }

◆ setCenter()

Dial::setCenter	(	$cx,
		$cy
	)

Definition at line 101 of file dial.inc.

      {
           $this->cx = $cx;
           $this->cy = $cy;
      }

◆ setColorRange()

Dial::setColorRange	(	$min,
		$max = `null`
	)

Definition at line 130 of file dial.inc.

      {
           if (!$max) 
           {
                $max = $min;
           }
           
           if ($max == $min)
           {
                $this->colorMode = 'fixed';
           }
           else
           {
                $this->colorMode = 'interpolated';
           }
           
           $this->minColor = $min;
           $this->maxColor = $max;
      }

◆ setContainerSize()

Dial::setContainerSize	(	$width,
		$height = `"0"`
	)

Definition at line 95 of file dial.inc.

      {
           $this->containerWidth = $width;
           $this->containerHeight = $height;
      }

◆ setFontFamily()

Dial::setFontFamily ( $font )

Definition at line 155 of file dial.inc.

      {
           $this->fontFamily = $font;
      }

◆ setLabelPosition()

Dial::setLabelPosition	(	$lx,
		$ly
	)

Definition at line 118 of file dial.inc.

      {
           $this->labelX = $lx;
           $this->labelY = $ly;
      }

◆ setLabelSize()

Dial::setLabelSize	(	$size,
		$targetLabelSize = `"inherit"`
	)

Definition at line 112 of file dial.inc.

      {
           $this->labelSize = $size;
           $this->targetLabelSize = $targetLabelSize;
      }

◆ setRadius()

Dial::setRadius ( $r )

Definition at line 107 of file dial.inc.

      {
           $this->radius = $r;
      }

◆ setRange()

Dial::setRange	(	$min,
		$max
	)

Definition at line 124 of file dial.inc.

      {
           $this->min = $min;
           $this->max = $max;
      }

◆ setSize()

Dial::setSize	(	$width,
		$height
	)

Definition at line 86 of file dial.inc.

      {
           $this->width = $width;
           $this->height = $height;
           if (!$this->cx) $this->cx = $this->width / 2;
           if (!$this->cy) $this->cy = $this->height / 2;
           if (!$this->radius) $this->radius = min($width, $height) * .4;
      }

◆ setStrokeWidth()

Dial::setStrokeWidth ( $s )

Definition at line 150 of file dial.inc.

      {
           $this->strokeWidth = $s;
      }

◆ showTarget()

Dial::showTarget	(	$target,
		$targetLabel
	)

Definition at line 160 of file dial.inc.

      {
           $this->showTarget = true;
           $this->target = $target;
           $this->targetLabel = $targetLabel;
      }

Member Data Documentation

◆ $animate

Dial::$animate = true

Definition at line 57 of file dial.inc.

◆ $colorMode

Dial::$colorMode = 'fixed'

Definition at line 65 of file dial.inc.

◆ $containerHeight

Dial::$containerHeight

Definition at line 46 of file dial.inc.

◆ $containerWidth

Dial::$containerWidth

Definition at line 45 of file dial.inc.

◆ $cssClass

Dial::$cssClass = null

Definition at line 70 of file dial.inc.

◆ $cx

Dial::$cx

Definition at line 47 of file dial.inc.

◆ $cy

Dial::$cy

Definition at line 48 of file dial.inc.

◆ $fontFamily

Dial::$fontFamily = 'Arial, Helvetica'

Definition at line 60 of file dial.inc.

◆ $height

Dial::$height

Definition at line 44 of file dial.inc.

◆ $label

Dial::$label = ""

Definition at line 51 of file dial.inc.

◆ $labelSize

Dial::$labelSize = 12

Definition at line 53 of file dial.inc.

◆ $labelX

Dial::$labelX

Definition at line 54 of file dial.inc.

◆ $labelY

Dial::$labelY

Definition at line 55 of file dial.inc.

◆ $max

Dial::$max = 100

Definition at line 62 of file dial.inc.

◆ $maxColor

Dial::$maxColor = '#0f0'

Definition at line 64 of file dial.inc.

◆ $min

Dial::$min = 0

Definition at line 61 of file dial.inc.

◆ $minColor

Dial::$minColor = '#f00'

Definition at line 63 of file dial.inc.

◆ $onDrawChart

Dial::$onDrawChart = "null"

Definition at line 71 of file dial.inc.

◆ $onDrawChartComplete

Dial::$onDrawChartComplete = "null"

Definition at line 72 of file dial.inc.

◆ $onDrawLegend

Dial::$onDrawLegend = "null"

Definition at line 73 of file dial.inc.

◆ $onDrawLegendComplete

Dial::$onDrawLegendComplete = "null"

Definition at line 74 of file dial.inc.

◆ $palette

Dial::$palette

Definition at line 52 of file dial.inc.

◆ $radius

Dial::$radius = 0

Definition at line 49 of file dial.inc.

◆ $scaleToFit

Dial::$scaleToFit = false

Definition at line 59 of file dial.inc.

◆ $shadow

Dial::$shadow = true

Definition at line 58 of file dial.inc.

◆ $showTarget

Dial::$showTarget = false

Definition at line 66 of file dial.inc.

◆ $strokeWidth

Dial::$strokeWidth = 1

Definition at line 56 of file dial.inc.

◆ $target

Dial::$target = 0

Definition at line 67 of file dial.inc.

◆ $targetLabel

Dial::$targetLabel = ""

Definition at line 68 of file dial.inc.

◆ $targetLabelSize

Dial::$targetLabelSize = "inherit"

Definition at line 69 of file dial.inc.

◆ $value

Dial::$value = 0

Definition at line 50 of file dial.inc.

◆ $width

Dial::$width

Definition at line 43 of file dial.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/cms/components/svg_charts/dial.inc

Public Member Functions

Public Attributes