Class AmSerialChart

AmSerialChart is the class you have to use for majority of chart types. The supported chart types are: line, area, column, bar, step line, smoothed line, candlestick and OHLC. The chart can be rotated by 90 degrees so the column chart becomes bar chart. The chart supports simple and logarithmic scales, it can have multiple value axes. The chart can place data points at equal intervals or can parse dates and place data points at irregular intervals.

example

var chartData = [{title:"sample 1",value:130},{title:"sample 2",value:26}];

var chart = new AmCharts.AmSerialChart(); chart.categoryField = "title"; chart.dataProvider = chartData;

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

chart.write("chartdiv");

Hierarchy

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(theme: any): AmChart

used when constructing a chart with a theme

Parameters

  • theme: any

Returns

AmChart

Properties

public angle: number

The angle of the 3D part of plot area. This creates a 3D effect (if the "depth3D" is > 0).

public autoMarginOffset: number

Space left from axis labels/title to the chart's outside border, if autoMargins set to true.

default

10

public autoMargins: boolean

Specifies if margins of a chart should be calculated automatically so that labels of axes would fit. The chart will adjust only margins with axes. Other margins will use values set with marginRight, marginTop, marginLeft and marginBottom properties.

default

true

public backgroundColor: string

Background color. You should set backgroundAlpha to >0 value in order background to be visible. We recommend setting background color directly on a chart's DIV instead of using this property. #FFFFFF

public balloon: AmBalloon

The chart creates AmBalloon class itself. If you want to customize balloon, get balloon instance using this property, and then change balloon's properties. AmBalloon

public borderAlpha: number

Opacity of chart's border. Value range is 0 - 1.

public borderColor: string

Color of chart's border. You should set borderAlpha >0 in order border to be visible. We recommend setting border color directly on a chart's DIV instead of using this property. #000000

public categoryAxis: CategoryAxis

Read-only. Chart creates category axis itself. If you want to change some properties, you should get this axis from the chart and set properties to this object.

public categoryField: string

Category field name tells the chart the name of the field in your dataProvider object which will be used for category axis values.

public chartCursor: ChartCursor

Chart cursor.

public chartData: Array<any>

Read-only. Array of SerialDataItem objects generated from dataProvider.

public chartScrollbar: ChartScrollbar

Chart scrollbar.

public color: string

Text color. #000000

public colors: Array<any>

Specifies the colors of the graphs if the lineColor of a graph is not set. It there are more graphs then colors in this array, the chart picks random color.

default

['#FF6600', '#FCD202', '#B0DE09', '#0D8ECF', '#2A0CD0', '#CD0D74', '#CC0000', '#00CC00', '#0000CC', '#DDDDDD', '#999999', '#333333', '#990000']

public columnSpacing: number

The gap in pixels between two columns of the same category.

default

5

public columnWidth: number

Relative width of columns. Value range is 0 - 1. 0.8

public dataProvider: Array<any>

Array holding chart's data.

public depth3D: number

The depth of the 3D part of plot area. This creates a 3D effect (if the "angle" is > 0).

public endDate: Date

Read-only. If category axis parses dates endDate indicates date to which the chart is currently displayed.

public endIndex: number

Read-only. Category index to which the chart is currently displayed.

public fontFamily: string

Font family. Verdana

public fontSize: number

Font size.

default

11

public graphs: Array<any>

The array of graphs belonging to this chart. To add/remove graph use addGraph/removeGraph methods instead of adding/removing graphs directly to array.

public height: any

Height of a chart. "100%" means the chart's height will be equal to it's container's (DIV) height and will resize if height of the container changes. Set a number instead of percents if your chart's size needs to be fixed.

default

1

public legendDiv: HTMLElement

Reference to the div of the legend.

public marginBottom: number

Number of pixels between the container's bottom border and plot area. This space can be used for bottom axis' values. If autoMargin is true and bottom side has axis, this property is ignored.

default

20

public marginLeft: number

Number of pixels between the container's left border and plot area. This space can be used for left axis' values. If autoMargin is true and left side has axis, this property is ignored.

