Documentation Font Image Handling PHP TrueType
Updated on June 20th, 2006

Reference Index

Structures
構造
Data types
データ型
Setup functions
設定関数
Drawing functions
描画関数
Objects
オブジェクト
  1. Using functions
  2. Using constructors
  3. Declaring variables
  4. Using variables
  5. Accessing property of object
  1. 関数の使用
  2. コンストラクタの使用
  3. 変数の宣言
  4. 変数の使用
  5. オブジェクト属性
  1. number
  2. string
  3. constant
  1. autoresize
  2. padding
  3. size
  4. type
  5. file
  6. debug
  1. antialias
  2. color
  3. font
  4. translate
  5. fill
  6. pattern
  7. rect
  8. fillrect
  9. patternrect
  10. image
  11. string
  1. image
  2. font
  3. color
  4. rectangle
  5. insets
  6. point
  7. dimension

Structures

Using Functions
関数の使用

PHP Font Image Generator 2 has several functions. To do something, you call some functions. Function has a list of parameters. Each statement of calling function must be separated by ; (semicolon), and each parameters by , (comma).

PHP Font Image Generator 2 にはいくつかの関数が用意されています。何かをするには関数を呼び出さなくてはなりません。関数にはいくつかのパラメータがあります。関数の呼び出し文はそれぞれ ; (セミコロン) で、またパラメータは , (コンマ) で区切ります。

Examples color 0x993333;
fill;
color 255, 255, 255, 50;
rect 20, 20, 100, 100;
Syntax function;
function argument1, argument2, ..., argumentN;
Parameters
Name Description
function
any function
関数
argument1...argumentN
list of parameters specific to the function
関数に応じたパラメータ
» Back to top

Using Constructors
コンストラクタの使用

A constructor creates a specific object. Constructor has a list of parameters as well as function. Each statement of calling constructor must be quoted by {} (parentheses), constructor and parameters are separated by : (collon), and each parameter by , (comma).

コンストラクタは一つのオブジェクトを生成します。コンストラクタには関数と同様にいくつかのパラメータがあります。コンストラクタの呼び出し文はそれぞれ {} (括弧) の中に書き、コンストラクタとパラメータは : (コロン) で、またパラメータはそれぞれ , (コンマ) で区切ります。

Examples color {color: 0x993333};
fill;
color {color: 255, 255, 255, 50};
rect {rectangle: 20, 20, 100, 100};
Syntax {constructor:}
{constructor: argument1, argument2, ..., argumentN}
Parameters
Name Description
constructor
any constructor
関数
argument1...argumentN
list of parameters specific to the constructor
関数に応じたパラメータ
» Back to top

Declaring Variables
変数の宣言

A variable binds a name (identifier) and a value, so that the value is accessed later by the name. Variable is defined in HTTP GET Method, so each statement of defining a variable is separated by & (ampersand), the name of a variable and the data is separated by = (assign).

変数とは名前と値を束ねるもので、そうすることで後で値を名前で取得することができます。変数は HTTP GET メソッド上で定義します。よって、変数の宣言文はそれぞれ & (アンパサンド) で区切り、名前と値の間には = (assign) を書きます。

Examples alpha=90
&foreground={color: 255, 255, 0}
&font={font: 'font/MinionDisplayBold.ttf', 15}
Syntax name1=value1
&name2=value2
&...
&nameN=valueN
Parameters
Name Description
name1...nameN
any valid variable name
有効な名前
value1...valueN
value of any datatype
値
» Back to top

Using Variables
変数の使用

Each statement of accessing a variable is quoted by {} (paretheses). As the program loads all variables first, you don't have to declare variables before using those.

変数の取得文は {} (括弧) 内に書きます。プログラムはまず最初に全ての変数を読み込みますので、変数を宣言する前に変数を使用してもかまいません。

