Class Shodo.Font

Object
   |
   +--Shodo.Font

class Shodo.Font

disableVML

void disableVML()

Disable VML rendering (for Internet Explorer only).

drawAbove

void drawAbove(<String> string, <Number> x, <Number> y, <Number> offset, <Number> linespacing)

Draw the specified string center aligned above the specified point (plus any specified vertical offset).

Parameters:
string - string to be drawn. May include newlines, but must otherwise only contain characters from the mapped character set
x - left horizontal coordinate where the string is to be drawn
y - top vertical coordinate where the string is to be drawn
offset - optional number of pixels to offset between bottom of string and the specified (x, y) coordinate); default 0
linespacing - optional number of pixels between successive lines of text. Default is 4.

drawAlignedTo

void drawAlignedTo(<String> string, <Number> x, <Number> y, <Number> linespacing, <Number> angle)

Draw the specified string aligned to the specified point in the canvas. This differs from Shodo.Font.drawString() in that it corrects for certain rotations that might result in upside down or backward text. E.g., if a left aligned string is rotated 135 degrees from horizontal, it appears upside down and reads from right to left. drawAlignedTo() will instead render the text rightside up, and right aligned to the point of rotation.

Parameters:
string - string to be drawn. May include newlines, but must otherwise only contain characters from the mapped character set
x - left horizontal coordinate where the string is to be drawn
y - top vertical coordinate where the string is to be drawn
linespacing - optional number of pixels between successive lines of text. Default is 4.
angle - optional rotation angle in degrees for the rendered text; default 0. All rotation angles are computed using the upper left corner of the text bounding box as the origin. Positive angles are clockwise, negative angles are counter clockwise.

drawBelow

void drawBelow(<String> string, <Number> x, <Number> y, <Number> offset, <Number> linespacing)

Draw the specified string center aligned below the specified point (plus any specified vertical offset).

Parameters:
string - string to be drawn. May include newlines, but must otherwise only contain characters from the mapped character set
x - left horizontal coordinate where the string is to be drawn
y - top vertical coordinate where the string is to be drawn
offset - optional number of pixels to offset between top of string and the specified (x, y) coordinate); default 0
linespacing - optional number of pixels between successive lines of text. Default is 4.

drawLeftOf

void drawLeftOf(<String> string, <Number> x, <Number> y, <Number> offset, <Number> linespacing)

Draw the specified string right aligned and vertically centered to the left of the specified point (plus any specified horizontal offset).

Parameters:
string - string to be drawn. May include newlines, but must otherwise only contain characters from the mapped character set
x - left horizontal coordinate where the string is to be drawn
y - top vertical coordinate where the string is to be drawn
offset - optional number of pixels to offset between right end of string and the specified (x, y) coordinate); default 0
linespacing - optional number of pixels between successive lines of text. Default is 4.

drawRightOf

void drawRightOf(<String> string, <Number> x, <Number> y, <Number> offset, <Number> linespacing)

Draw the specified string left aligned and vertically centered to the right of the specified point (plus any specified horizontal offset).

Parameters:
string - string to be drawn. May include newlines, but must otherwise only contain characters from the mapped character set
x - left horizontal coordinate where the string is to be drawn
y - top vertical coordinate where the string is to be drawn
offset - optional number of pixels to offset between left end of string and the specified (x, y) coordinate); default 0
linespacing - optional number of pixels between successive lines of text. Default is 4.

drawString

void drawString(<String> string, <Number> x, <Number> y, <Number> linespacing, <String> align, <Number> angle)

Draw the specified string into the font's canvas.

Parameters:
string - string to be drawn. May include newlines, but must otherwise only contain characters from the mapped character set
x - left horizontal coordinate where the string is to be drawn
y - top vertical coordinate where the string is to be drawn
linespacing - optional number of pixels between successive lines of text. Default is 4.
align - optional horizontal alignment of text within total bounding box: 'left', 'right', or 'center', default 'left'
angle - optional rotation angle in degrees for the rendered text; default 0. All rotation angles are computed using the upper left corner of the text bounding box as the origin. Positive angles are clockwise, negative angles are counter clockwise.

enableVML

void enableVML()

Enable VML rendering (for Internet Explorer only).

getBounds

Array getBounds(<String> string, <Number> x, <Number> y, <Number> linespacing, <Number> angle)

Compute the bounding box of the specified string drawn using the specified font/size/color, linespacing, and rotation angle. Returns an array of [ left, top, right, bottom ] coordinates of the bounding box.

Parameters:
string - string to be drawn. May include newlines, but must otherwise only contain characters from the mapped character set
x - left horizontal coordinate where the string is to be drawn
y - top vertical coordinate where the string is to be drawn
linespacing - optional number of pixels between successive lines of text. Default is 4.
angle - optional rotation angle in degrees for the rendered text; default 0. All rotation angles are computed using the upper left corner of the text bounding box as the origin. Positive angles are clockwise, negative angles are counter clockwise.

Returns:
bounding box coordinates of the string as [ left, top, right, bottom ]

getHeight

Number getHeight()

Returns the Height property (in pixels) of this font.

Returns:
the height in pixels