Class CanvasRectangleText
(Defined in: jpgraph_canvtools.php : 375)
 
 CanvasRectangleText 
 ParagraphAlign() 
 Pos() 
 Set() 
 SetAutoMargin() 
 SetColor() 
 SetCornerRadius() 
 SetFillColor() 
 SetFont() 
 SetFontColor() 
 SetPos() 
 SetShadow() 
 SetTxt() 
 Stroke() 
 __construct() 
 

Class usage and Overview
YOu can use this class to convieniently draw a text on canvas. The text may have multiple lines wher each line is separated by a "\n" (newline) character.

The text may also be enclosed in a rounded (possibly filled) rectangle.

 

See also related classes:
CanvasGraph and CanvasScale

 

Class Methods

 

CanvasRectangleText ::
ParagraphAlign($aParaAlign)
Specify paragraph alignment for the text

ArgumentDefaultDescription
$aParaAlign  Alignment

Description:
Specify paragraph alignment for the text. Alignments can be:  

Example:


$g = new CanvasGraph(550,450);
$scale = new CanvasScale($g);
$scale->Set(0,27,0,53);
//
$t = new CanvasRectangleText();
$t->SetFillColor('lightgreen');
$t->SetFontColor('navy');
$t->SetFont(FF_ARIAL,FS_NORMAL,16);
$t->ParagraphAlign('center');
$t->Set("First line\nSecond line",0.5,19,26,32);
$t->Stroke($g->img,$scale);

 

CanvasRectangleText ::
Pos($xl, $yt, $w, $h)
Specify position for text

ArgumentDefaultDescription
$xl 0 Top left X
$yt 0 Top left Y
$w 0 Width
$h 0 Height

Description:
Set position for text. All coordinates will be translaed according to the current scale used.  

 

CanvasRectangleText ::
Set($aTxt, $xl, $yt, $w, $h)
Specify the text and position

ArgumentDefaultDescription
$aTxt  Text
$xl  Top left X
$yt  Top left Y
$w 0 Width
$h 0 Height

Description:
Specify the text and position. All coordinates will be translated using the specified scale when stroked. 

Example:

$t->SetShadow('');
$t->SetFont(FF_ARIAL,FS_BOLD,18);
$t->Set('Family',1,1,8);
$t->Stroke($g->img,$scale);

 

CanvasRectangleText ::
SetAutoMargin($aMargin)
Specify auto margin when no specific size is specified

ArgumentDefaultDescription
$aMargin  Margin in pixels

Description:
Specify auto margin when no specific size is specified. This margin is used to add extra space around the text and the border around the text. 

 

CanvasRectangleText ::
SetColor($aColor)
Set border color for rectangle

ArgumentDefaultDescription
$aColor  Border color

Description:
Set border color for rectangle 
 
See also:

Example:

$t->SetColor('navy');

 

CanvasRectangleText ::
SetCornerRadius($aRad)
Set radius for corners

ArgumentDefaultDescription
$aRad 5 Radius in pixels

Description:
Specify the radius for the rounded corners. Specifying the value as 0 will give normal square corners.  

Example:

$t->SetCornerRadius(15);

 

CanvasRectangleText ::
SetFillColor($aFillColor)
Specify fill color for rectangle

ArgumentDefaultDescription
$aFillColor  Color

Description:
Specify fill color for rectangle 

Example:

$t->SetFillColor('#12A73C');


 

CanvasRectangleText ::
SetFont($FontFam, $aFontStyle, $aFontSize)
Specify font

ArgumentDefaultDescription
$FontFam  Font family
$aFontStyle  Font style
$aFontSize 12 Font size

Description:
Specify font 

Example:

$t->SetFont(FF_ARIAL,FS_BOLD,24);

 

CanvasRectangleText ::
SetFontColor($aColor)
Specify text (font) color

ArgumentDefaultDescription
$aColor  Color specification

Description:
Set color for text. Use SetColor() to specify border colro and SetFillColor() to set fill color. 
 
See also:

Example:

$t->SetFontCOlor('black')

 

CanvasRectangleText ::
SetPos($xl, $yt, $w, $h)
Specify position

ArgumentDefaultDescription
$xl 0 Top left X
$yt 0 Top left Y
$w 0 Width
$h 0 Height

Description:
Specify position. All coordinates will be transalted with the specified scale when stroked. 

 

CanvasRectangleText ::
SetShadow($aColor, $aWidth)
Add a drop shadow

ArgumentDefaultDescription
$aColor 'gray' Color of shadow
$aWidth 3 Width of shadow

Description:
Add a drop shadow to the rounded reactangle surranding the text 

Example:

$t->SetShadow();  // Use default values

 

CanvasRectangleText ::
SetTxt($aTxt)
Specify text string

ArgumentDefaultDescription
$aTxt  Textt

Description:
Set text string to be displayed. The text string may have multiple lines separated by a newline character "\n" 

Example:

$t->Set("This is a text!");

 

CanvasRectangleText ::
Stroke($aImg, $scale)
Stroke text to canvas

ArgumentDefaultDescription
$aImg  Image context
$scale  Scale

Description:
Stroke text to canvas 
 
See also:

Example:

$t->Stroke($graph->img,$scale);

 

CanvasRectangleText ::
__construct($aTxt, $xl, $yt, $w, $h)
Draws a text paragraph inside a rounded, possibly filled, rectangle

ArgumentDefaultDescription
$aTxt '' Text
$xl 0 Top left X
$yt 0 Top left Y
$w 0 Width
$h 0 Height

Description:
Draws a text paragraph inside a rounded, possible filled, rectangle. 

Example:


$t = new CanvasRectangleText();
$t->SetFillColor('lightgreen');
$t->SetFontColor('navy');
$t->SetFont(FF_ARIAL,FS_NORMAL,16);
$t->Set("\n\n\n\n\n\n\n\n\n\n\nTTF Fonts",0.5,19,26,32);
$t->Stroke($g->img,$scale);