Guide – amCharts Version 3 Documentation

Type class

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
    }
  ]
});

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 `color` Baloon fill color.
balloonText #	Type `string` The text which will be displayed if the user rolls-over the guide.
boldLabel #	Type `boolean` Default `false` Specifies if label should be bold or not.
category #	Type `string` Category of the guide (in case the guide is for category axis).
color #	Type `color` Color of a guide label.
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).
expand #	Type `boolean` Default `false` Works 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.
fillAlpha #	Type `number` Fill opacity. Value range is 0 - 1.
fillColor #	Type `color` Fill color.
fontSize #	Type `number` Font size of guide label.
id #	Type `string` Unique id of a Guide. You don't need to set it, unless you want to.
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 `color` 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).
valueAxis #	Type `ValueAxis` Value 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 does not have any methods.

Events

Guide does not have any events.

Adapters

Guide does not have any adapters.