Information on this website refers to a deprecated product, and is provided only for historical reference. Please use the Version Switcher above to select an appropriate documentation website for the product you are using.

AmGraph

Type class

AmGraph class displays all types of graphs - line, column, step line, smoothed line, ohlc and candlestick. Example:

var chart = new AmCharts.AmSerialChart();
var graph = new AmCharts.AmGraph();
graph.valueField = 'value';
graph.type = 'column';
graph.fillAlphas = 1;
chart.addGraph(graph);

Inheritance

AmGraph does not extend any other symbol.

AmGraph is extended by StockGraph.

Properties

alphaField
#

Type string

Default

Name of the alpha field in your dataProvider.

balloonColor
#

Type string

Default

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

balloonText
#

Type string

Default [[value]]

Balloon text. You can use tags like [[value]], [[description]], [[percents]], [[open]], [[category]]

baloonFunction
#

Type Function

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

behindColumns
#

Type boolean

Default false

Specifies if the line graph should be placed behind column graphs

bullet
#

Type string

Default none

Type of the bullets. Possible values are: "none", "round", "square", "triangleUp", "triangleDown", "bubble", "custom".

bulletAlpha
#

Type number

Default 1

Opacity of bullets. Value range is 0 - 1.

bulletBorderAlpha
#

Type number

Default 1

Bullet border opacity.

bulletBorderColor
#

Type string

Default

Bullet border color. Will use lineColor if not set.

bulletBorderThickness
#

Type number

Default 2

Bullet border thickness.

bulletColor
#

Type string

Default

Bullet color. Will use lineColor if not set.

bulletField
#

Type string

Default

Name of the bullet field in your dataProvider.

bulletOffset
#

Type number

Default 0

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

bulletSize
#

Type number

Default 8

Bullet size.

bulletSizeField
#

Type string

Default

Name of the bullet size field in your dataProvider.

closeField
#

Type string

Default

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

color
#

Type string

Default

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

colorField
#

Type string

Default

Name of the color field in your dataProvider.

connect
#

Type boolean

Default true

Specifies whether to connect data points if data is missing. The default value is true.

cornerRadiusTop
#

Type number

Default 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 number

Default 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

Default

Path to the image of custom bullet.

customBulletField
#

Type string

Default

Name of the custom bullet field in your dataProvider.

dashLength
#

Type number

Default 0

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

descriptionField
#

Type string

Default

Name of the description field in your dataProvider.

fillAlphas
#

Type number

Default 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 String/Array

Default

Fill color. Will use lineColor if not set.

fillColorsField
#

Type string

Default

Name of the fill colors field in your dataProvider.

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

fontSize
#

Type number

Default

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

gradientOrientation
#

Type string

Default vertical

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

hidden
#

Type boolean

Default 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 number

Default 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

Default

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

includeInMinMax
#

Type boolean

Default true

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

labelColorField
#

Type string

Name of label color field in data provider.

labelPosition
#

Type string

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

labelText
#

Type string

Default

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

legendAlpha
#

Type number

Default

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

legendColor
#

Type string

Default

Legend marker color. Will use lineColor if not set.

legendValueText
#

Type string

Default

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 number

Default 1

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

lineColor
#

Type string

Default

Color of the line (or column border). If you do not set any, the color from [[AmCoordinateChart

lineColorField
#

Type string

Default

Name of the line color field (used by columns and candlesticks only) in your dataProvider.

lineThickness
#

Type number

Default 1

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

lowField
#

Type string

Default

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

markerType
#

Type string

Default

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

maxBulletSize
#

Type number

Default 50

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

minBulletSize
#

Type number

Default 0

Specifies minimum size of the bullet (XY chart).

negativeBase
#

Type number

Default 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

Default

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

negativeFillColors
#

Type String/Array

Default

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

negativeLineColor
#

Type string

Default

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.

numberFormatter
#

Type object

Default

Example: {precision:-1, decimalSeparator:'.', thousandsSeparator:','}. The graph uses this object's values to format the numbers. Uses chart's numberFormatter if not defined.

openField
#

Type string

Default

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

pointPosition
#

Type string

Default 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" and "middle".

showAllValueLabels
#

Type boolean

Default false

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

showBalloon
#

Type boolean

Default 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 string

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

showHandOnHover
#

Type boolean

Default false

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

stackable
#

Type boolean

Default true

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

title
#

Type string

Default

Graph title.

type
#

Type string

Default 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

Default

Name of the url field in your dataProvider.

urlTarget
#

Type string

Default

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

valueAxis
#

Type ValueAxis

Default

Specifies which value axis the graph will use. Will use the first value axis if not set.

valueField
#

Type string

Default

Name of the value field in your dataProvider.

visibleInLegend
#

Type boolean

Default true

Specifies whether this graph should be shown in the Legend.

xAxis
#

Type ValueAxis

Default

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

xField
#

Type string

Default

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

yAxis
#

Type ValueAxis

Default

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

yField
#

Type string

Default

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.

Adapters

AmGraph does not have any adapters.