Class: Annotation

Annotation

Represents a rectangle containing text

new Annotation

Parameters:
Name Type Argument Default Description
chart Tee.Chart The parent chart this annotation belongs to.
text String The text to draw inside the annotation.
x Number <optional>
10 Optional left side position in pixels.
y Number <optional>
10 Optional top side position in pixels.
Properties:
Name Type Description
margins Tee.Margins Properties to control spacing between text and rectangle boundaries.
visible Boolean When true, the annotation is displayed.
transparent Boolean When true, the annotation background is not displayed. Only the text is painted.
format Tee.Format Properties to control the annotation background and text appearance.
Source:
  • ../../src/teechart.js, line 1210

Extends

Members

position

Properties:
Name Type Description
position Tee.Point Top-left coordinates of annotation rectangle. `* @default x:10, y:10
Source:
  • ../../src/teechart.js, line 1217

Methods

clicked

Source:
  • ../../src/teechart.js, line 1367
Returns:
Returns if Tee.Point p is inside this Annotation bounds.
Type
Boolean