AmGraph

Type class

Creates the visualization of the data in following types: line, column, step line, smoothed line, olhc and candlestick.

Example

```js var chart = AmCharts.makeChart("chartdiv",{ ... "graphs": [ { "id" : "AmGraph-1", "title" : "Column graph", "type" : "column", "valueField" : "column-1", "fillAlphas" : 1 } ] });```

Sources

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

Inheritance

AmGraph does not extend any other symbol.

AmGraph is extended by StockGraph.

Properties

#accessibleLabel

Type stringDefault [[title]] [[category]] [[value]]

Text which screen readers will read if user rolls-over the bullet/column or sets focus using tab key (this is possible only if tabIndex property of AmGraph is set to some number). Text is added as aria-label tag. Note - not all screen readers and browsers support this.

#alphaField

Type string

Name of the alpha field in your dataProvider.

#animationPlayed

Type booleanDefault false

If you set this to true before chart is drawn, the animation of this graph won't be played.

#balloonColor

Type color

Value balloon color. Will use graph or data item color if not set.

#balloonFunction

If you set some function, the graph will call it and pass GraphDataItem and AmGraph objects to it. This function should return a string which will be displayed in a balloon.

#balloonText

Type stringDefault [[value]]

Balloon text. You can use tags like value, description, percents, open, category or any other field name from your data provider. HTML tags can also be used.

#behindColumns

Type booleanDefault false

Specifies if the line graph should be placed behind column graphs

#bullet

Type stringDefault none

Type of the bullets. Possible values are: "none", "round", "square", "triangleUp", "triangleDown", "triangleLeft", "triangleRight", "bubble", "diamond", "xError", "yError" and "custom".

#bulletAlpha

Type numberDefault 1

Opacity of bullets. Value range is 0 - 1.

#bulletAxis

Type ValueAxis

bulletAxis value is used when you are building error chart. Error chart is a regular serial or XY chart with bullet type set to "xError" or "yError". The graph should know which axis should be used to determine the size of this bullet - that's when bulletAxis should be set. Besides that, you should also set graph.errorField. You can also use other bullet types with this feature too. For example, if you set bulletAxis for XY chart, the size of a bullet will change as you zoom the chart.

#bulletBorderAlpha

Type numberDefault 0

Bullet border opacity.

#bulletBorderColor

Type color

Bullet border color. Will use lineColor if not set.

#bulletBorderThickness

Type numberDefault 2

Bullet border thickness.

#bulletColor

Type color

Bullet color. Will use lineColor if not set.

#bulletField

Type string

Name of the bullet field in your dataProvider.

#bulletHitAreaSize

Type number

Useful for touch devices - if you set it to 20 or so, the bullets of a graph will have invisible circle around the actual bullet (bullets should still be enabled), which will be easier to touch (bullets usually are smaller and hard to hit).

#bulletOffset

Type numberDefault 0

Bullet offset. Distance from the actual data point to the bullet. Can be used to place custom bullets above the columns.

#bulletSize

Type numberDefault 8

Bullet size.

#bulletSizeField

Type string

Name of the bullet size field in your dataProvider.

#classNameField

Type string

If this field is set and addClassNames is enabled, the chart will look for a class name string in data using this setting and apply additional class names to elements of the particular data points, such as bullets.

#closeField

Type string

Name of the close field (used by candlesticks and ohlc) in your dataProvider.

#clustered

Type booleanDefault true

In case you want to place this graph's columns in front of other columns, set this to false. In case "true", the columns will be clustered next to each other.

NOTE: clustering works only for graphs of type "column".

#color

Type color

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

#colorField

Type string

Name of the color field in your dataProvider.

#columnIndexField

Type string

You can use this property with non-stacked column graphs and specify order of columns of each category (starting from 0). Important: this feature does not work in stacked columns scenarios as well as with graph toggling enabled in legend.

#columnWidth

Type number

You can specify custom column width for each graph individually. Value range is 0 - 1 (we set relative width, not pixel width here).

#connect

Type booleanDefault true

Specifies whether to connect data points if data is missing. The default value is true. This feature does not work with XY chart.

#cornerRadiusTop

Type numberDefault 0

