Ray annotation allows to add a ray to the chart, as any other annotation it can be drawn by user or added to the chart via XML or JSON settings. In this article you can learn how to add a ray via XML or JSON settings and what visual settings can be done.
To learn about basic settings, that can be done with an annotation please refer to: Drawing Tools and Annotations: General Settings.
To add a Ray annotation to a chart you need to, as with any other annotation, add an annotation node, assign the id, set "Ray" type and specify the chart id using chart attribute.
In ray_annotation node you need specify value and time anchors, which define start point a Ray, and the second point, which defines ray direction.
All this you can see in the basic XML/JSON snippet below:
01 |
<?xml version="1.0" encoding="UTF-8"?> |
02 |
<stock xmlns="http://anychart.com/products/stock/schemas/1.9.0/schema.xsd"> |
03 |
<annotations> |
04 |
<annotation_list> |
05 |
<annotation id="idRayAnnotation1" type="Ray" chart="idMainChart"> |
06 |
<ray_annotation first_time_anchor="2008-08-20" first_value_anchor="24.92" second_time_anchor="2008-12-18" second_value_anchor="14.79" /> |
07 |
</annotation> |
08 |
</annotation_list> |
09 |
</annotations> |
10 |
</stock> |
01 | { |
02 | annotations: { |
03 | annotationList: [ |
04 | { |
05 | id: "idRayAnnotation1", |
06 | type: "Ray", |
07 | chart: "idMainChart", |
08 | rayAnnotation: { |
09 | firstTimeAnchor: "2008-08-20", |
10 | firstValueAnchor: 24.92, |
11 | secondTimeAnchor: "2008-12-18", |
12 | secondValueAnchor: 14.79 |
13 | } |
14 | } |
15 | ] |
16 | } |
17 | } |
Live sample below shows a chart with this sample basic Ray annotation:
You have a total control over the look of the Ray, to define visual settings you need to add settings node and then use line node to set how it should look like. Sample XML/JSON snippet below shows this.
If you click on line node in the snippet, XML or JSON reference will be opened and you will be able to browse all possible settings, including the look of the line in different states.
01 |
<?xml version="1.0" encoding="UTF-8"?> |
02 |
<stock xmlns="http://anychart.com/products/stock/schemas/1.9.0/schema.xsd"> |
03 |
<annotations> |
04 |
<annotation_list> |
05 |
<annotation id="Ray_0843384555" type="Ray" chart="idMainChart"> |
06 |
<ray_annotation color="#DB2A0E" first_time_anchor="2009-01-27 08:40:36.016" first_value_anchor="22.27" second_time_anchor="2009-04-07 20:49:26.439" second_value_anchor="27.92"> |
07 |
<settings> |
09 |
</settings> |
10 |
</ray_annotation> |
11 |
</annotation> |
12 |
</annotation_list> |
13 |
</annotations> |
14 |
</stock> |
01 | { |
02 | annotations: { |
03 | annotationList: [ |
04 | { |
05 | id: "Ray_0843384555", |
06 | type: "Ray", |
07 | chart: "idMainChart", |
08 | rayAnnotation: { |
09 | color: "#DB2A0E", |
10 | firstTimeAnchor: "2009-01-27 08:40:36.016", |
11 | firstValueAnchor: 22.27, |
12 | secondTimeAnchor: "2009-04-07 20:49:26.439", |
13 | secondValueAnchor: 27.92, |
14 | settings: { |
15 | line: { |
16 | dashed: true, |
17 | thickness: 1, |
18 | opacity: 1 |
19 | } |
20 | } |
21 | } |
22 | } |
23 | ] |
24 | } |
25 | } |
Live sample below contains several Ray annotations colored and configured in a different way:
