Class Tee.Format
Contains visual parameters like fill, shadow, image, font.
Defined in: <..\..\src\teechart.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Tee.Format(chart)
|
| Field Attributes | Field Name and Description |
|---|---|
|
Color used to paint contents interior.
|
|
|
Properties to fill text.
|
|
|
Gradient properties to fill contents.
|
|
|
Image to fill background.
|
|
|
Width and height of rectangle rounded corners.
|
|
|
Properties to draw a backdrop shadow.
|
|
|
Properties to draw lines around boundaries.
|
|
|
Controls the transparency, from 0 (opaque) to 1 (transparent).
|
| Method Attributes | Method Name and Description |
|---|---|
|
draw(c, getbounds, x, y, width, height)
|
|
|
drawText(bounds, text)
|
|
|
ellipse(cx, cy, width, height)
|
|
|
ellipsePath(ctx, centerX, centerY, width, height)
|
|
|
polygon(points)
|
|
| <inner> |
polygonBounds(points, r)
|
|
rectangle(x, y, width, height)
|
|
|
rectPath(x, y, width, height)
|
|
|
roundRect(x, y, width, height, xr, yr, corners)
Draws a rectangle with rounded corners
|
|
|
textHeight(text)
|
|
|
textWidth(text)
|
Class Detail
Tee.Format(chart)
- Parameters:
- {Tee.Chart} chart
- The parent chart this format object belongs to.
Field Detail
{Color}
fill
Color used to paint contents interior.
{Tee.Font}
font
Properties to fill text.
{Tee.Gradient}
gradient
Gradient properties to fill contents.
{Tee.ChartImage}
image
Image to fill background.
{Tee.Point}
round
Width and height of rectangle rounded corners.
{Tee.Shadow}
shadow
Properties to draw a backdrop shadow.
{Tee.Stroke}
stroke
Properties to draw lines around boundaries.
{Number}
transparency
Controls the transparency, from 0 (opaque) to 1 (transparent).
Method Detail
draw(c, getbounds, x, y, width, height)
- Parameters:
- c
- getbounds
- x
- y
- width
- height
drawText(bounds, text)
- Parameters:
- bounds
- text
ellipse(cx, cy, width, height)
- Parameters:
- cx
- cy
- width
- height
ellipsePath(ctx, centerX, centerY, width, height)
- Parameters:
- ctx
- centerX
- centerY
- width
- height
polygon(points)
- Parameters:
- points
<inner>
polygonBounds(points, r)
- Parameters:
- points
- r
rectangle(x, y, width, height)
- Parameters:
- x
- y
- width
- height
rectPath(x, y, width, height)
- Parameters:
- x
- y
- width
- height
{CanvasRenderingContext2D}
roundRect(x, y, width, height, xr, yr, corners)
Draws a rectangle with rounded corners
- Parameters:
- {Number} x
- Position in pixels of left side of rectangle.
- {Number} y
- Position in pixels of top side of rectangle.
- {Number} width
- Amount in pixels of rectangle width.
- {Number} height
- Amount in pixels of rectangle height.
- {Number} xr
- Amount in pixels of corners radius width.
- {Number} yr
- Amount in pixels of corners radius height.
- {Boolean[]} corners Optional
- Optional, defines to paint top-left, top-right, bottom-left and bottom-right corners.
- Returns:
- {CanvasRenderingContext2D} Returns the canvas 2D context
{Number}
textHeight(text)
- Parameters:
- text
- Returns:
- {Number} Returns the height in pixels of a given text using current font size and attributes.
{Number}
textWidth(text)
- Parameters:
- text
- Returns:
- {Number} Returns the width in pixels of a given text using current font size and attributes.