Type class
Creates an axis for AmAngularGauge charts, multiple can be assigned.
Example
var chart = AmCharts.makeChart("chartdiv",{ ... "axes": [ { "startValue": 0, "endValue": 100, "valueInterval": 10, "bands": [ { "startValue": 0, "endValue": 100 } ] } ] });
Inheritance
GaugeAxis does not extend any other symbol.
GaugeAxis is not extended by any other symbol.
Properties
axisAlpha # |
Type Default Axis opacity. |
---|---|
axisColor # |
Type Default Axis color. |
axisThickness # |
Type Default Thickness of the axis outline. |
bandAlpha # |
Type Default Opacity of band fills. |
bandGradientRatio # |
Type Default Example: [-0.2, 0, -0.2]. Will make bands to be filled with color gradients. Negative value means the color will be darker than the original, and positive number means the color will be lighter. |
bandOutlineAlpha # |
Type Default Opacity of band outlines. |
bandOutlineColor # |
Type Default Color of band outlines. |
bandOutlineThickness # |
Type Default Thickness of band outlines. |
bands # |
Type Array of bands - GaugeBand objects. Bands are used to draw color fills between specified values. |
bottomText # |
Type Text displayed below the axis center. |
bottomTextBold # |
Type Default Specifies if text should be bold. |
bottomTextColor # |
Type Bottom text color. |
bottomTextFontSize # |
Type Font size of bottom text. |
bottomTextYOffset # |
Type Default Y offset of bottom text. |
centerX # |
Type Default X position of the axis, relative to the center of the gauge. |
centerY # |
Type Default Y position of the axis, relative to the center of the gauge. |
color # |
Type Specifies labels color of the axis. |
endAngle # |
Type Default Axis end angle. Valid values are from - 180 to 180. |
endValue # |
Type Axis end (max) value |
fontSize # |
Type Font size for axis labels. |
gridCount # |
Type Default Number of grid lines. Note, GaugeAxis doesn't adjust gridCount, so you should check your values and choose a proper gridCount which would result grids at round numbers. |
gridInside # |
Type Default Specifies if grid should be drawn inside or outside the axis. |
id # |
Type Unique id of an axis. |
inside # |
Type Default Specifies if labels should be placed inside or outside the axis. |
labelFrequency # |
Type Default Frequency of labels. |
labelFunction # |
You can use this function to format axis labels. This function is called and value is passed as a attribute: labelFunction(value); |
labelOffset # |
Type Default Distance from axis to the labels. |
labelsEnabled # |
Type Default Specifies if labels on the axis should be shown. |
listeners # |
Type You can add listeners of events using this property. Example: listeners = [{"event":"clickBand", "method":handleClick}]; |
minorTickInterval # |
Type Interval, at which minor ticks should be placed. |
minorTickLength # |
Type Default Length of a minor tick. |
radius # |
Type Default Axis radius. |
showFirstLabel # |
Type Default Specifies if the first label should be shown. |
showLastLabel # |
Type Default Specifies if the last label should be shown. |
startAngle # |
Type Default Axis start angle. Valid values are from - 180 to 180. |
startValue # |
Type Default Axis start (min) value. |
tickAlpha # |
Type Default Opacity of axis ticks. |
tickColor # |
Type Default Color of axis ticks. |
tickLength # |
Type Default Length of a major tick. |
tickThickness # |
Type Default Tick thickness. |
topText # |
Type Text displayed above the axis center. |
topTextBold # |
Type Default Specifies if text should be bold. |
topTextColor # |
Type Color of top text. |
topTextFontSize # |
Type Font size of top text. |
topTextYOffset # |
Type Default Y offset of top text. |
unit # |
Type A string which can be placed next to axis labels. |
unitPosition # |
Type Default Position of the unit. |
usePrefixes # |
Type Default Specifies if small and big numbers should use prefixes to make them more readable. |
valueInterval # |
Type Interval, at which ticks with values should be placed. |
Methods
addListener( |
Returns Adds event listener to the object. type - string like 'clickBand' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens |
---|---|
removeListener( |
Returns Removes event listener from chart object. chart - chart object, type - event name, handler - method |
setBottomText( |
Returns Sets bottom text. text - string |
setTopText( |
Returns Sets top text. text - string |
value2angle( |
Returns Returns angle of the value. value - Number |
Events
#clickBand |
Param Event which is fired when user clicks on gauge band. |
---|---|
#rollOutBand |
Param Event which is fired when user rolls-out gauge band. |
#rollOverBand |
Param Event which is fired when user rolls-over gauge band. |
Adapters
GaugeAxis does not have any adapters.