Examples color {background};
fill;
color {foreground};
rect {border};
&background=0xffffff
&foreground={color: 255, 255, 0, {alpha}}
&border={rectangle: 20, 20, 100, 100}
&alpha=50
Syntax {variable}
Parameters
Name Description
variable
any variable
変数
» Back to top

Accessing Property of Object
オブジェクト属性

An object datatype variable has some accessible properties. Each statement of accessing a property of a variable is quoted by {} (paretheses), and variable and property are separated by . (period).

オブジェクト型の変数からはいくつかの属性を取得できます。オブジェクト属性の取得文は {} (括弧) 内に書き、変数と属性は . (ピリオド) で区切ります。

Examples color 0xffffff;
fill;
image {leftImg}, 0, 0;
image {rightImg}, {leftImg.width}, 0;
rect {border};
&leftImg={image: 'img/left_image.gif'}
&rightImg={image: 'img/right_image.gif'}
Syntax {variable.property}
Parameters
Name Description
variable
any variable
変数
property
any valid property
有効な属性
» Back to top

Data Types

number type
数字型

Example 223
-1.61
0xffffff
0X996633
#7f000000
0b1111000000000000000011111111
0B01011
Description

Datatype for integers and floating-point numbers. Integers can be as large as 2,147,483,647 and as low as -2,147,483,648. Floating-point numbers can be as large as 3.40282347E+38 and as low as -3.40282347E+38.

It is also allowed that the use of hexadecimal notation and binary notation. Hexadecimal notation can be as large as 7fffffff, binary noation as a 31 sequence of 1, which is equivarent to 2,147,483,647 in decimal number.

整数と小数を格納するデータ型です。整数は最大で 2,147,483,647、最小で -2,147,483,648 の範囲を表せます。小数は最大で 3.40282347E+38、最小で -3.40282347E+38 の範囲を表せます。

また、16 進法の記述と、2 進法の記述をすることもできます。16 進法では最大で 7fffffff、2 進法では最大で 31 個の 1 が続いた数を表せます。これらは 10 進法での 2,147,483,647 と同等になります。
Syntax integral_number
floating_number
0xhexadecimal_notation
0Xhexadecimal_notation
#hexadecimal_notation
0bbinary_notation
0Bbinary_notation
» Back to top

string type
文字型

Example 'metaphysical'
"\"Rock'n Roll\""
Description

A string is a sequence of characters. String datatype is defined inside "" (double quotes) or '' (single quotes). Actually, strings which contain any non-alphabetical character (from A to Z in uppercase and lowercase, including - (dash)) are automatically considered as string datatype, but you should always quote it because alphabetical strings including - (dash) without quotes are defined as constant datatype.

文字列とは文字が並んだものです。文字型は "" (ダブルクオート) か '' (シングルクオート) の中で定義します。実際の所、アルファベット以外の文字 (大文字小文字を含めた A から Z、但し - (ハイフン) を含む) 以外の文字を含んだ文字列は自動的に文字型として扱われるのですが、アルファベットか - (ハイフン) だけの文字列は定数型として扱われてしまうので、常にクオートの中に定義したほうが良いでしょう。
Syntax "characters"
'characters'
» Back to top

constant type
定数型

Example left-adjust
both
Description

Constant datatype is described by a sequence of alphabetical characters (from A to Z in uppercase and lowercase) and - (dash) without quotes.

定数型はクオートされていないアルファベットか - (ハイフン) だけの文字列です。
Syntax constant_value
» Back to top

Setup Functions

autoresize function
autoresize 関数

Examples
size 50,50;
autoresize none;
color 100,200,0;
fill;
color 255,255,255;
font '../lib/font/otf/HelveticaNeueLTStd-Bd.otf',10,10;
string 'autoresize none',10,10;
size 50,50;
autoresize width;
color 100,200,0;
fill;
color 255,255,255;
font '../lib/font/otf/HelveticaNeueLTStd-Bd.otf',10,10;
string 'autoresize width',10,10;
size 50,50;
autoresize both;
color 100,200,0;
fill;
color 255,255,255;
font '../lib/font/otf/HelveticaNeueLTStd-Bd.otf',10,10;
string 'autoresize both',10,10;
Description

