Class Index | File Index

Classes


Class TextRect

represents text in rectangular frame
Defined in: raphaeltools.src.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
TextRect(raphael, params)
Text in rectangular frame
Field Summary
Field Attributes Field Name and Description
 
font size
 
height of rectangle
 
raphael rect object
 
str
text to display
 
raphael text object
 
width of rectangle
 
x
x coordinate of top left corner
 
y
y coordinate of top left corner
Method Summary
Method Attributes Method Name and Description
<static>  
TextRect.create(raphael, params)
Creates new TextRect object, for parameters meaning see TextRect
 
setStr(str)
Sets new text of receiver
 
setX(x)
Sets new x position of receiver (this.x = x)
 
setXY(x, y)
Sets new x and y position of receiver (this.x = x; this.y = y)
 
setY(y)
Sets new y position of receiver (this.y = y)
 
Update receiver (set this.pathList for given internal variables)
Class Detail
TextRect(raphael, params)
Text in rectangular frame
Parameters:
{Raphael} raphael
rapheal instance
{Object} params
parameters, see below
{float} params.x Optional, Default: 100.
x coordinate of left lower corner [pixel]
{float} params.y Optional, Default: 100.
y coordinate of left lower corner [pixel]
{float} params.width Optional, Default: 100.
width [pixel]
{float} params.height Optional, Default: 100.
height [pixel]
{string} params.str Optional, Default: "string"
string to be shown
{float} params.fontSize Optional, Default: 20.
font size
Field Detail
{float} fontSize
font size

{float} height
height of rectangle

{Raphael.rect} rect
raphael rect object

{string} str
text to display

{Raphael.text} text
raphael text object

{float} width
width of rectangle

{float} x
x coordinate of top left corner

{float} y
y coordinate of top left corner
Method Detail
<static> {TextRect} TextRect.create(raphael, params)
Creates new TextRect object, for parameters meaning see TextRect
Parameters:
raphael
params
Returns:
{TextRect} new TextRect object

setStr(str)
Sets new text of receiver
Parameters:
{string} str
new string

setX(x)
Sets new x position of receiver (this.x = x)
Parameters:
{float} x
new x coordinate [pixel]

setXY(x, y)
Sets new x and y position of receiver (this.x = x; this.y = y)
Parameters:
{float} x
new x coordinate [pixel]
{float} y
new y coordinate [pixel]

setY(y)
Sets new y position of receiver (this.y = y)
Parameters:
{float} y
new y coordinate [pixel]

update()
Update receiver (set this.pathList for given internal variables)

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Dec 12 2012 09:22:04 GMT+0100 (CET)