startDrawingAnnotation() Method

• Description
• Parameters
• Return type
• Samples
• See also

Description

Starts drawing annotation of a given type.

If the drawing started successfuly, fires onAnnotationDrawingStart event. When all required points of annotation are added to the chart, component leaves drawing mode and fires onAnnotationDrawingFinish event. If you want to leave drawing mode compulsory you need to use stopDrawingAnnotation() method.

Note: You can call this method only after onChartDraw is fired.

Parameters

• type: String

  Sets annotation type. Can be:
  Line
  VerticalLine
  HorizontalLine
  InfiniteLine
  Ray
  Rectangle
  Ellipse
  Triangle
  TrendChannel
  AndrewsPitchfork
  FibonacciFan
  FibonacciArc
  FibonacciRetracement
  FibonacciTimezones
  Arrow
  Label

• [optional] config: Object or XML String

  Sets additional options, such as color, line width, text style and so on. It is optional and default settings are used if it is not set.
  
  Settings can be defined as:

  • JSON object of annotation type, note that: type, chart and axis are ignored in this case.
  
  
  • XML srting formatted as <annotation> node, note that: type, chart and axis attributes are ignored in this case.
  
  Note: To set anything you want you don't have to put all JSON or XML attributes and values, you can specify only the things you want to be not like in default.
  

Returns

Boolean.

Returns "true", if annotation is added successfully, returns "true" - if drawing is impossible.

Samples

Calling sample - simple line drawing:

chart.startDrawingAnnotation("Line");

Calling sample - Line with additional settings in JSON format:

chart.startDrawingAnnotation("Line", { lineAnnotation: { color: "Green", settings: { line: { thickness: 3, dashed: true, dashLength: 7, dashSpace: 5, opacity: 0.5 } } } });

Calling sample - Line with additional settings in XML format:

chart.startDrawingAnnotation("Line", "<annotation><line_annotation color='Green'><settings><line thickness='3' dashed='true' dash_length='7' dash_space='5' opacity='0.5'/></settings></line_annotation></annotation>");

Calling sample - Label with additional font, background and position settings in JSON format:

chart.startDrawingAnnotation("Label", { labelAnnotation: { color: "#990000", anchor: "Center", xPadding: 0, yPadding: 0, allowTextEdit: true, settings: { font: { family: "Tahoma", size: 14, bold: true, italic: false, align: "Center" }, background: { fill: { type: "Solid", color: "#FFFFFF", opacity: 1 }, border: { thickness: 2, color: "#772222", opacity: 1 }, corners: { type: "Square" } } } } });

Sample:

See also

stopDrawingAnnotation()