Defines the trimming mode of the canvas. Once autoresize function called, it is ignored that the dimension of the canvas defined by size function, in order of the mode parameter, and to be fitted to the inner graphics contexts drawn.

mode parameter specifies which dimension to be resized. For example, if you don't know about the length of text to be rendered, but the height of that is clear, you may use width. The discription of the 4 different trimming mode follows:

none : the canvas is not trimmed (default)

width : the width of the canvas is trimmed

height : the height of the canvas is trimmed

both : both height and width of the canvas are trimmed

カンバスの切り抜き方法を定義します。一度 autoresize 関数が呼び出されれば、size 関数によって定義されたカンバスのサイズは mode パラメータに応じて無視され、描画されたグラフィクス内容に合わせられます。

mode パラメータは幅か高さのどちらを切り抜くかを指定します。例えば、描画したい文字列の高さは分かっているけども文字列の長さが分からないといった場合、width を使うのが良いでしょう。切り抜き方法には次の 4 つがあります。

none : 切り抜かない (デフォルト)

width : カンバスの幅を切り抜く

height : カンバスの高さを切り抜く

both : カンバスの幅と高さを切り抜く
Syntax autoresize mode;
Parameters
Name Type Description
mode constant
trimming mode, either none, width, height or both
切り抜き方法。none、width、height、both のいづれか。
» Back to top

padding function
padding 関数

Examples
size 50,50;
autoresize both;
padding 10,20,30,40;
color 127,127,127;
fill;
color 255,255,255;
fillrect 0,0,50,50;
color 255,127,0;
rect 0,0,50,50;
Description

Defines extra space from the sides of the canvas. This expands the dimension of the canvas defined by size function. For example, size 400,400; and padding 40,50; is called, the dimension of the canvas size will be 480 x 500. If you don't like this, you should use translate function.

Notice that graphics context drawn by fill or pattern remains in the extra space.

カンバスの周辺の余白を定義します。これは size 関数で定義されたカンバスのサイズを広げます。例えば size 400,400; と padding 40,50; が呼び出されたとすると、カンバスのサイズは 480 x 500 になります。もしサイズを変更しないで余白を作りたければ translate 関数を使用すると良いでしょう。

また、fill 関数または pattern 関数で描画されたグラフィックス内容は余白部分に残ります。
Syntax padding insets;
padding tlbr;
padding tb, lr;
padding top, left, bottom, right;
Parameters
Name Type Description
insets insets
any value of the insets datatype
insets データ型の値
tlbr number
distance from top, left, bottom and right sides of the canvas
カンバスの上下左右の辺からの余白
tb number
distance from top and bottom sides of the canvas
カンバスの上下の辺からの余白
lr number
distance from left and right sides of the canvas
カンバスの左右の辺からの余白
top number
distance from top side of the canvas
カンバスの上の辺からの余白
left number
distance from left side of the canvas
カンバスの左の辺からの余白
bottom number
distance from bottom side of the canvas
カンバスの下の辺からの余白
right number
distance from right side of the canvas
カンバスの右の辺からの余白
» Back to top

size function
size 関数

Examples
size 50,50;
color 255,127,0;
fill;
size 80,80;
color 0,127,255;
fill;
Description

Defines the dimension of the canvas. You should call this at least once or call autoresize function to set the trimming mode as both, if not, the dimension of the canvas will be 1 x 1. If you call this many time, the last one overrides the others.

This can be called in anywhere, after calling some drawing functions for example.

カンバスのサイズを定義します。autoresize 関数で切り抜きを方法を both に設定していない限り、少なくとも一回はこの関数を呼び出さなければなりません。そうでなければカンバスサイズは 1 x 1 になってしまいます。もし複数回この関数を呼び出せば、最後に指定した値が前を上書きします。