Corner radius of column. It can be set both in pixels or in percents. The chart's depth and angle styles must be set to 0. The default value is 0. Note, cornerRadiusTop will be applied for all corners of the column, JavaScript charts do not have a possibility to set separate corner radius for top and bottom. As we want all the property names to be the same both on JS and Flex, we didn't change this too.

#cursorBulletAlpha

Type numberDefault 1

If bulletsEnabled of ChartCurosor is true, a bullet on each graph follows the cursor. You can set opacity of each graphs bullet. In case you want to disable these bullets for a certain graph, set opacity to 0.

#customBullet

Type string

Path to the image of custom bullet.

#customBulletField

Type string

Name of the custom bullet field in your dataProvider.

#customMarker

Type string

Path to the image for legend marker.

#dashLength

Type numberDefault 0

Dash length. If you set it to a value greater than 0, the graph line (or columns border) will be dashed.

#dashLengthField

Type string

Name of the dash length field in your dataProvider. This property adds a possibility to change graphs’ line from solid to dashed on any data point. You can also make columns border dashed using this setting. Note, this won't work with smoothedLineGraph.

#dateFormat

Type stringDefault MMM DD, YYYY

Used to format balloons if value axis is date-based.

#descriptionField

Type string

Name of the description field in your dataProvider.

#errorField

Type string

Name of error value field in your data provider.

#fillAlphas

Type numberDefault 0

Opacity of fill. Plural form is used to keep the same property names as our Flex charts'. Flex charts can accept array of numbers to generate gradients. Although you can set array here, only first value of this array will be used.

#fillColors

Type color

Fill color. Will use lineColor if not set. You can also set array of colors here.

#fillColorsField

Type string

Name of the fill colors field in your dataProvider. This property adds a possibility to change line graphs’ fill color on any data point to create highlighted sections of the graph. Works only with AmSerialChart.

#fillToAxis

Type ValueAxis

XY chart only. If you set this property to id or reference of your X or Y axis, and the fillAlphas is > 0, the area between graph and axis will be filled with color, like in this demo.

#fillToGraph

Type AmGraph

You can set another graph here and if fillAlpha is >0, the area from this graph to fillToGraph will be filled (instead of filling the area to the X axis). This feature is not supported by smoothedLine graphs and Radar chart.

#fixedColumnWidth

Type number

Column width in pixels. If you set this property, columns will be of a fixed width and won't adjust to the available space.

#fontSize

Type number

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

#forceGap

Type booleanDefault false

If this is set true, the graph will always break the line if the distance in time between two adjacent data points is bigger than gapPeriod x minPeriod, even if connect is set to true.

#gapField

Type string

Name of the gap field in your dataProvider. You can force graph to show gap at a desired data point using this feature. This feature does not work with XY chart.

#gapPeriod

Type numberDefault 1.1

Using this property you can specify when graph should display gap - if the time difference between data points is bigger than duration of minPeriod * gapPeriod, and connect property of a graph is set to false, graph will display gap.

#gradientOrientation

Type stringDefault vertical

Orientation of the gradient fills (only for "column" graph type). Possible values are "vertical" and "horizontal".

#hidden

Type booleanDefault false

Specifies whether the graph is hidden. Do not use this to show/hide the graph, use hideGraph(graph) and showGraph(graph) methods instead.

#hideBulletsCount

Type numberDefault 0

If there are more data points than hideBulletsCount, the bullets will not be shown. 0 means the bullets will always be visible.

#highField

Type string

Name of the high field (used by candlesticks and ohlc) in your dataProvider.

#id

Type string

Unique id of a graph. It is not required to set one, unless you want to use this graph for as your scrollbar's graph and need to indicate which graph should be used.

#includeInMinMax

Type booleanDefault true

Whether to include this graph when calculating min and max value of the axis.

#labelAnchor

Type stringDefault auto

Data label text anchor.

#labelColorField

Type string

Name of label color field in data provider.

#labelFunction

You can use it to format labels of data items in any way you want. Graph will call this function and pass reference to GraphDataItem and formatted text as attributes. This function should return string which will be displayed as label.

#labelOffset

Type numberDefault 0

Offset of data label.

#labelPosition

Type stringDefault top

Position of value label. Possible values are: "bottom", "top", "right", "left", "inside", "middle". Sometimes position is changed by the chart, depending on a graph type, rotation, etc.

#labelRotation

Type numberDefault 0

