Inheritance: ValueAxisAxisBase

Extension for ValueAxis to create an axis for AmSerialChart, AmRadarChart, AmXYChart charts, multiple can be assigned.
Gets automatically populated, one for AmSerialChart and two for AmXYChart charts, if none has been specified.

Example

var chart = AmCharts.makeChart("chartdiv",{
  ...
  "valueAxes": [
    {
      "title": "Axis title"
    }
  ]
});

Properties Hide inherited

PropertyTypeDefaultDescription
autoGridCountBooleantrueSpecifies whether number of gridCount is specified automatically, acoarding to the axis size.
autoRotateAngleNumberAngle of label rotation, if the number of series exceeds autoRotateCount. Works on horizontal axis only. It is not recommended to use it with charts with zoom/scroll features, as chart adjusts margin only based on initial render.
autoRotateCountNumberIf the number of category axis items will exceed the autoRotateCount, the labels will be rotated by autoRotateAngle degree. Works on horizontal axis only. Not recommended with scrollable/zoomable charts.
autoWrapBooleanfalseIf this is set to true and the label does not fit, it will be wrapped. Works only on horizontal value axes.
axisAlphaNumber1Axis opacity. Value range is 0 - 1.
axisColorColor#000000Axis color.
axisFrequencyNumber1Works with Radar chart only. If you have a big number of axes, this property will help you to show every x axis only.
axisThicknessNumber1Thickness of the axis.
axisTitleOffsetNumber10Radar chart only. Specifies distance from axis to the axis title (category)
axisXNumberRead-only. Returns x coordinate of the axis.
axisYNumberRead-only. Returns y coordinate of the axis.
balloonAmBalloonAmBalloonAllows customizing axes balloons individually.
balloonTextFunctionObjectYou can use this function to format balloon text of the axis. This function is called and balloon text or date (if axis is date-based) is passed as an argument. It should return string which will be displayed in the balloon.
baseCoordNumberRead-only. Coordinate of the base value.
baseValueNumber0Specifies base value of the axis.
boldLabelsBooleanfalseSpecifies if axis labels should be bold or not.
boldPeriodBeginningBooleantrueWhen parse dates is on for the category axis, the chart will try to highlight the beginning of the periods, like month, in bold. Set this to false to disable the functionality.
centerLabelOnFullPeriodBooleantrueThis setting works only when parseDates is set to true and equalSpacing is set to false. In case you set it to false,
labels will never be centered between grid lines.
centerLabelsBooleanfalseForce-centers labels of date-based axis (in case it's category axis, equalSpacing must be false)
centerRotatedLabelsBooleanfalseIn case you have rotated labels on horizontal axis, you can force-center them using this property.
colorColorColor of axis value labels. Will use chart's color if not set.
dashLengthNumber0Length of a dash. 0 means line is not dashed.
dateFormatsArray[Object][{"period":"fff","format":"JJ:NN:SS"},{"period":"ss","format":"JJ:NN:SS"},{"period":"mm","format":"JJ:NN"},{"period":"hh","format":"JJ:NN"},{"period":"DD","format":"MMM DD"},{"period":"WW","format":"MMM DD"},{"period":"MM","format":"MMM"},{"period":"YYYY","format":"YYYY"}]Date formats of different periods. Possible period values: fff - milliseconds, ss - seconds, mm - minutes, hh - hours, DD - days, MM - months, WW - weeks, YYYY - years. Check this page for date formatting strings.
durationStringIf your values represents time units, and you want value axis labels to be formatted as duration, you have to set the duration unit. Possible values are: "ss", "mm", "hh" and "DD".
durationUnitsObject{DD:'d. ', hh:':', mm:':',ss:''}If duration property is set, you can specify what string should be displayed next to day, hour, minute and second.
fillAlphaNumber0Fill opacity. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills.
fillColorColor#FFFFFFFill color. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills.
firstDayOfWeekNumber1Sets first day of the week. 0 is Sunday, 1 is Monday, etc.
fontSizeNumberSize of value labels text. Will use chart's fontSize if not set.
gridAlphaNumber0.15Opacity of grid lines.
gridColorColor#000000Color of grid lines.
gridCountNumber5Number of grid lines. In case this is value axis, or your categoryAxis parses dates, the number is approximate. The default value is 5. If you set autoGridCount to true, this property is ignored.
gridThicknessNumber1Thickness of grid lines.
gridTypeStringpolygonsRadar chart only. Possible values are: "polygons" and "circles". Set "circles" for polar charts.
guidesArray[Guide][]The array of guides belonging to this axis.
idStringUnique id of value axis. It is not required to set it, unless you need to tell the graph which exact value axis it should use.
ignoreAxisWidthBooleanfalseIf autoMargins of a chart is set to true, but you want this axis not to be measured when calculating margin, set ignoreAxisWidth to true.
includeAllValuesBooleanfalseIf you set it to true, minimum and maximum of value axis will not change while zooming/scrolling.
includeGuidesInMinMaxBooleanfalseSpecifies whether guide values should be included when calculating min and max of the axis.
includeHiddenBooleanfalseIf true, the axis will include hidden graphs when calculating min and max values.
insideBooleanfalseSpecifies whether values should be placed inside or outside plot area.
integersOnlyBooleanfalseSpecifies whether values on axis can only be integers or both integers and doubles.
labelFrequencyNumber1Frequency at which labels should be placed. Doesn't work for CategoryAxis if parseDates is set to true.
labelFunctionYou can use this function to format Value axis labels. This function is called and these parameters are passed: labelFunction(value, valueText, valueAxis);
Where value is numeric value, valueText is formatted string and valueAxis is a reference to valueAxis object.

If axis type is "date", labelFucntion will pass different arguments:
labelFunction(valueText, date, valueAxis)

Your function should return string.
labelOffsetNumber0You can use it to adjust position of axes labels. Works both with CategoryAxis and ValueAxis.
labelRotationNumber0Rotation angle of a label. Only horizontal axis' values can be rotated. If you set this for vertical axis, the setting will be ignored. Possible values from -90 to 90.
labelsEnabledBooleantrueSpecifies whether axis displays category axis' labels and value axis' values.
listenersArray[Object]You can add listeners of events using this property. Example: listeners = [{"event":"clickItem", "method":handleEvent}];
logarithmicBooleanfalseSpecifies if this value axis' scale should be logarithmic.
markPeriodChangeBooleantrueIf you set it to false, the start of longer periods won't use a different date format and won't be bold.
maxNumberRead-only. Maximum value of the axis.
maximumNumberIf you don't want max value to be calculated by the chart, set it using this property. This value might still be adjusted so that it would be possible to draw grid at rounded intervals.
maximumDateDateIf your value axis is date-based, you can specify maximum date of the axis. Can be set as date object, timestamp number or string if dataDateFormat is set.
minNumberRead-only. Minimum value of the axis.
minHorizontalGapNumber75This property is used when calculating grid count (when autoGridCount is true). It specifies minimum cell width required for one span between grid lines.
minimumNumberIf you don't want min value to be calculated by the chart, set it using this property. This value might still be adjusted so that it would be possible to draw grid at rounded intervals.
minimumDateDateIf your value axis is date-based, you can specify minimum date of the axis. Can be set as date object, timestamp number or string if dataDateFormat is set.
minMaxMultiplierNumber1If set value axis scale (min and max numbers) will be multiplied by it. I.e. if set to 1.2 the scope of values will increase by 20%.
minorGridAlphaNumber0.07Opacity of minor grid. In order minor to be visible, you should set minorGridEnabled to true.
minorGridEnabledBooleanfalseSpecifies if minor grid should be displayed.

NOTE: If equalSpacing is set to true, this setting will be ignored.
minorTickLengthNumber0Length of minor grid tick.
minPeriodStringDDSpecifies the shortest period of your data. This will work only if you set the `type` of your value axis to `"date"`.

Possible period values: fff - milliseconds, ss - seconds, mm - minutes, hh - hours, DD - days, MM - months, YYYY - years.

It's also possible to supply a number for increments, i.e. "15mm" which will instruct the chart that your data is supplied in 15 minute increments.
minVerticalGapNumber35This property is used when calculating grid count (when autoGridCount is true). It specifies minimum cell height required for one span between grid lines.
offsetNumber0The distance of the axis to the plot area, in pixels. Negative values can also be used.
pointPositionStringaxisWorks with radar charts only. If you set it to “middle”, labels and data points will be placed in the middle between axes.
positionStringleftPossible values are: "top", "bottom", "left", "right". If axis is vertical, default position is "left". If axis is horizontal, default position is "bottom".
precisionNumberPrecision (number of decimals) of values.
radarCategoriesEnabledBooleantrueRadar chart only. Specifies if categories (axes' titles) should be displayed near axes)
recalculateToPercentsBooleanfalseSpecifies if graphs's values should be recalculated to percents.
reversedBooleanfalseSpecifies if value axis should be reversed (smaller values on top).
showFirstLabelBooleantrueWhether to show first axis label or not. This works properly only on ValueAxis. With CategoryAxis it wont work 100%, it depends on the period, zooming, etc. There is no guaranteed way to force category axis to show or hide first label.
showLastLabelBooleantrueWhether to show last axis label or not. This works properly only on ValueAxis. With CategoryAxis it wont work 100%, it depends on the period, zooming, etc. There is no guaranteed way to force category axis to show or hide last label.
stackTypeStringnoneStacking mode of the axis. Possible values are: "none", "regular", "100%", "3d".
Note, only graphs of one type will be stacked.
stepNumberRead-only. Value difference between two grid lines.
strictMinMaxBooleanfalseIf you set minimum and maximum for your axis, chart adjusts them so that grid would start and end on the beginning and end of plot area and grid would be at equal intervals. If you set strictMinMax to true, the chart will not adjust minimum and maximum of value axis.
synchronizationMultiplierNumberIn case you synchronize one value axis with another, you need to set the synchronization multiplier. Use synchronizeWithAxis method to set with which axis it should be synced.
synchronizeWithValueAxisOne value axis can be synchronized with another value axis. You can use both reference to your axis or id of the axis here. You should set synchronizationMultiplyer in order for this to work.
tickLengthNumber5Length of the tick marks.
titleStringTitle of the axis.
titleBoldBooleantrueSpecifies if title should be bold or not.
titleColorColorColor of axis title. Will use text color of chart if not set any.
titleFontSizeNumberFont size of axis title. Will use font size of chart plus two pixels if not set any.
titleRotationNumberRotation of axis title. Useful if you want to make vertical axis title to be shown from top to down.
totalTextStringIf this value axis is stacked and has columns, setting valueAxis.totalText = "[[total]]" will make it to display total value above the most-top column.
totalTextColorColorColor of total text.
totalTextOffsetNumber0Distance from data point to total text.
treatZeroAsNumber0This allows you to have logarithmic value axis and have zero values in the data. You must set it to >0 value in order to work.
typeStringnumericType of value axis. If your values in data provider are dates and you want this axis to show dates instead of numbers, set it to "date".
unitStringUnit which will be added to the value label.
unitPositionStringrightPosition of the unit. Possible values are "left" and "right".
usePrefixesBooleanfalseIf true, prefixes will be used for big and small numbers. You can set arrays of prefixes directly to the chart object via prefixesOfSmallNumbers and prefixesOfBigNumbers.
useScientificNotationBooleanfalseIf true, values will always be formatted using scientific notation (5e+8, 5e-8...) Otherwise only values bigger then 1e+21 and smaller then 1e-7 will be displayed in scientific notation.
zeroGridAlphaNumberOpacity of a zero grid line. By default it is equal to 2 x gridAlpha.

Methods Hide inherited

NameParametersReturnsDescription
addGuide(guide)guide - instance of GuideAdds guide to the axis.
addListener(type, handler)type - string like 'axisChanged' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens Adds event listener to the object.
coordinateToValue(coordinate)coordinate - y or x coordinate, in pixels.Number, - value of coordinate.Returns value of the coordinate.
getCoordinate(value)value - NumberNumber - coordinateReturns coordinate of the value in pixels.
removeGuide(guide)guide - instance of GuideRemoves guide from the axis.
removeListener(obj, type, handler) Removes event listener from the object
synchronizeWithAxis(axis)axis - instance of ValueAxis. One value axis can be synchronized with another value axis. You should set synchronizationMultiplyer in order for this to work.
zoomOut()Zooms out the value axis to full scale.
zoomToValues(startValue, endValue) Zooms-in the axis to the provided values.

Events Hide inherited

NameEvent objectDescription
axisChanged{type:"axisChanged", chart:AmChart}Dispatched when value axis min/max values are changed.
axisZoomed{type:"axisZoomed", startValue:startValue, endValue:endValue, chart:AmChart}Dispatched when axis is zoomed.
clickItem{type: "clickItem", value:value, serialDataItem:SerialDataItem, axis:AxisBase, target:label, chart:AmRectangularChart, event:MouseEvent}Fired if user clicks on axis label.
logarithmicAxisFailed{type:"logarithmicAxisFailed", chart:AmChart}Dispatched when valueAxis is logarithmic and values equal or less then zero were found in data.
rollOutItem{type: "rollOutItem", value:value, serialDataItem:SerialDataItem, axis:AxisBase, target:label, chart:AmRectangularChart, event:MouseEvent}Fired if user rolls-out of the axis label.
rollOverItem{type: "rollOverItem", value:value, serialDataItem:SerialDataItem, axis:AxisBase, target:label, chart:AmRectangularChart, event:MouseEvent}Fired if user rolls-over axis label.