Important version information!

You are browsing a class reference for Version 2 of the JavaScript Charts. If you are using Version 3 (current), please click here.

Guide

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.

Properties

PropertyTypeDefaultDescription
aboveBooleanfalseIf you set it to true, the guide will be displayed above the graphs.
angleNumberRadar chart only. Specifies angle at which guide should start. Affects only fills, not lines.
balloonColorStringBaloon fill color.
balloonTextStringThe text which will be displayed if the user rolls-over the guide.
categoryStringCategory of the guide (in case the guide is for category axis).
dashLengthNumberDash length.
dateDateDate of the guide (in case the guide is for category axis and parseDates is set to true).
fillAlphaNumberFill opacity. Value range is 0 - 1.
fillColorStringFill color.
fontSizeNumberFont size of guide label.
insideBooleanSpecifies whether label should be placed inside or outside plot area.
labelStringThe label which will be displayed near the guide.
labelRotationNumberRotation angle of a guide label.
lineAlphaNumberLine opacity.
lineColorStringLine color.
lineThicknessNumberLine thickness.
positionStringPosition of guide label. Possible values are "left" or "right" for horizontal axis and "top" or "bottom" for vertical axis.
tickLengthNumberTick length.
toAngleNumberRadar chart only. Specifies angle at which guide should end. Affects only fills, not lines.
toCategoryString"To" category of the guide (in case the guide is for category axis).
toDateDate"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.
toValueNumber"To" value of the guide (in case the guide is for value axis).
valueNumberValue of the guide (in case the guide is for value axis).

Methods

Guide class does not have any methods.

Events

Guide class does not have any events.