Inheritance: StockGraphAmGraph

StockGraph displays graphs on StockPanel.

Properties Hide inherited

accessibleLabelString[[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.
alphaFieldStringName of the alpha field in your dataProvider.
animationPlayedBooleanfalseIf you set this to true before chart is drawn, the animation of this graph won't be played.
balloonAmBalloonAllows customizing graphs balloons individually (only when ChartCursor is used). Note: the balloon object is not created automatically, you should create it before setting properties
balloonColorColorValue balloon color. Will use graph or data item color if not set.
balloonFunctionIf 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.
balloonTextString[[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.
behindColumnsBooleanfalseSpecifies if the line graph should be placed behind column graphs
bulletStringnoneType of the bullets. Possible values are: "none", "round", "square", "triangleUp", "triangleDown", "triangleLeft", "triangleRight", "bubble", "diamond", "xError", "yError" and "custom".
bulletAlphaNumber1Opacity of bullets. Value range is 0 - 1.
bulletAxisValueAxisbulletAxis 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.
bulletBorderAlphaNumber0Bullet border opacity.
bulletBorderColorColorBullet border color. Will use lineColor if not set.
bulletBorderThicknessNumber2Bullet border thickness.
bulletColorColorBullet color. Will use lineColor if not set.
bulletFieldStringName of the bullet field in your dataProvider.
bulletHitAreaSizeNumberUseful 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).
bulletOffsetNumber0Bullet offset. Distance from the actual data point to the bullet. Can be used to place custom bullets above the columns.
bulletSizeNumber8Bullet size.
bulletSizeFieldStringName of the bullet size field in your dataProvider.
classNameFieldStringIf 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.
closeFieldStringName of the close field (used by candlesticks and ohlc) in your dataProvider.
clusteredBooleantrueIn 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".
colorColorColor of value labels. Will use chart's color if not set.
colorFieldStringName of the color field in your dataProvider.
columnIndexFieldStringYou 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.
columnWidthNumberYou can specify custom column width for each graph individually. Value range is 0 - 1 (we set relative width, not pixel width here).
comparableBooleanfalseSpecifies whether this graph will be compared if some data set is selected for comparing.
compareFieldStringSpecifies a field to be used to generate comparing graph. Note, this field is not the one used in your dataProvider, but toField from FieldMapping object.
compareFromStartBooleanfalseIf you set it to true, when data sets are compared, the graphs will use first value as a base value instead of using the first value of selected period.
compareGraph AmGraphYou can use this property to set config of compared graphs. This allows you to set any of AmGraph properties on compared graphs instead of using old-style properties like compareGraphBulletBorderThickness. For example: stockGraph.compareGraph = {“bulletBorderThickness”:2, “lineAlpha”:0.4}.
compareGraphBalloonColorColorBalloon color of comparing graph.
compareGraphBalloonFunctionIf 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. This will be used for graphs from compared data sets only. Use balloonFunction for main data set's graphs.
compareGraphBalloonTextStringBalloon text of comparing graph.
compareGraphBulletStringBullet of comparing graph. Possible values are: round, square, diamond, triangleUp, triangleDown, triangleLeft, triangleRight, bubble
compareGraphBulletBorderAlphaNumberOpacity of bullet border of comparing graph.
compareGraphBulletBorderColorColorColor of bullet border of comparing graph.
compareGraphBulletBorderThicknessNumberThickness of bullet border of comparing graph.
compareGraphBulletColorColorColor of compared graphs' bullets.
compareGraphBulletSizeNumberBullet size of comparing graph.
compareGraphCornerRadiusTopNumberCorner radius of comparing graph (if type is "column").
compareGraphDashLengthNumberDash length of compare graph.
compareGraphFillAlphasNumberFill alpha of comparing graph.
compareGraphFillColorsColorFill color of comparing graph.
compareGraphLineAlphaNumberOpacity of comparing graph line.
compareGraphLineColorColorColor of compare graph (by default data set color is used)
compareGraphLineThicknessNumberThickness of compare graph.
compareGraphTypeStringlineType of comparing graph. Possible values are: "line", "column", "step", "smoothedLine."
compareGraphVisibleInLegendBooleantrueSpecifies if compare graph is visible in legend.
connectBooleantrueSpecifies whether to connect data points if data is missing. The default value is true. This feature does not work with XY chart.
cornerRadiusTopNumber0Corner 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.
cursorBulletAlphaNumber1If 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.
customBulletStringPath to the image of custom bullet.
customBulletFieldStringName of the custom bullet field in your dataProvider.
customMarkerStringPath to the image for legend marker.
dashLengthNumber0Dash length. If you set it to a value greater than 0, the graph line (or columns border) will be dashed.
dashLengthFieldStringName 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.
dateFormatStringMMM DD, YYYYUsed to format balloons if value axis is date-based.
descriptionFieldStringName of the description field in your dataProvider.
errorFieldStringName of error value field in your data provider.
fillAlphasNumber0Opacity 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.
fillColorsColorFill color. Will use lineColor if not set. You can also set array of colors here.
fillColorsFieldStringName 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.
fillToAxisValueAxisXY 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.
fillToGraphAmGraphYou 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.
fixedColumnWidthNumberColumn width in pixels. If you set this property, columns will be of a fixed width and won't adjust to the available space.
fontSizeNumberSize of value labels text. Will use chart's fontSize if not set.
forceGapBooleanfalseIf 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`.
gapFieldStringName 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.
gapPeriodNumber1.1Using 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.
gradientOrientationStringverticalOrientation of the gradient fills (only for "column" graph type). Possible values are "vertical" and "horizontal".
hiddenBooleanfalseSpecifies whether the graph is hidden. Do not use this to show/hide the graph, use hideGraph(graph) and showGraph(graph) methods instead.
hideBulletsCountNumber0If there are more data points than hideBulletsCount, the bullets will not be shown. 0 means the bullets will always be visible.
highFieldStringName of the high field (used by candlesticks and ohlc) in your dataProvider.
idStringUnique 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.
includeInMinMaxBooleantrueWhether to include this graph when calculating min and max value of the axis.
labelAnchorStringautoData label text anchor.
labelColorFieldStringName of label color field in data provider.
labelFunctionYou 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.
labelOffsetNumber0Offset of data label.
labelPositionStringtopPosition 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.
labelRotationNumber0Rotation of a data label.
labelTextStringValue label text. You can use tags like [[value]], [[description]], [[percents]], [[open]], [[category]].
legendAlphaNumberLegend marker opacity. Will use lineAlpha if not set. Value range is 0 - 1.
legendColorColorLegend marker color. Will use lineColor if not set.
legendColorFunctionObjectIt is called and the following attributes are passed: dataItem, formattedText, periodValues, periodPercentValues. It should return hex color code which will be used for legend marker.
legendPeriodValueTextStringThe 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.
legendValueTextStringLegend 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.
lineAlphaNumber1Opacity of the line (or column border). Value range is 0 - 1.
lineColorColorColor 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.
lineColorFieldStringName 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.
lineThicknessNumber1Specifies thickness of the graph line (or column border).
lowFieldStringName of the low field (used by candlesticks and ohlc) in your dataProvider.
markerTypeStringLegend 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.
maxBulletSizeNumber50Specifies size of the bullet which value is the biggest (XY chart).
minBulletSizeNumber4Specifies minimum size of the bullet (XY chart).
minDistanceNumber1It 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.
negativeBaseNumber0If 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.
negativeFillAlphasNumberFill opacity of negative part of the graph. Will use fillAlphas if not set.
negativeFillColorsColorFill color of negative part of the graph. Will use fillColors if not set.
negativeLineAlphaNumber1Opacity of the negative portion of the line (or column border). Value range is 0 - 1.
negativeLineColorColorColor 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.
newStackBooleanfalseIf you set it to true, column chart will begin new stack. This allows having Clustered and Stacked column/bar chart.
noStepRisersBooleanfalseIn case you want to have a step line graph without risers, you should set this to true.
openFieldStringName of the open field (used by floating columns, candlesticks and ohlc) in your dataProvider.
patternObjectValue 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.
patternFieldStringField 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.
periodSpanNumber1This property can be used by step graphs - you can set how many periods one horizontal line should span.
periodValueStringCloseWhen data is grouped to periods, the graph must know which period value should be used. Possible values are: "Open", "Low", "High", "Close", "Average" and "Sum".
pointPositionStringmiddleSpecifies 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"
precisionNumberPrecision of values. Will use chart's precision if not set any.
proCandlesticksBooleanfalse 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.
recalculateValueNumber/StringPossible values are Open, Close, High, Low, Average and Sum. There is no default value set – graph uses it’s periodValue when calculating changes. For example, the graph’s periodValue is Close. This means that when data is grouped to longer periods (months for example) when recalculating, the graph will use Close value of the first period of the selection as base value and will compare each months Close value to it. If you set recalculateValue to Open, the first value of a month will be used as base value.
segmentDataObjectGantt chart only. Contains unmodified segment object from data provider.
showAllValueLabelsBooleanfalseIf 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.
showBalloonBooleantrueSpecifies whether the value balloon of this graph is shown when mouse is over data item or chart's indicator is over some series.
showBalloonAtStringcloseSpecifies 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.
showBulletsAtStringcloseWorks 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.
showEventsOnComparedGraphsBooleanfalseSpecifies if events of compared graphs should be shown.
showHandOnHoverBooleanfalseIf you want mouse pointer to change to hand when hovering the graph, set this property to true.
showOnAxisBooleanfalse 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.
stackableBooleantrueIf the value axis of this graph has stack types like "regular" or "100%" You can exclude this graph from stacking.
stepDirectionStringrightStep graph only. Specifies to which direction step should be drawn.
switchableBooleantrueIf you set it to false, the graph will not be hidden when user clicks on legend entry.
tabIndexNumberIn 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.
titleStringGraph title.
topRadiusNumberIf 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.
typeStringlineType of the graph. Possible values are: "line", "column", "step", "smoothedLine", "candlestick", "ohlc". XY and Radar charts can only display "line" type graphs.
urlFieldStringName of the url field in your dataProvider.
urlTargetStringTarget to open URLs in, i.e. _blank, _top, etc.
useDataSetColorsBooleantrueSpecifies whether data set color should be used as this graph's lineColor. By default all graphs from the same data set will have a color from its relative DataSet (either auto-assigned by chart or set by color parameter). The graph's color properties will be ignored.

To disable this behavior, set "useDataSetColors" to false. This way the chart will use graph's own color settings, such as "lineColor" or auto-assign the color if those are not set.
useLineColorForBulletBorderBooleanfalseIf set to true, the bullet border will take the same color as graph line.
useNegativeColorIfDownBooleanfalse 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.
valueAxisValueAxisValueAxisSpecifies 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.
valueFieldStringName of the value field in your dataProvider.
visibleInLegendBooleantrueSpecifies whether this graph should be shown in the Legend.
xAxisValueAxisValueAxisXY chart only. A horizontal value axis object to attach graph to.
xFieldStringXY chart only. Name of the x field in your dataProvider.
yAxisValueAxisValueAxisXY chart only. A vertical value axis object to attach graph to.
yFieldStringXY chart only. Name of the y field in your dataProvider.

Methods Hide inherited

hideBullets()Hides graph's bullets.
showBullets()Shows graph's bullets

Events Hide inherited

StockGraph class does not have any events.