default

20

public marginRight: number

Number of pixels between the container's right border and plot area. This space can be used for Right axis' values. If autoMargin is true and right side has axis, this property is ignored.

default

20

public marginTop: number

Number of pixels between the container's top border and plot area. This space can be used for top axis' values. If autoMargin is true and top side has axis, this property is ignored.

default

20

public marginsUpdated: boolean

Flag which should be set to false if you need margins to be recalculated on next chart.validateNow() call.

public maxSelectedSeries: number

Maximum number of series allowed to select.

public maxSelectedTime: number

The longest time span allowed to select (in milliseconds) for example, 259200000 will limit selection to 3 days.

public minSelectedTime: number

The shortest time span allowed to select (in milliseconds) for example, 1000 will limit selection to 1 second.

public numberFormatter: Object

Object with precision, decimalSeparator and thousandsSeparator set which will be used for number formatting. Precision set to -1 means that values won't be rounded. {precision:-1, decimalSeparator:'.', thousandsSeparator:','}

public panEventsEnabled: boolean

This setting affects touch-screen devices only. If a chart is on a page, and panEventsEnabled are set to true, the page won't move if the user touches the chart first. If a chart is big enough and occupies all the screen of your touch device, the user won’t be able to move the page at all. That's why the default value is "false". If you think that selecting/panning the chart or moving/pinching the map is a primary purpose of your users, you should set panEventsEnabled to true.

public percentFormatter: Object

Object with precision, decimalSeparator and thousandsSeparator set which will be used for formatting percent values. {precision:2, decimalSeparator:'.', thousandsSeparator:','}

public plotAreaBorderAlpha: number

The opacity of plot area's border. Value range is 0 - 1.

public plotAreaBorderColor: string

The color of the plot area's border. Note, the it is invisible by default, as plotAreaBorderAlpha default value is 0. Set it to a value higher than 0 to make it visible.

default

000000

public plotAreaFillAlphas: number

Opacity of plot area. 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.

public plotAreaFillColors: any

You can set both one color if you need a solid color or array of colors to generate gradients, for example: ["#000000", "#0000CC"]

default

FFFFFF

public prefixesOfBigNumbers: Array<any>

Prefixes which are used to make big numbers shorter: 2M instead of 2000000, etc. Prefixes are used on value axes and in the legend. To enable prefixes, set usePrefixes property to true. [{number:1e+3,prefix:"k"},{number:1e+6,prefix:"M"},{number:1e+9,prefix:"G"},{number:1e+12,prefix:"T"},{number:1e+15,prefix:"P"},{number:1e+18,prefix:"E"},{number:1e+21,prefix:"Z"},{number:1e+24,prefix:"Y"}]

public prefixesOfSmallNumbers: Array<any>

Prefixes which are used to make small numbers shorter: 2μ instead of 0.000002, etc. Prefixes are used on value axes and in the legend. To enable prefixes, set usePrefixes property to true. [{number:1e-24, prefix:"y"},{number:1e-21, prefix:"z"},{number:1e-18, prefix:"a"},{number:1e-15, prefix:"f"},{number:1e-12, prefix:"p"},{number:1e-9, prefix:"n"},{number:1e-6, prefix:"μ"},{number:1e-3, prefix:"m"}]

public removeTrendLine: any

Removes a trend line from a chart. You should call chart.validateNow() in order the changes to be visible.

public rotate: boolean

If you set this to true, the chart will be rotated by 90 degrees (the columns will become bars).

public sequencedAnimation: boolean

Specifies whether the animation should be sequenced or all objects should appear at once.

default

true

public startAlpha: number

The initial opacity of the column/line. If you set startDuration to a value higher than 0, the columns/lines will fade in from startAlpha. Value range is 0 - 1.

default

1

public startDate: Date

Read-only. If category axis parses dates startDate indicates date from which the chart is currently displayed.

public startDuration: number

Duration of the animation, in seconds.

public startEffect: string

Animation effect. Possible values are ">", "<", elastic" and "bounce".

default

"elastic"

public startIndex: number