この関数は、例えば描画関数を呼び出した後など、いつでも呼び出せます。
Syntax size width, height;
Parameters
Name Type Description
width number
width of the canvas in units of pixels
カンバスの幅 (px)
height number
height of the canvas in units of pixels
カンバスの高さ (px)
» Back to top

type function
type 関数

Examples
autoresize both;
image 'img/map.png',0,0;
color 255,127,0;
fillrect 0,0,40,40;
type gif,256;
autoresize both;
image 'img/map.png',0,0;
color 255,127,0;
fillrect 0,0,40,40;
type jpeg,80;
autoresize both;
image 'img/map.png',0,0;
color 255,127,0;
fillrect 0,0,40,40;
type png,50,{color:255,127,0};
Description

Defines the type and other parameters of the image file to output. By default, the image file will be GIF type with 256 colors.

type parameter has 3 different image type: gif, png and jpeg. The transparent parameter is applied only in gif and png mode. The meaning of the option parameter alters in order of the type parameter following:

gif : option parameter specifies the number of color, from 1 to 256

png : option parameter specifies the number of color, from 1 to 256

jpeg : option parameter specifies the quality of compression, from 1 to 100

出力する画像形式や出力パラメータを定義します。デフォルトでは 256 色のパレットを持つ GIF 画像が出力されます。

type パラメータには 3 つの画像形式があり、gif、png、jpeg です。transparent パラメータは画像形式が gif か png の場合にのみ適用されます。option パラメータの定義するものは、以下に示した通り type パラメータの値によって変化します。

gif : option パラメータは色数を定義します。値は 1 から 256 までです。

png : option パラメータは色数を定義します。値は 1 から 256 までです。

jpeg : option パラメータは圧縮率を定義します。値は 1 から 100 までです。
Syntax type type;
type type, option;
type type, transparent;
type type, option, transparent;
Parameters
Name Type Description
type constant
type of the image file to output, either gif, png or jpeg
出力する画像形式。gif、png、jpeg のいずれか。
option number
option value of the output
出力オプション値
transparent color
any value of the color datatype
color データ型の値
» Back to top

file function

Examples Not yet
Description

Specifies whether to create the image file and the name of it. Once file is called, this tries to create an image file according to the file_path parameter and make a redirection to it, so that it is not rendered every time. If the file creation is failed (permission problem, for instance), this returns its data stream as usual.

Notice that this does not make any directories or change permission. For example, file 'foo/bar/text.gif'; requires a "bar" directory in a "foo" directory with the permission enough for PHP to create file.

Currently this function only supports relative path from the script file directory as the file_path argument.
Syntax file file_path;
Parameters
Name Type Description
file_path string path of the image file to create
» Back to top

debug function
debug 関数

Examples
[Show This Debug Page] debug;
autoresize both;
color 255,127,0;
fill 0,0,100,100;
color 255,255,255;
font 'font/HelveticaNeueBold.ttf',10,10;
string 'debug example',0,0,100,100;
type gif,255,{color:255,127,0};
Description

Dumps a list of all variables, functions, and parameters defined or called.

This can be called in anywhere, after calling some drawing functions for example.

定義された全ての変数と、呼び出された全ての関数とそのパラメータの一覧を出力します。

この関数は、例えば描画関数を呼び出した後など、いつでも呼び出せます。
Syntax debug;
Parameters
Name Type Description
» Back to top

Drawing Functions

antialias function
antialias 関数

Examples
autoresize both;
padding 10;
color 100,200,0;
fill;
color 0,0,0;
font 'font/HelveticaNeueBold.ttf',10,10;
antialias 1;
string 'antialias x1';
translate 0,20;
antialias 4;
string 'antialias x4';
translate 0,20;
antialias 16;
string 'antialias x16';
Description

