Creates a horizontal/vertical guideline-/area for AmSerialChart, AmXYChart and AmRadarChart charts, automatically adapts it's settings from the axes if none has been specified.

Example

var chart = AmCharts.makeChart("chartdiv",{
  ...
  "guides": [
    {
      "fillAlpha": 0.10,
      "value": 0,
      "toValue": 10
    }
  ]
});

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.
balloonColorColorBaloon fill color.
balloonTextStringThe text which will be displayed if the user rolls-over the guide.
boldLabelBooleanfalseSpecifies if label should be bold or not.
categoryStringCategory of the guide (in case the guide is for category axis).
colorColorColor of a guide label.
dashLengthNumberDash length.
dateDateDate of the guide (in case the guide is for category axis and parseDates is set to true).
expandBooleanfalseWorks if a guide is added to CategoryAxis and this axis is non-date-based. If you set it to true, the guide will start (or be placed, if it's not a fill) on the beginning of the category cell and will end at the end of toCategory cell.
fillAlphaNumberFill opacity. Value range is 0 - 1.
fillColorColorFill color.
fontSizeNumberFont size of guide label.
idStringUnique id of a Guide. You don't need to set it, unless you want to.
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.
lineColorColorLine 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).
valueAxisValueAxisValue axis of a guide. As you can add guides directly to the chart, you might need to specify which which value axis should be used.

Methods

Guide class does not have any methods.

Events

Guide class does not have any events.