addAnnotation() Method

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

Description

Adds new annotation to the chart.
This function can be called only onChartDraw event has been fired, if you call addAnnotation prior to that - no annotation is added.

Parameters

• config: Object or XML String

  Annotation config, which defines the type of annotation and other settings. It can be both in XML and JSON format.
  
  See <annotation> element in XML Reference or annotation object in JSON Reference.
  
  Note: When you use XML, type and chart attributes are required. When you use JSON type and chart properties are required.

Returns

Boolean.

Note: If "true" - annotation is added successfully, in the opposite case - "false" is returned.

Samples

Add annotation using JSON:

chart.addAnnotation({ type: "HorizontalLine", chart: "idMainChart", horizontalLineAnnotation: { valueAnchor: 27.3, color: "#FF0000" } });
Add annotation using XML:

chart.addAnnotation("<annotation type='HorizontalLine' chart='idMainChart'><horizontal_line_annotation value_anchor='24.3' color='#0000FF'/></annotation>");
Sample:

See also

removeAnnotation()