Rotation of a data label.

#labelText

Type string

Value label text. You can use tags like value, description, percents, open, category.

#legendAlpha

Type number

Legend marker opacity. Will use lineAlpha if not set. Value range is 0 - 1.

#legendColor

Type color

Legend marker color. Will use lineColor if not set.

#legendPeriodValueText

Type string

The text which will be displayed in the value portion of the legend when user is not hovering above any data point. The tags should be made out of two parts - the name of a field (value / open / close / high / low) and the value of the period you want to be show - open / close / high / low / sum / average / count. For example: value.sum means that sum of all data points of value field in the selected period will be displayed.

#legendValueText

Type string

Legend value text. You can use tags like value, description, percents, open, category You can also use custom fields from your dataProvider. If not set, uses Legend's valueText.

#lineAlpha

Type numberDefault 1

Opacity of the line (or column border). Value range is 0 - 1.

#lineColor

Type color

Color of the line (or column border). If you do not set any, the color from AmCoordinateChart.colors array will be used for each subsequent graph.

#lineColorField

Type string

Name of the line color field in your dataProvider. This property adds a possibility to change graphs’ line color on any data point to create highlighted sections of the graph. Works only with AmSerialChart.

#lineThickness

Type numberDefault 1

Specifies thickness of the graph line (or column border).

#lowField

Type string

Name of the low field (used by candlesticks and ohlc) in your dataProvider.

#markerType

Type string

Legend marker type. You can set legend marker (key) type for individual graphs. Possible values are: square, circle, diamond, triangleUp, triangleDown, triangleLeft, triangleDown, bubble, line, none.

#maxBulletSize

Type numberDefault 50

Specifies size of the bullet which value is the biggest (XY chart).

#minBulletSize

Type numberDefault 4

Specifies minimum size of the bullet (XY chart).

#minDistance

Type numberDefault 1

It is useful if you have really lots of data points. Based on this property the graph will omit some of the lines (if the distance between points is less that minDistance, in pixels). This will not affect the bullets or indicator in anyway, so the user will not see any difference (unless you set minValue to a bigger value, let say 5), but will increase performance as less lines will be drawn. By setting value to a bigger number you can also make your lines look less jagged.

#negativeBase

Type numberDefault 0

If you use different colors for your negative values, a graph below zero line is filled with negativeColor. With this property you can define a different base value at which colors should be changed to negative colors.

#negativeFillAlphas

Type number

Fill opacity of negative part of the graph. Will use fillAlphas if not set.

#negativeFillColors

Type color

Fill color of negative part of the graph. Will use fillColors if not set.

#negativeLineAlpha

Type numberDefault 1

Opacity of the negative portion of the line (or column border). Value range is 0 - 1.

#negativeLineColor

Type color

Color of the line (or column) when the values are negative. In case the graph type is candlestick or ohlc, negativeLineColor is used when close value is less then open value.

#newStack

Type booleanDefault false

If you set it to true, column chart will begin new stack. This allows having Clustered and Stacked column/bar chart.

#noStepRisers

Type booleanDefault false

In case you want to have a step line graph without risers, you should set this to true.

#openField

Type string

Name of the open field (used by floating columns, candlesticks and ohlc) in your dataProvider.

#pattern

Type object

Value of pattern should be object with url, width, height of an image, optionally it might have x, y, randomX and randomY values. For example: {"url":"../amcharts/patterns/black/pattern1.png", "width":4, "height":4}. If you want to have individual patterns for each column, define patterns in data provider and set graph.patternField property. Check amcharts/patterns folder for some patterns. You can create your own patterns and use them. Note, x, y, randomX and randomY properties won't work with IE8 and older. 3D bar/Pie charts won't work properly with patterns.

#patternField

Type string

Field name in your data provider which holds pattern information. Value of pattern should be object with url, width, height of an image, optionally it might have x, y, randomX and randomY values. For example: {"url":"../amcharts/patterns/black/pattern1.png", "width":4, "height":4}. Check amcharts/patterns folder for some patterns. You can create your own patterns and use them. Note, x, y, randomX and randomY properties won't work with IE8 and older. 3D bar/Pie charts won't work properly with patterns.

#periodSpan

Type numberDefault 1

This property can be used by step graphs - you can set how many periods one horizontal line should span.

#pointPosition

