new freeform()
Freeform drawing tool. Set splineTension to a value from 0 to 1 (default .3). This is a dragToDraw function and automatically disables the crosshairs while enabled.
It inherits its properties from CIQ.Drawing.segment.
- Version:
-
- ChartIQ Advanced Package
Methods
-
reconstruct(stx [, obj])
-
Reconstruct a freeform drawing. It is not recommended to do this programmatically.
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 line color
pnl
string <optional>
The panel name
ptrn
string <optional>
Pattern for line "solid","dotted","dashed". Defaults to solid.
lw
number <optional>
Line width. Defaults to 1.
cw
number <optional>
Candle width from original drawing
mlt
number <optional>
Y-axis multiplier from original drawing
v0
number <optional>
Value (price) for the first point
d0
number <optional>
Date (string form) for the first point
int
number <optional>
Interval from original drawing
pd
number <optional>
Periodicity from original drawing
tzo0
number <optional>
Offset of UTC from d0 in minutes
nodes
array <optional>
An array of nodes in form [x0a,x0b,y0a,y0b, x1a, x1b, y1a, y1b, ....]
fld
string <optional>
Field which drawing is associated with
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.