Contents
Login Register Wishes Forum About
Language Reference » Drawing functions » drawXThresholdArea
Help topics
Latest updates
2083d  replaceImageMapTitle
2083d  replaceImageMapValues
2083d  createFunctionSerie
2083d  setAbsicssaPosition
2083d  negateValues
Toolbox
  Download as PDF
  Print this page
  Share this page
  Create an account
  Feed the updates!
Google AdSense
drawXThresholdArea - Draw an area between two vertical threshold

This function will draw an area between two vertical threshold. Using areas can help you to highlight specific values. It is possible to tune the rendering by playing with the $Format array. To learn more about this please read the Format array guide.

Calling this function
drawXThresholdArea($Value1,$Value2,$Format="");
Where :

Value1 is the index of the 1st threshold.
Value2 is the index of the 2nd threshold.
Format is an array containing the drawing parameters of the area.

This function returns an array containing the X position of the left & right boundaries of the area.

Customisation array - Tune up your area!

It is possible to customize the way your threshold will be rendered by playing with this array. Providing a detailled configuration is not mandatory, by default the line will be drawn dashed in red.

You can specify the filled area color using R,G,B.
You can specify the filled area alpha factor using Alpha.
You can draw the area bordes setting Border to TRUE or FALSE.
You can specify the border color using BorderR,BorderG,BorderB.
You can specify the border area alpha factor using BorderAlpha.
You can specify the border tick width with BorderTicks.
You can specify a text that will be written in the area with AreaName

If you use the AreaName parameter, the text may be rotated by 90 if it cannot fit in the area


Sample script



 /* pChart library inclusions */ 
 include("../class/pData.class.php"); 
 include("../class/pDraw.class.php"); 
 include("../class/pImage.class.php"); 

 /* Create and populate the pData object */ 
 $MyData = new pData();   
 $MyData->addPoints(array(24,-25,26,25,25),"Temperature"); 
 $MyData->setAxisName(0,"Temperatures"); 
 $MyData->addPoints(array("Jan","Feb","Mar","Apr","May","Jun"),"Labels"); 
 $MyData->setSerieDescription("Labels","Months"); 
 $MyData->setAbscissa("Labels"); 

 /* Create the pChart object */ 
 $myPicture = new pImage(700,230,$MyData); 

 /* Draw the background */ 
 $Settings = array("R"=>170, "G"=>183, "B"=>87, "Dash"=>1, "DashR"=>190, "DashG"=>203, "DashB"=>107);
 $myPicture->drawFilledRectangle(0,0,700,230,$Settings); 

 /* Overlay with a gradient */ 
 $Settings = array("StartR"=>219, "StartG"=>231, "StartB"=>139, "EndR"=>1, "EndG"=>138, "EndB"=>68, "Alpha"=>50);
  $myPicture->drawGradientArea(0,0,700,230,DIRECTION_VERTICAL,$Settings); 
 $myPicture->drawGradientArea(0,0,700,20,DIRECTION_VERTICAL,array("StartR"=>0,"StartG"=>0,"StartB"=>0,"EndR"=>50,"EndG"=>50,"EndB"=>50,"Alpha"=>80));
 
 /* Add a border to the picture */ 
 $myPicture->drawRectangle(0,0,699,229,array("R"=>0,"G"=>0,"B"=>0)); 
  
 /* Write the picture title */  
 $myPicture->setFontProperties(array("FontName"=>"../fonts/Silkscreen.ttf","FontSize"=>6));
 $myPicture->drawText(10,13,"drawThresholdArea() - draw treshold areas in the charting area",array("R"=>255,"G"=>255,"B"=>255));
 
 /* Write the chart title */  
 $myPicture->setFontProperties(array("FontName"=>"../fonts/Forgotte.ttf","FontSize"=>11));
 $myPicture->drawText(250,55,"My chart title",array("FontSize"=>20,"Align"=>TEXT_ALIGN_BOTTOMMIDDLE));
 
 /* Draw the scale and do some cosmetics */  
 $myPicture->setGraphArea(60,60,450,190); 
 $myPicture->drawFilledRectangle(70,70,440,180,array("R"=>255,"G"=>255,"B"=>255,"Surrounding"=>-200,"Alpha"=>10));
 $myPicture->drawScale(array("XMargin"=>10,"YMargin"=>10,"Floating"=>TRUE,"DrawSubTicks"=>TRUE));
 
 /* Draw one static threshold area */ 
 $myPicture->setShadow(TRUE,array("X"=>1,"Y"=>1)); 
 $myPicture->setFontProperties(array("FontName"=>"../fonts/MankSans.ttf","FontSize"=>10));
 $myPicture->drawXThresholdArea(2,3,array("AreaName"=>"Test Zone","R"=>226,"G"=>194,"B"=>54,"Alpha"=>40));
 $myPicture->setShadow(FALSE); 

 /* Set the font properties */ 
 $myPicture->setFontProperties(array("FontName"=>"../fonts/Forgotte.ttf","FontSize"=>11));
 
 /* Draw the scale and do some cosmetics */  
 $myPicture->setGraphArea(500,60,670,190); 
 $myPicture->drawFilledRectangle(505,65,665,185,array("R"=>255,"G"=>255,"B"=>255,"Surrounding"=>-200,"Alpha"=>10));
 $myPicture->drawScale(array("XMargin"=>5,"YMargin"=>5,"Floating"=>TRUE,"Pos"=>SCALE_POS_TOPBOTTOM,"DrawSubTicks"=>TRUE));
 
 /* Draw one static threshold area */ 
 $myPicture->setShadow(TRUE,array("X"=>1,"Y"=>1)); 
 $myPicture->setFontProperties(array("FontName"=>"../fonts/MankSans.ttf","FontSize"=>10));
  $myPicture->drawXThresholdArea(2,3,array("NameR"=>0,"NameG"=>0,"NameB"=>0,"AreaName"=>"Test Zone","R"=>206,"G"=>231,"B"=>64,"Alpha"=>20));
  $myPicture->setShadow(FALSE); 

 /* Render the picture (choose the best way) */ 
 $myPicture->autoOutput("pictures/example.drawXThresholdArea.png"); 

Last updated on 09/09/2011 
by Jean-Damien 
Linked resources
  There is no linked topic yet.
Community comments
  No comments have been posted yet.
© Copyrights
Components used on this web site : Famfamfam icons has been made by Mark James, Rounded corners lite has been coded by Cameron Cooke and Tim Hutchison, SyntaxHighlighter has been written by Alex Gorbatchev. pChart and this web site have been created by Jean-Damien POGOLOTTI. This documentation contains 185 pages and 56 comments. 409 users have registered. This page has been rendered in 0,01 seconds. Wiki revision 1.37.