ValueAxis

Type class

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

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

Sources

This information about ValueAxis is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

ValueAxis extends AxisBase.

ValueAxis is not extended by any other symbol.

Properties

#autoWrap

Type booleanDefault false

If this is set to true and the label does not fit, it will be wrapped. Works only on horizontal value axes.

#axisFrequency

Type numberDefault 1

Works with Radar chart only. If you have a big number of axes, this property will help you to show every x axis only.

#axisTitleOffset

Type numberDefault 10

Radar chart only. Specifies distance from axis to the axis title (category)

#balloonTextFunction

Type object

You 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.

#baseValue

Type numberDefault 0

Specifies base value of the axis.

#duration

Type string

If 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".

#durationUnits

Type objectDefault {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.

#gridType

Type stringDefault polygons

Radar chart only. Possible values are: "polygons" and "circles". Set "circles" for polar charts.

#id

Type string

Unique 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.

#includeAllValues

Type booleanDefault false

If you set it to true, minimum and maximum of value axis will not change while zooming/scrolling.

#includeGuidesInMinMax

Type booleanDefault false

Specifies whether guide values should be included when calculating min and max of the axis.

#includeHidden

Type booleanDefault false

If true, the axis will include hidden graphs when calculating min and max values.

#integersOnly

Type booleanDefault false

Specifies whether values on axis can only be integers or both integers and doubles.

#labelFunction

You 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.

#logarithmic

Type booleanDefault false

Specifies if this value axis' scale should be logarithmic.

#maximum

Type number

If 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.

#maximumDate

Type date

If 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.

#minimum

Type number

If 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.

#minimumDate

Type date

If 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.

#minMaxMultiplier

Type numberDefault 1

If 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%.

#minPeriod

Type stringDefault DD

Specifies 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.

#pointPosition

Type stringDefault axis

Works with radar charts only. If you set it to “middle”, labels and data points will be placed in the middle between axes.

#position

Type stringDefault left

Possible values are: "top", "bottom", "left", "right". If axis is vertical, default position is "left". If axis is horizontal, default position is "bottom".

#precision

Type number

Precision (number of decimals) of values.

#radarCategoriesEnabled

Type booleanDefault true

Radar chart only. Specifies if categories (axes' titles) should be displayed near axes)

#recalculateToPercents

Type booleanDefault false

Specifies if graphs's values should be recalculated to percents.

Note, that this setting will work only on Serial chart (and Stock), not on any other charts that are using ValueAxis, like XY chart.

#reversed

Type booleanDefault false

Specifies if value axis should be reversed (smaller values on top).

NOTE: If axis type is set to "date", this setting is ignored. Date-based axis cannot be reversed.

#stackType

Type stringDefault none

Stacking mode of the axis. Possible values are: "none", "regular", "100%", "3d".

Note, only graphs of one type will be stacked.

#strictMinMax

Type booleanDefault false

If 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.

#synchronizationMultiplier

Type number

In 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.

#synchronizeWith

Type ValueAxis

One 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.

#totalText

Type string

If this value axis is stacked and has columns, setting valueAxis.totalText = "total" will make it to display total value above the most-top column.

#totalTextColor

Type color

Color of total text.

#totalTextOffset

Type numberDefault 0

Distance from data point to total text.

#treatZeroAs

Type numberDefault 0

This 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.

#type

Type stringDefault numeric

Type 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".

#unit

Type string

Unit which will be added to the value label.

#unitPosition

Type stringDefault right

Position of the unit. Possible values are "left" and "right".

#usePrefixes

Type booleanDefault false

If 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.

#useScientificNotation

Type booleanDefault false

If 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.

#zeroGridAlpha

Type number

Opacity of a zero grid line. By default it is equal to 2 x gridAlpha.

45 inherited items

#autoGridCount

Type booleanDefault trueInherited from AxisBase

Specifies whether number of gridCount is specified automatically, acoarding to the axis size.

#autoRotateAngle

Type numberInherited from AxisBase

Angle 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.

#autoRotateCount

Type numberInherited from AxisBase

If 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.

#axisAlpha

Type numberDefault 1Inherited from AxisBase

Axis opacity. Value range is 0 - 1.

#axisColor

Type colorDefault #000000Inherited from AxisBase

Axis color.

#axisThickness

Type numberDefault 1Inherited from AxisBase

Thickness of the axis.

#boldLabels

Type booleanDefault falseInherited from AxisBase

Specifies if axis labels should be bold or not.

#boldPeriodBeginning

Type booleanDefault trueInherited from AxisBase

When 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.

#centerLabelOnFullPeriod

Type booleanDefault trueInherited from AxisBase

This 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.

#centerLabels

Type booleanDefault falseInherited from AxisBase

Force-centers labels of date-based axis (in case it's category axis, equalSpacing must be false)

#centerRotatedLabels

Type booleanDefault falseInherited from AxisBase

In case you have rotated labels on horizontal axis, you can force-center them using this property.

#color

Type colorInherited from AxisBase

Color of axis value labels. Will use chart's color if not set.

#dashLength

Type numberDefault 0Inherited from AxisBase

Length of a dash. 0 means line is not dashed.

#dateFormats

Type object[]Default [ { "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" } ]Inherited from AxisBase

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.

#fillAlpha

Type numberDefault 0Inherited from AxisBase

Fill opacity. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills.

#fillColor

Type colorDefault #FFFFFFInherited from AxisBase

Fill color. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills.

#firstDayOfWeek

Type numberDefault 1Inherited from AxisBase

Sets first day of the week. 0 is Sunday, 1 is Monday, etc.

#fontSize

Type numberInherited from AxisBase

Size of value labels text. Will use chart's fontSize if not set.

#gridAlpha

Type numberDefault 0.15Inherited from AxisBase

Opacity of grid lines.

#gridColor

Type colorDefault #000000Inherited from AxisBase

Color of grid lines.

#gridCount

Type numberDefault 5Inherited from AxisBase

Number 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.

#gridThickness

Type numberDefault 1Inherited from AxisBase

Thickness of grid lines.

#guides

Type Guide[]Default []Inherited from AxisBase

The array of guides belonging to this axis.

#ignoreAxisWidth

Type booleanDefault falseInherited from AxisBase

If autoMargins of a chart is set to true, but you want this axis not to be measured when calculating margin, set ignoreAxisWidth to true.

#inside

Type booleanDefault falseInherited from AxisBase

Specifies whether values should be placed inside or outside plot area.

#labelFrequency

Type numberDefault 1Inherited from AxisBase

Frequency at which labels should be placed. Doesn't work for CategoryAxis if parseDates is set to true.

#labelOffset

Type numberDefault 0Inherited from AxisBase

You can use it to adjust position of axes labels. Works both with CategoryAxis and ValueAxis.

#labelRotation

Type numberDefault 0Inherited from AxisBase

Rotation 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.

#labelsEnabled

Type booleanDefault trueInherited from AxisBase

Specifies whether axis displays category axis' labels and value axis' values.

#listeners

Type object[]Inherited from AxisBase

You can add listeners of events using this property. Example: listeners = [{"event":"clickItem", "method":handleEvent}];

#markPeriodChange

Type booleanDefault trueInherited from AxisBase

If you set it to false, the start of longer periods won't use a different date format and won't be bold.

#minHorizontalGap

Type numberDefault 75Inherited from AxisBase

This property is used when calculating grid count (when autoGridCount is true). It specifies minimum cell width required for one span between grid lines.

#minorGridAlpha

Type numberDefault 0.07Inherited from AxisBase

Opacity of minor grid. In order minor to be visible, you should set minorGridEnabled to true.

#minorGridEnabled

Type booleanDefault falseInherited from AxisBase

Specifies if minor grid should be displayed.

NOTE: If equalSpacing is set to true, this setting will be ignored.

#minorTickLength

Type numberDefault 0Inherited from AxisBase

Length of minor grid tick.

#minVerticalGap

Type numberDefault 35Inherited from AxisBase

This property is used when calculating grid count (when autoGridCount is true). It specifies minimum cell height required for one span between grid lines.

#offset

Type numberDefault 0Inherited from AxisBase

The distance of the axis to the plot area, in pixels. Negative values can also be used.

#showFirstLabel

Type booleanDefault trueInherited from AxisBase

Whether 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.

#showLastLabel

Type booleanDefault trueInherited from AxisBase

Whether 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.

#tickLength

Type numberDefault 5Inherited from AxisBase

Length of the tick marks.

#title

Type stringInherited from AxisBase

Title of the axis.

#titleBold

Type booleanDefault trueInherited from AxisBase

Specifies if title should be bold or not.

#titleColor

Type colorInherited from AxisBase

Color of axis title. Will use text color of chart if not set any.

#titleFontSize

Type numberInherited from AxisBase

Font size of axis title. Will use font size of chart plus two pixels if not set any.

#titleRotation

Type numberInherited from AxisBase

Rotation of axis title. Useful if you want to make vertical axis title to be shown from top to down.

Methods

#addListener()

Returns

Adds event listener to the object.

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

#coordinateToValue()

Returns Number, - value of coordinate.

Returns value of the coordinate.

coordinate - y or x coordinate, in pixels.

#getCoordinate()

Returns Number - coordinate

Returns coordinate of the value in pixels.

value - Number

#removeListener()

Returns

Removes event listener from the object

#synchronizeWithAxis()

Returns

One value axis can be synchronized with another value axis. You should set synchronizationMultiplyer in order for this to work.

axis - instance of ValueAxis.

#zoomOut()

Returns void

Zooms out the value axis to full scale.

#zoomToValues()

Returns

Zooms-in the axis to the provided values.

2 inherited items

#addGuide()

Returns voidInherited from AxisBase

Adds guide to the axis.

guide - instance of Guide

#removeGuide()

Returns voidInherited from AxisBase

Removes guide from the axis.

guide - instance of Guide

Events

#axisChanged

Param { type: "axisChanged", target: ValueAxis } & {type:"axisChanged", chart:AmChart}

Dispatched when value axis min/max values are changed.

#axisZoomed

Param { type: "axisZoomed", target: ValueAxis } & {type:"axisZoomed", startValue:startValue, endValue:endValue, chart:AmChart}

Dispatched when axis is zoomed.

#logarithmicAxisFailed

Param { type: "logarithmicAxisFailed", target: ValueAxis } & {type:"logarithmicAxisFailed", chart:AmChart}

Dispatched when valueAxis is logarithmic and values equal or less then zero were found in data.

#clickGuide

Param { type: "clickGuide", target: ValueAxis } & {type: "clickGuide", guide:Guide, chart:AmRectangularChart}

Dispatched when user clicks on a guide.

#clickItem

Param { type: "clickItem", target: ValueAxis } & {type: "clickItem", value:value, serialDataItem:SerialDataItem, axis:AxisBase, target:label, chart:AmRectangularChart, event:MouseEvent}

Fired if user clicks on axis label.

#rollOutGuide

Param { type: "rollOutGuide", target: ValueAxis } & {type: "rollOutGuide", guide:Guide, chart:AmRectangularChart}

Dispatched when user rolls-out of the guide.

#rollOutItem

Param { type: "rollOutItem", target: ValueAxis } & {type: "rollOutItem", value:value, serialDataItem:SerialDataItem, axis:AxisBase, target:label, chart:AmRectangularChart, event:MouseEvent}

Fired if user rolls-out of the axis label.

#rollOverGuide

Param { type: "rollOverGuide", target: ValueAxis } & {type: "rollOverGuide", guide:Guide, chart:AmRectangularChart}

Dispatched when user rolls-over some guide.

#rollOverItem

Param { type: "rollOverItem", target: ValueAxis } & {type: "rollOverItem", value:value, serialDataItem:SerialDataItem, axis:AxisBase, target:label, chart:AmRectangularChart, event:MouseEvent}

Fired if user rolls-over axis label.