Guide – amCharts Version 2 Documentation

Type class

Guides are straight vertical or horizontal lines or areas supported by AmSerialChart, AmXYChart and AmRadarChart. You can have guides both on value and category axes. To add/remove a guide to an axis, use axis.addGuide(guide)/axis.removeGuide(guide) methods.

If you do not set properties such as dashLength, lineAlpha, lineColor, etc - values of the axis are used.

Inheritance

Guide does not extend any other symbol.

Guide is not extended by any other symbol.

Properties

above #	Type `boolean` Default `false` If you set it to true, the guide will be displayed above the graphs.
angle #	Type `number` Radar chart only. Specifies angle at which guide should start. Affects only fills, not lines.
balloonColor #	Type `string` Baloon fill color.
balloonText #	Type `string` The text which will be displayed if the user rolls-over the guide.
category #	Type `string` Category of the guide (in case the guide is for category axis).
dashLength #	Type `number` Dash length.
date #	Type `Date` Date of the guide (in case the guide is for category axis and parseDates is set to true).
fillAlpha #	Type `number` Fill opacity. Value range is 0 - 1.
fillColor #	Type `string` Fill color.
fontSize #	Type `number` Font size of guide label.
inside #	Type `boolean` Specifies whether label should be placed inside or outside plot area.
label #	Type `string` The label which will be displayed near the guide.
labelRotation #	Type `number` Rotation angle of a guide label.
lineAlpha #	Type `number` Line opacity.
lineColor #	Type `string` Line color.
lineThickness #	Type `number` Line thickness.
position #	Type `string` Position of guide label. Possible values are "left" or "right" for horizontal axis and "top" or "bottom" for vertical axis.
tickLength #	Type `number` Tick length.
toAngle #	Type `number` Radar chart only. Specifies angle at which guide should end. Affects only fills, not lines.
toCategory #	Type `string` "To" category of the guide (in case the guide is for category axis).
toDate #	Type `Date` "To" date of the guide (in case the guide is for category axis and parseDates is set to true) If you have both date and toDate, the space between these two dates can be filled with color.
toValue #	Type `number` "To" value of the guide (in case the guide is for value axis).
value #	Type `number` Value of the guide (in case the guide is for value axis).

Methods

Guide does not have any methods.

Events

Guide does not have any events.

Adapters

Guide does not have any adapters.