Read-only. Category index from which the chart is currently displayed.

public trendLines: Array<any>

Array of trend lines added to a chart. You can add trend lines to a chart using this array or access already existing trend lines

public urlTarget: any

Target of url.

default

this

public usePrefixes: boolean

If true, prefixes will be used for big and small numbers. You can set arrays of prefixes via prefixesOfSmallNumbers and prefixesOfBigNumbers properties.

public valueAxes: Array<any>

The array of value axes. To add/remove value axis use addValueAxis/removeValueAxis methods instead of adding/removing axes directly to array. Chart creates one value axis automatically, so if you need only one value axis, you don't need to create it.

public version: string

Read-only. Indicates current version of a script.

public zoomOutButton: Object

It's a simple object containing information about zoom-out button. Other available properties of this object are fontSize and color. color specifies text color of a button. {backgroundColor:'#b2e1ff',backgroundAlpha:1}

public zoomOutOnDataUpdate: boolean

Specifies if chart should zoom-out when data is updated.

default

true

public zoomOutText: string

Text in the zoom-out button. Show all

Methods

public addGraph(graph: AmGraph): any

Adds a graph to the chart.

Parameters

Returns

any

public addLabel(x: number, y: number, text: string, align: string, size: any, color: string, rotation: any, alpha: number, bold: boolean, url: string): any

Adds a label on a chart. You can use it for labeling axes, adding chart title, etc. x and y coordinates can be set in number, percent, or a number with ! in front of it - coordinate will be calculated from right or bottom instead of left or top. x - horizontal coordinate y - vertical coordinate text - label's text align - alignment (left/right/center) size - text size color - text color rotation - angle of rotation alpha - label alpha bold - specifies if text is bold (true/false), url - url

Parameters

  • x: number
  • y: number
  • text: string
  • align: string
  • size: any
  • color: string
  • rotation: any
  • alpha: number
  • bold: boolean
  • url: string

Returns

any

public addLegend(legend: AmLegend, legendDivId?: string): any

Adds a legend to the chart. By default, you don't need to create div for your legend, however if you want it to be positioned in some different way, you can create div anywhere you want and pass id or reference to your div as a second parameter. (NOTE: This method will not work on StockPanel.)

Parameters

  • legend: AmLegend
  • legendDivId?: string optional
    • Id of the legend div (optional).

Returns

any

public addLegend(legend: AmLegend, legendDiv: HTMLElement): any

Adds a legend to the chart. By default, you don't need to create div for your legend, however if you want it to be positioned in some different way, you can create div anywhere you want and pass id or reference to your div as a second parameter. (NOTE: This method will not work on StockPanel.)

Parameters

  • legend: AmLegend
  • legendDiv: HTMLElement
    • Legend div (optional).

Returns

any

public addListener(type: string, handler: (e: { type: string; graph: AmCharts.AmGraph; item: AmCharts.GraphDataItem; index: number; chart: AmCharts.AmChart; }) => void): any

Adds event listener of the type "clickGraphItem" or "doubleClickGraphItem" or "rightClickGraphItem" or "rollOutGraphItem" or "rollOverGraphItem" to the object.

Parameters

  • type: string

    Either "clickGraphItem" or "doubleClickGraphItem" or "rightClickGraphItem" or "rollOutGraphItem" or "rollOverGraphItem".

  • handler: (e: { type: string; graph: AmCharts.AmGraph; item: AmCharts.GraphDataItem; index: number; chart: AmCharts.AmChart; }) => void

    Dispatched when user clicks on the data item (column/bullet)

Returns

any

public addTitle(text: any, size: any, color: any, alpha: any, bold: any): any

Adds title to the top of the chart. Pie, Radar positions are updated so that they won't overlap. Plot area of Serial/XY chart is also updated unless autoMargins property is set to false. You can add any number of titles - each of them will be placed in a new line. To remove titles, simply clear titles array: chart.titles = []; and call chart.validateNow() method. text - text of a title size - font size color - title color alpha - title opacity bold - boolean value indicating if title should be bold.

Parameters

  • text: any
  • size: any
  • color: any
  • alpha: any
  • bold: any

