Class Tee.Annotation
Extends
Tee.Tool.
Represents a rectangle containing text
Defined in: <..\..\src\teechart.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Tee.Annotation(chart, text, x, y)
|
| Field Attributes | Field Name and Description |
|---|---|
|
Properties to control the annotation background and text appearance.
|
|
|
Properties to control spacing between text and rectangle boundaries.
|
|
|
When true, the annotation background is not displayed.
|
|
|
When true, the annotation is displayed.
|
| Method Attributes | Method Name and Description |
|---|---|
|
add(text)
|
|
|
clicked(p)
|
|
|
doDraw()
|
|
|
draw()
|
|
|
mousemove(p)
|
|
|
moveTo(x, y)
|
|
|
resize()
|
Class Detail
Tee.Annotation(chart, text, x, y)
- Parameters:
- {Tee.Chart} chart
- The parent chart this annotation belongs to.
- {String} text
- The text to draw inside the annotation.
- {Number} x Optional, Default: 10
- Optional left side position in pixels.
- {Number} y Optional, Default: 10
- Optional top side position in pixels.
Field Detail
{Tee.Format}
format
Properties to control the annotation background and text appearance.
{Tee.Margins}
margins
Properties to control spacing between text and rectangle boundaries.
position
{Boolean}
transparent
When true, the annotation background is not displayed. Only the text is painted.
{Boolean}
visible
When true, the annotation is displayed.
Method Detail
add(text)
- Parameters:
- text
{Boolean}
clicked(p)
- Parameters:
- p
- Returns:
- {Boolean} Returns if Tee.Point p is inside this Annotation bounds.
doDraw()
draw()
forceDraw()
mousemove(p)
- Parameters:
- p
moveTo(x, y)
- Parameters:
- x
- y
resize()