Defines the quality of text antialias. Text renderer buffers the image of text multiplied by the antialias parameter, and resamples the buffered image to draw. By default, sampling multiplier is 4. If you set the antialias as 1, text is not antialiased.

Be careful setting large number as multiplier because antialiasing is one of the most heavy process of all.

文字列のアンチエイリアス処理の品質を定義します。テキストレンダラーは antialias パラメータの値に基づいて乗算された文字列の画像をバッファリングし、それをリサンプリングして描画します。デフォルトではサンプリング乗数は 4 になります。antialias を 1 にすればアンチエイリアス処理は行われません。

アンチエイリアス処理は最も重い処理の一つですので、サンプリング乗数を大きな値にするときには注意してください。
Syntax antialias multiplier;
Parameters
Name Type Description
multiplier number
multiplier value of sampling
サンプリング乗数
» Back to top

color function
color 関数

Examples
autoresize both;
color 0x0099ff;
fillrect {rect};
translate 0,20;
color 0xff,0,0x99;
fillrect {rect};
translate 0,20;
color 255,255,0;
fillrect {rect};
translate 0,20;
color 0;
fillrect {rect};
translate 0,-60;
color 0xffffff,50;
fillrect 40,0,40,80;
&rect={rectangle:0,0,80,20}
Description

Sets the color used to draw rectangle, fill and text. This has the same parameters as the color: constructor for convenience, except the color datatype. See also the description of the color: constructor for more detail.

矩形や塗りつぶし、文字列の描画に使う色を指定します。この関数には color データ型の値をパラメータに取れる以外に、利便性のために color: コンストラクタと同じパラメータが用意されています。詳しくは color: コンストラクタの説明を参照ください。
Syntax color color;
color argb;
color rgb, alpha;
color red, green, blue;
color red, green, blue, alpha;
Parameters
Name Type Description
color number
any value of the color datatype
color データ型の値
argb number
color and alpha value in number, from 0 to 2147483647 (0x7fffffff)
色と透明度を合わせた数値。値は 0 から 2147483647 (0x7fffffff) までです。
rgb number
color value in number, from 0 to 16777215 (0xffffff)
色の数値。値は 0 から 16777215 (0xffffff) までです。
red number
red value in number, from 0 to 255 (0xff)
赤の数値。値は 0 から 255 (0xff) までです。
green number
green value in number, from 0 to 255 (0xff)
緑の数値。値は 0 から 255 (0xff) までです。
blue number
blue value in number, from 0 to 255 (0xff)
青の数値。値は 0 から 255 (0xff) までです。
alpha number
alpha value in number, from 0 to 127 (0x7f)
透明度の数値。値は 0 から 127 (0x7f) までです。
» Back to top

font function
font 関数

Examples
autoresize both;
padding 10;
color 100,200,0;
fill;
color 255,255,255;
font 'font/HelveticaNeueBlack.ttf',10;
string 'HelveticaNeue Bold 10pt',10,10;
font 'font/HelveticaNeueMedium.ttf',8;
string 'HelveticaNeue Medium 8pt',10,30;
color 0,0,0;
font 'font/MinionBoldDisplay.ttf',9;
string 'Minion Bold Display 9pt',10,50;
font 'font/MinionMediumDisplay.ttf',7;
string 'Minion Medium Display 7pt',10,70;
Description

Sets the font used to draw text. This has the same parameters as font: constructor for convenience, except the font datatype. See also the description of font: constructor for more detail.

文字列の描画に使うフォントを指定します。この関数には font データ型の値をパラメータに取れる以外に、利便性のために font: コンストラクタと同じパラメータが用意されています。詳しくは font: コンストラクタの説明を参照ください。
Syntax font font;
font fontfile;
font fontfile, size;
font fontfile, size, leading;
Parameters
Name Type Description
font font
any value of font datatype
font データ型の値
fontfile string
file path of the font to load, must be .ttf
読み込むフォントファイル (.ttf) のパス。
size number
size of the font
文字サイズ。
leading number
leading value of the font
文字の行間。
» Back to top

