Add Params Legend definition

Benjamin Renard
1 parent f012b419
Showing 4 changed files with 235 additions and 7 deletions Show diff stats
src/InputOutput/IHMImpl/Params/PlotImpl/IHMInputOutputParamsPlotClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotElementNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotLegendsNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotParamsLegendNodeClass.php
@@ -357,6 +357,10 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 				throw new Exception('Plot type not implemented.');
 		}
  
+		//Params Legends
+		if (isset($panelData->{'panel-series-legend'}) && $panelData->{'panel-series-legend'}->{'legend-series-activated'})
+			$this->unmarshallParamsLegend($panelData->{'panel-series-legend'}, $plotNode->getLegends()->getParamsLegend());
+		
 		return $plotNode;
 	}
  
@@ -687,6 +691,61 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 		return false;
 	}
  
+	protected function unmarshallParamsLegend($paramsLegendData, $paramsLegendNode)
+	{
+		//Legend type
+		switch ($paramsLegendData->{'legend-series-type'})
+		{
+			case 'text-line-symbol' :
+				$paramsLegendNode->setType(RequestOutputPlotParamsLegendTypeEnum::TEXTLINESYMBOL);
+				break;
+			case 'text-only' :
+			default :
+				$paramsLegendNode->setType(RequestOutputPlotParamsLegendTypeEnum::TEXTONLY);
+		}
+		
+		//Show param legend
+		$paramsLegendNode->setShowParamInfo($paramsLegendData->{'legend-series-showparaminfo'} ? "true" : "false");
+		
+		//Show interval legend
+		$paramsLegendNode->setShowIntervalInfo($paramsLegendData->{'legend-series-intervalinfo-activated'} ? "true" : "false");
+		
+		//Interval info type
+		switch ($paramsLegendData->{'legend-series-intervalinfo-type'})
+		{
+			case 'start-stop' :
+				$paramsLegendNode->setIntervalInfoType(RequestOutputPlotParamsLegendIntervalInfoTypeEnum::STARTSTOP);
+				break;
+			case 'index' :
+			default :
+				$paramsLegendNode->setIntervalInfoType(RequestOutputPlotParamsLegendIntervalInfoTypeEnum::INDEX);
+		}
+		
+		//Position
+		switch ($paramsLegendData->{'legend-series-position'})
+		{
+			case 'inside' :
+				$paramsLegendNode->setPosition(RequestOutputPlotParamsLegendPositionEnum::INSIDE);
+				break;
+			case 'outside' :
+			default :
+				$paramsLegendNode->setPosition(RequestOutputPlotParamsLegendPositionEnum::OUTSIDE);
+		}
+		
+		//Default text color
+		$paramsLegendNode->setDefaultTextColor($this->hexColor2KernelColor($paramsLegendData->{'legend-series-defaulttextcolor'}));
+		
+		//Border visible
+		$paramsLegendNode->setBorderVisible($paramsLegendData->{'legend-series-border-activated'} ? "true" : "false");
+		
+		//Border color
+		$paramsLegendNode->setBorderColor($this->hexColor2KernelColor($paramsLegendData->{'legend-series-border-color'}));
+		
+		//Font
+		if ($paramsLegendData->{'legend-series-font-activated'})
+			$this->unmarshallFont($paramsLegendData, 'legend-series-font', $paramsLegendNode->getFont());
+	}
+	
 	protected function unmarshallTitle($inputData, $keyPrefix, $titleNode)
 	{
 		if ($inputData->{$keyPrefix.'-text'} != '')
 <?php
  
-//require_once("RequestOutputPlotLegendsNodeClass.php");
+require_once("RequestOutputPlotLegendsNodeClass.php");
 require_once("RequestOutputPlotParamsNodeClass.php");
 require_once("RequestOutputPlotAxesNodeClass.php");
 //require_once("RequestOutputPlotAdditionalObjectsNodeClass.php");
 //require_once("RequestOutputPlotFillsNodeClass.php");
  
+define ("REQUESTOUTPUTPLOTLEGENDS_NAME", "legends");
+
 /**
  * @class RequestOutputPlotElementNodeClass
  * @brief Definition of a plot element for a panel of a plot request
@@ -18,12 +20,11 @@ class RequestOutputPlotElementNodeClass extends NodeClass
 		parent::__construct($plotElementName);
 		//create plot element skeleton
  
-		//ToDo legends if needed
-		/*if ($defineLegends)
-		 {
-		$node = new RequestOutputPlotLegendsNodeClass();
-		$this->addChild($node);
-		}*/
+		if ($defineLegends)
+		{
+			$node = new RequestOutputPlotLegendsNodeClass(REQUESTOUTPUTPLOTLEGENDS_NAME);
+			$this->addChild($node);
+		}
  
 		//params
 		$node = new RequestOutputPlotParamsNodeClass();
@@ -0,0 +1,31 @@
+<?php
+
+require_once("RequestOutputPlotParamsLegendNodeClass.php");
+
+/**
+ * @class RequestOutputPlotLegendsNodeClass
+ * @brief Definition of legends element for a plot
+ * @details
+ */
+class RequestOutputPlotLegendsNodeClass extends NodeClass
+{
+	public function __construct($name)
+	{
+		parent::__construct($name);
+	}
+	
+	public function getParamsLegend()
+	{
+		$node = $this->getFirstChildByName(REQUESTOUTPUTPLOTPARAMSLEGEND_NAME);
+	
+		if (!isset($node))
+		{
+			$node = new RequestOutputPlotParamsLegendNodeClass();
+			$this->addChild($node);
+		}
+	
+		return $node;
+	}
+}
+
+?>
 \ No newline at end of file
@@ -0,0 +1,137 @@
+<?php
+
+define ("REQUESTOUTPUTPLOTPARAMSLEGEND_NAME", "paramsLegend");
+define ("REQUESTOUTPUTPLOTPARAMSLEGEND_TYPE", "type");
+define ("REQUESTOUTPUTPLOTPARAMSLEGEND_SHOWPARAMINFO", "showParamInfo");
+define ("REQUESTOUTPUTPLOTPARAMSLEGEND_SHOWINTERVALINFO", "showIntervalInfo");
+define ("REQUESTOUTPUTPLOTPARAMSLEGEND_INTERVALINFOTYPE", "intervalInfoType");
+define ("REQUESTOUTPUTPLOTPARAMSLEGEND_POSITION", "position");
+define ("REQUESTOUTPUTPLOTPARAMSLEGEND_DEFAULTTEXTCOLOR", "defaultTextColor");
+define ("REQUESTOUTPUTPLOTPARAMSLEGEND_BORDERVISIBLE", "borderVisible");
+define ("REQUESTOUTPUTPLOTPARAMSLEGEND_BORDERCOLOR", "borderColor");
+
+abstract class RequestOutputPlotParamsLegendTypeEnum
+{
+	const TEXTLINESYMBOL = "text-line-symbol";
+	const TEXTONLY       = "text-only";
+}
+
+abstract class RequestOutputPlotParamsLegendPositionEnum
+{
+	const INSIDE  = "inside";
+	const OUTSIDE = "outside";
+}
+
+abstract class RequestOutputPlotParamsLegendIntervalInfoTypeEnum
+{
+	const INDEX     = "index";
+	const STARTSTOP = "start-stop";
+}
+
+/**
+ * @class RequestOutputPlotParamsLegendNodeClass
+ * @brief Definition of a "params legend" element for a plot
+ * @details
+ */
+class RequestOutputPlotParamsLegendNodeClass extends NodeClass
+{
+	public function __construct()
+	{
+		parent::__construct(REQUESTOUTPUTPLOTPARAMSLEGEND_NAME);
+	}
+	
+	public function setType($type)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_TYPE, $type);
+	}
+	
+	public function getType()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_TYPE);
+	}
+	
+	public function setShowParamInfo($show)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_SHOWPARAMINFO, $show);
+	}
+	
+	public function getShowParamInfo()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_SHOWPARAMINFO);
+	}
+	
+	public function setShowIntervalInfo($show)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_SHOWINTERVALINFO, $show);
+	}
+	
+	public function getShowIntervalInfo()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_SHOWINTERVALINFO);
+	}
+	
+	public function setIntervalInfoType($type)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_INTERVALINFOTYPE, $type);
+	}
+	
+	public function getIntervalInfoType()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_INTERVALINFOTYPE);
+	}
+	
+	public function setPosition($position)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_POSITION, $position);
+	}
+	
+	public function getPosition()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_POSITION);
+	}
+	
+	public function setDefaultTextColor($color)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_DEFAULTTEXTCOLOR, $color);
+	}
+	
+	public function getDefaultTextColor()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_DEFAULTTEXTCOLOR);
+	}
+	
+	public function setBorderVisible($visible)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_BORDERVISIBLE, $visible);
+	}
+	
+	public function getBorderVisible()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_BORDERVISIBLE);
+	}
+	
+	public function setBorderColor($color)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_BORDERCOLOR, $color);
+	}
+	
+	public function getBorderColor()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTPARAMSLEGEND_BORDERCOLOR);
+	}
+	
+	public function getFont()
+	{
+		$node = $this->getFirstChildByName(REQUESTOUTPUTPLOTPARAMSLEGEND_FONT);
+	
+		if (!isset($node))
+		{
+			$node = new RequestOutputPlotFontNodeClass();
+			$this->addChild($node);
+		}
+	
+		return $node;
+	}
+}
+
+?>
 \ No newline at end of file