Login Register Wishes Forum About
Language Reference » Drawing functions » drawThreshold
Help topics
Latest updates
4287d  replaceImageMapTitle
4287d  replaceImageMapValues
4287d  createFunctionSerie
4287d  setAbsicssaPosition
4287d  negateValues
  Download as PDF
  Print this page
  Share this page
  Create an account
  Feed the updates!
Google AdSense
drawThreshold - Draw a threshold in the chart area

This function will draw a threshold in the chart area. Using thresholds 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.

By default, the threshold will be drawn using the 1st Y Axis (0) as reference. If you chart contains multiple Y Axis, please use the AxisID parameter of the format array.

Calling this function
Where :

Value is the value (or an array of values) of the threshold to draw.
Format is an array containing the drawing parameters of the arrow.

This function returns an array containing the Y position of the threshold line.

Customisation array - Tune up your threshold!

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 which axis you‘ll use to compute the value position in the chart area with AxisID.
You can specify the line color using R,G,B.
You can specify the line alpha factor using Alpha.
You can specify the line tick width with Ticks.
You can choose to write a caption over the threshold setting WriteCaption to TRUE.
By default the value of the threshold will be written, this can be override setingCaption to whatever you want.
You can specify an offset to the alignement axis with CaptionOffset to TRUE.
The color of the caption can be set using CaptionR,CaptionG,CaptionB.
The alpha transparency of the caption can be set using CaptionAlpha.
You can specify if the threshold will reach the axis bar even if margin are defined setting NoMargin to TRUE.
You can decide to draw a box under the caption setting DrawBox. to TRUE.

If you choose to draw a box under the caption, all the drawText() extended styles can be used (DrawBoxBorder,BorderOffset,BoxRounded, ...) to have the complete list of parameters, take a look at the drawText() page.

The captions can be aligned using CaptionAlign the following ways :

CAPTION_LEFT_TOP on the left or top side (depending of the scale orientation).
CAPTION_RIGHT_BOTTOM on the right or bottom side (depending of the scale orientation).

Sample script

 $MyData = new pData();  

 /* Prepare some nice data & axis config */
 $MyData = new pData();  

 /* Define the graph area and do some makeup */
 $myPicture->drawText(350,55,"My chart title",array("FontSize"=>20,"Align"=>TEXT_ALIGN_BOTTOMMIDDLE));

 /* Draw the scale */

 /* Draw two thresholds */

This example will draw two threshold at Y=5 and Y=15.

Sample script #2

 /* pChart library inclusions */

 /* Create and populate the pData object */
 $MyData = new pData();  
 $MyData->addPoints(array(2,7,5,18,VOID,12,10,15,8,5,6,9),"Help Desk");

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

 /* Do some cosmetics */
 $myPicture->drawText(35,115,"Recorded cases",array("R"=>255,"G"=>255,"B"=>255,"FontSize"=>20,"Angle"=>90,"Align"=>TEXT_ALIGN_BOTTOMMIDDLE));

 /* Prepare the chart area */

 /* Write two thresholds over the chart */
 $myPicture->drawThreshold(10,array("WriteCaption"=>TRUE,"Caption"=>"Agreed SLA"));
 $myPicture->drawThreshold(15,array("WriteCaption"=>TRUE,"Caption"=>"Best effort"));

 /* Draw the chart */

 /* Write the data bounds */

 /* Write the chart legend */ 

 /* Render the picture (choose the best way) */
Last updated on 12/14/2010 
by Jean-Damien 
Linked resources
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. 413 users have registered. This page has been rendered in 0,02 seconds. Wiki revision 1.37.