Returns

any

public addTrendLine(trendLine: TrendLine): any

Adds a TrendLine to a chart. You should call chart.validateNow() after this method is called in order the trend line to be visible.

Parameters

Returns

any

public addValueAxis(axis: ValueAxis): any

Adds value axis to the chart. One value axis is created automatically, so if you don't want to change anything or add more value axes, you don't need to add it.

Parameters

Returns

any

public animateAgain(): any

You can trigger the animation of the chart.

Returns

any

public clear(): any

Clears the chart area, intervals, etc.

Returns

any

public clearLabels(): any

Removes all labels added to the chart.

Returns

any

public getCategoryIndexByValue(value: any): any

Number Returns index of the specified category value. value - series (category value) which index you want to find.

Parameters

  • value: any

Returns

any

public getGraphById(graphId: string): AmGraph

AmGraph Returns graph by id.

Parameters

  • graphId: string

Returns

AmGraph

public getValueAxisById(axisId: string): ValueAxis

Returns value axis by id.

Parameters

  • axisId: string

Returns

ValueAxis

public hideGraph(graph: AmGraph): any

Hide the graph (if it is visible). Usually this method is called from the Legend, when you click on the legend marker.

Parameters

Returns

any

public hideGraphsBalloon(graph: AmGraph): any

Hide value balloon of a graph. Usually this method is called from the Legend, when you click on the legend text.

Parameters

Returns

any

public highlightGraph(graph: AmGraph): any

Highlight the graph. Usually this method is called from the Legend, when you roll-over the legend entry.

Parameters

Returns

any

public invalidateSize(): any

Use this method to force the chart to resize to it's current container size.

Returns

any

public removeChartCursor(): any

Removes cursor from the chart

Returns

any

public removeChartScrollbar(): any

Removes scrollbar from the chart

Returns

any

public removeGraph(graph: AmGraph): any

Removes graph from the chart.

Parameters

Returns

any

public removeLegend(): any

Removes chart's legend.

Returns

any

public removeListener(chart: AmChart, type: string, handler: any): any

Removes event listener from chart object.

Parameters

  • chart: AmChart
  • type: string
  • handler: any

Returns

any

public removeValueAxis(axis: ValueAxis): any

Removes value axis from the chart. When you remove value axis, all graphs assigned to this axis are also removed.

Parameters

Returns

any

public showGraph(graph: AmGraph): any

Show the graph (if it is hidden). Usually this method is called from the Legend, when you click on the legend marker.

Parameters

Returns

any

public showGraphsBalloon(graph: AmGraph): any

Show value balloon of a graph. Usually this method is called from the Legend, when you click on the legend text.

Parameters

Returns

any

public unhighlightGraph(graph: AmGraph): any

UnhighlightGraph the graph. Usually this method is called from the Legend, when you roll-out the legend entry.

Parameters

Returns

any

public validateData(): any

This method should be called after data in your data provider changed or a new array was set to dataProvider. After calling this method the chart will parse data and redraw.

Returns

any

public validateNow(): any

This method should be called after you changed one or more properties of any class. The chart will redraw after this method is called.

Returns

any

public write(container: HTMLElement)

Adds chart to the specified DIV.

Parameters

  • container: HTMLElement

    DIV object which will hold the chart.

public write(container: string)

Adds chart to the specified DIV.

Parameters

  • container: string

    Id of a DIV which will hold the chart.

public zoomOut(): any

Zooms out, charts shows all available data.

Returns

any

public zoomToCategoryValues(start: any, end: any): any

Zooms the chart by the value of the category axis. start - category value, String \ end - category value, String

Parameters

  • start: any
  • end: any

Returns

any

public zoomToDates(start: any, end: any): any

Zooms the chart from one date to another. start - start date, Date object \ end - end date, Date object

Parameters

  • start: any
  • end: any

Returns

any

public zoomToIndexes(start: any, end: any): any

Zooms the chart by the index of the category. start - start index, Number \ end - end index, Number

Parameters

  • start: any
  • end: any

Returns

any