translate function
translate 関数

Examples Not yet
Description

Scecifies an amount to displace objects within the canvas. The dx parameter specifies left/right translation, and the dy parameter specifies up/down translation.

Transformations apply to everything that happens after and subsequent calls to the function accumulates the effect. For example, calling translate 50,0; and then translate 20,0; is the same as translate 70,0;.
Syntax translate dx, dy;
Parameters
Name Type Description
dx number left/right translation
dy number up/down translation
» Back to top

fill function

Examples Not yet
Description

Draws a fill to the canvas.
Syntax fill
Parameters
Name Type Description
» Back to top

pattern function

Examples Not yet
Description

Draws a pattern to the canvas. The image parameter sets the pattern image.

The repeat parameter specifies whether the image is repeated, and how. The discription of the 4 different repeat mode follows:

no-repeat : the image is not repeated

repeat-x : the image is repeated horizontally only

repeat-y : the image is repeated vertically only

repeat : the image is repeated both horizontally and vertically (default)
Syntax pattern image;
pattern image, repeat;
Parameters
Name Type Description
image image or string any value of image datatype, or file path of the image to load, must be either gif, png or jpeg
repeat constant repeat mode, either no-repeat, repeat-x, repeat-y, repeat
» Back to top

rect function

Examples Not yet
Description

Draws a rectangle to the canvas. A rectangle has 4 lines. The first two parameters set the location, the third sets the width, and the fourth sets the height.
Syntax rect rectangle;
rect x, y, width, height;
Parameters
Name Type Description
rectangle rectangle any value of the rectangle datatype
x number x-coordinate of the rectangle
y number y-coordinate of the rectangle
width number width of the rectangle
height number height of the rectangle
» Back to top

fillrect function

Examples Not yet
Description

Draws a filled rectangle to the canvas. A rectangle has 4 lines and a fill. The first two parameters set the location, the third sets the width, and the fourth sets the height.
Syntax fillrect rectangle;
fillrect x, y, width, height;
Parameters
Name Type Description
rectangle rectangle any value of the rectangle
x number x-coordinage of the rectangle
y number y-coordinate of the rectangle
width number width of the rectangle
height number height of the rectangle
» Back to top

patternrect function

Examples Not yet
Description

Draws a patterned rectangle to the canvas. A rectangle has 4 lines and a pattern. The image parameter sets the pattern image.

The repeat parameter specifies whether the image is repeated, and how. The discription of the 4 different repeat mode follows:

no-repeat : the image is not repeated

repeat-x : the image is repeated horizontally only

repeat-y : the image is repeated vertically only

repeat : the image is repeated both horizontally and vertically (default)
Syntax patternrect image, rectangle;
patternrect image, rectangle, repeat;
patternrect image, x, y, width, height;
patternrect image, x, y, width, height, constant repeat;
Parameters
Name Type Description
image image or string any value of image datatype, or file path of the image, must be either gif, png or jpeg
rectangle rectangle any value of the rectangle
x number x-coordinate of the rectangle
y number y-coordinate of the rectangle
width number width of the rectangle
height number height of the rectangle
repeat constant repeat mode, either no-repeat, repeat-x, repeat-y, repeat
» Back to top

image function

Examples Not yet
Description Not yet
Syntax image image, x, y;
image image, x, y, width, height;
image image, dx1, dy1, dx2, dy2, sx1, sy1, sx2, sy2;
Parameters
Name Type Description
image image or string any value of image datatype, or file path of the image, must be either gif, png or jpeg
x number x-coordinate of the image
y number y-coordinate of the image
width number width to display the image
height number height to display the image
dx1 number x-coordinate of the first corner of the destination rectangle
dy1 number y-coordinate of the first corner of the destination rectangle
dx2 number x-coordinate of the second corner of the destination rectangle
dy2 number y-coordinate of the second corner of the destination rectangle
sx1 number x-coordinate of the first corner of the source rectangle
sy1 number y-coordinate of the first corner of the source rectangle
sx2 number x-coordinate of the second corner of the source rectangle
sy2 number y-coordinate of the second corner of the source rectangle
» Back to top

