new annotation()
Annotation drawing tool. An annotation is a simple text tool. It uses the class stx_annotation to determine the font style and color for the annotation. Class stx_annotation_highlight_bg is used to determine the background color when highlighted.
The controls controls.annotationSave and controls.annotationCancel are used to create HTMLElements for saving and canceling the annotation while editing. A textarea is created dynamically. The annotation tool attempts to draw the annotations at the same size and position as the textarea so that the effect is wysiwig.
- Since:
-
8.8.0 Added support for emoji short names, which resolve into emojis.
- See:
Methods
-
reconstruct(stx [, obj])
-
Reconstruct an annotation
Parameters:
Name Type Argument Description stx
CIQ.ChartEngine The chart object
obj
object <optional>
A drawing descriptor
Properties
Name Type Argument Description col
string <optional>
The text color for the annotation
pnl
string <optional>
The panel name
d0
string <optional>
String form date or date time
v0
number <optional>
The value at which to position the annotation
fld
string <optional>
Field which drawing is associated with
text
string <optional>
The annotation text (escaped using encodeURIComponent())
tzo0
number <optional>
Offset of UTC from d0 in minutes
bc
string <optional>
Border color
bg
string <optional>
Background color
lw
string <optional>
Line width
ptrn
string <optional>
Line pattern
fnt
object <optional>
Font
Properties
Name Type Argument Description st
object <optional>
Font style
sz
object <optional>
Font size
wt
object <optional>
Font weight
fl
object <optional>
Font family
prm
number <optional>
Whether the drawing is permanent
hdn
number <optional>
Whether the drawing is hidden
- Since:
-
9.0.0 Added
prm
andhdn
property toobj
parameter.