5.1.1 Drawing properties

Drawings can have the following properties. Each drawing must have a type and an array of points[]. The number of required points depends on the type of drawing: one for a horizontal line, two for a rectangle etc

Some properties are only applicable to some types of drawing (e.g. text, icon).

Property

Description

type

Type of drawing, e.g. "lineSegment"

points[]

Array of points, each one consisting of a date and a value. For example: points: [{date: data.barData.date[0]}, value: data.barData.high[0]}]

For text and rectangle drawings, the points can also be pixel co-ordinates (from the top-left of the chart), instead of time-price co-ordinates. For example: points: [{x:100, y:100}, {x:200, y:200}]

style

Graphical style for the drawing, consisting of line and/or fill and/or text sub-objects depending on the type of drawing

style.line

Can contain the properties color, width, and lineStyle. The style of the line can be "solid", "dash", or "dot". For some types of drawing, such as lines, the style can also be any character from the Font Awesome font, in the form "icon-aaaa" where "aaaa" is the hex code of the character, such as "f0ab".

style.fill

Can contain a color property, specifying fill color

style.text

Can contain the properties color, fontFamily, fontSize, and fontStyle

inMainPanel

Only applicable to indicators which are displayed in their own sub-panel (isOverlay:false). Controls whether the drawing is created in the indicator's sub-panel or in the main chart panel.

unselectable

If true, makes the drawing completely unselectable (and unmoveable, and undeletable)

moveable

If true, allows the user to move the drawing

removable

If true, allows the user to delete the drawing

showInBackground

Controls whether the drawing is shown in front of the bars, or behind them

text

Text to display

icon

Icon to display, as a hex code of a character from the Font Awesome character set, such as "f0ab"

iconSize

Size, in pixels, for the icon

markerOffset

For the barMarker drawing type, offsets the position of the marker from the price by the specified number of pixels (negative for above, positive for below)

textAboveLine

Boolean value which positions text above the centre of the drawing (e.g. above a horizontal line or a bar marker) rather than below it

Last updated