Type stringDefault middle

Specifies where data points should be placed - on the beginning of the period (day, hour, etc) or in the middle (only when parseDates property of categoryAxis is set to true). This setting affects Serial chart only. Possible values are "start", "middle" and "end"

#precision

Type number

Precision of values. Will use chart's precision if not set any.

#proCandlesticks

Type booleanDefault false

If this is set to true, candlesticks will be colored in a different manner - if current close is less than current open, the candlestick will be empty, otherwise - filled with color. If previous close is less than current close, the candlestick will use positive color, otherwise - negative color.

#showAllValueLabels

Type booleanDefault false

If graph's type is column and labelText is set, graph hides labels which do not fit into the column's space or go outside plot area. If you don't want these labels to be hidden, set this to true.

#showBalloon

Type booleanDefault true

Specifies whether the value balloon of this graph is shown when mouse is over data item or chart's indicator is over some series.

#showBalloonAt

Type stringDefault close

Specifies graphs value at which cursor is showed. This is only important for candlestick and ohlc charts, also if column chart has "open" value. Possible values are: "open", "close", "high", "low". "top" and "bottom" values will glue the balloon to top/bottom of the plot area.

#showBulletsAt

Type stringDefault close

Works with candlestick graph type, you can set it to open, close, high, low. If you set it to high, the events will be shown at the tip of the high line.

#showHandOnHover

Type booleanDefault false

If you want mouse pointer to change to hand when hovering the graph, set this property to true.

#showOnAxis

Type booleanDefault false

It can only be used together with topRadius (when columns look like cylinders). If you set it to true, the cylinder will be lowered down so that the center of it's bottom circle would be right on category axis.

#stackable

Type booleanDefault true

If the value axis of this graph has stack types like "regular" or "100%" You can exclude this graph from stacking.

#stepDirection

Type stringDefault right

Step graph only. Specifies to which direction step should be drawn.

#switchable

Type booleanDefault true

If you set it to false, the graph will not be hidden when user clicks on legend entry.

#tabIndex

Type number

In case you set it to some number, the chart will set focus on bullet/column (starting from first) when user clicks tab key. When a focus is set, screen readers like NVDA Screen reader will read label which is set using accessibleLabel property of AmGraph. Note, not all browsers and readers support this.

#title

Type string

Graph title.

#topRadius

Type number

If you set this to 1, columns will become cylinders (must set depth3D and angle properties of a chart to >0 values in order this to be visible). you can make columns look like cones (set topRadius to 0) or even like some glasses (set to bigger than 1). We strongly recommend setting grid opacity to 0 in order this to look good.

#type

Type stringDefault line

Type of the graph. Possible values are: "line", "column", "step", "smoothedLine", "candlestick", "ohlc". XY and Radar charts can only display "line" type graphs.

#urlField

Type string

Name of the url field in your dataProvider.

#urlTarget

Type string

Target to open URLs in, i.e. _blank, _top, etc.

#useLineColorForBulletBorder

Type booleanDefault false

If set to true, the bullet border will take the same color as graph line.

#useNegativeColorIfDown

Type booleanDefault false

If negativeLineColor and/or negativeFillColors are set and useNegativeColorIfDown is set to true (default is false), the line, step and column graphs will use these colors for lines, bullets or columns if previous value is bigger than current value. In case you set openField for the graph, the graph will compare current value with openField value instead of comparing to previous value. Here is a demo.

#valueAxis

Type ValueAxisDefault ValueAxis

Specifies which value axis the graph will use. Will use the first value axis if not set. You can use reference to the real ValueAxis object or set value axis id.

#valueField

Type string

Name of the value field in your dataProvider.

#visibleInLegend

Type booleanDefault true

Specifies whether this graph should be shown in the Legend.

#xAxis

Type ValueAxisDefault ValueAxis

XY chart only. A horizontal value axis object to attach graph to.

#xField

Type string

XY chart only. Name of the x field in your dataProvider.

#yAxis

Type ValueAxisDefault ValueAxis

XY chart only. A vertical value axis object to attach graph to.

#yField

Type string

XY chart only. Name of the y field in your dataProvider.

Methods

#hideBullets()

Returns void

Hides graph's bullets.

#showBullets()

Returns void

Shows graph's bullets

Events

AmGraph does not have any events.