string function

Examples Not yet
Description Not yet
Syntax string text;
string text, x, y;
string text, x, y, width;
string text, x, y, width, align;
string text, x, y, width, height;
string text, x, y, width, height, align, valign;
Parameters
Name Type Description
text string the alphanumeric symbols to be displayed
x number x-coordinate of the text
y number y-coordinate of the text
width number width of the text box
height number height of the text box
align constant horizontal alignment mode of the text, either left, center, right, left-adjust, center-adjust, right-adjust or adjust.
valign constant vertical alignment mode of the text, either top, middle or bottom
» Back to top

Objects

image object

Examples Not yet
Description Not yet
Constructor Syntax {image: imagefile}
Constructor Parameters
Name Type Description
imagefile string file path of the image to load, must be either gif, png or jpeg
Properties
Name Type Description
width number width of the image
height number height of the image
» Back to top

font object

Examples Not yet
Description Not yet
Constructor Syntax {font: fontfile}
{font: fontfile, size}
{font: fontfile, size, leading}
Constructor Parameters
Name Type Description
fontfile string file path of the font to load, must be .ttf
size number size of the font
leading number leading value of the font
Properties
Name Type Description
name string file path of the font
size number size of the font
leading number leading value of the font
» Back to top

color object

Examples Not yet
Description Not yet
Constructor Syntax {color: argb}
{color: rgb, alpha}
{color: red, green, blue}
{color: red, green, blue, alpha}
Constructor Parameters
Name Type Description
argb number color and alpha value in number, from 0 to 2147483647 (0x7fffffff)
rgb number color value in number, from 0 to 16777215 (0xffffff)
red number red value in number, from 0 to 255 (0xff)
green number green value in number, from 0 to 255 (0xff)
blue number blue value in number, from 0 to 255 (0xff)
alpha number alpha value in number, from 0 to 127 (0x7f)
Properties
Name Type Description
r number red value of the color
g number green value of the color
b number blue value of the color
a number alpha value of the color
» Back to top

rectangle object

Examples Not yet
Description Not yet
Constructor Syntax {rectangle: x, y, width, height}
Constructor Parameters
Name Type Description
x number x-coordinate of the rectangle
y number y-coordinate of the rectangle
width number width of the rectangle
height number height of the rectangle
Properties
Name Type Description
x number x-coordinate of the rectangle
y number y-coordinate of the rectangle
width number width of the rectangle
height number height of the rectangle
» Back to top

insets object

Examples Not yet
Description Not yet
Constructor Syntax {insets:}
{insets: tlbr}
{insets: tb, lr}
{insets: top, left, bottom, right}
Constructor Parameters
Name Type Description
tlbr number top, left, bottom and right insets
tb number top and bottom insets
lr number left and right insets
top number top inset
left number left inset
bottom number bottom inset
right number right inset
Properties
Name Type Description
t number top inset
l number left inset
b number bottom inset
r number right inset
» Back to top

point object

Examples Not yet
Description Not yet
Constructor Syntax {point:}
{point: x, y}
Constructor Parameters
Name Type Description
x number x-coodinate of the point
y number y-coordinate of the point
Properties
Name Type Description
x number x-coodinate of the point
y number y-coordinate of the point
» Back to top

dimension object

Examples Not yet
Description Not yet
Constructor Syntax {dimension:}
{dimension: width, height}
Constructor Parameters
Name Type Description
width number width of the dimension
height number height of the dimension
Properties
Name Type Description
width number width of the dimension
height number height of the dimension
» Back to top
Toggle Comment Form