StockPanel

Type class

StockPanel class creates stock panels (charts). AmStockChart can have multiple Stock panels.

Sources

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

Inheritance

StockPanel extends AmSerialChart.

StockPanel is not extended by any other symbol.

Properties

#allowTurningOff

Type booleanDefault false

Specifies whether x button will be displayed near the panel. This button allows turning panel off.

#drawingIconsEnabled

Type booleanDefault false

If true, drawing icons will be displayed in top-right corner.

#drawOnAxis

Type ValueAxisDefault

Specifies on which value axis user can draw trend lines. Set drawingIconsEnabled to true if you want drawing icons to be visible. First value axis will be used if not set here.

#eraseAll

Type booleanDefault false

Specifies if all trend lines should be erased when erase button is clicked. If false, trend lines can be erased one by one.

#iconSize

Type numberDefault 18

Size of trend line drawing icons. If you change this size, you should update icon images if you want them to look properly.

#percentHeight

Type numberDefault

Relative height of panel. Possible values 0 - 100.

#recalculateToPercents

Type stringDefault whenComparing

Specifies when values should be recalculated to percents. Possible values are: "never", "always", "whenComparing".

#showCategoryAxis

Type booleanDefault true

Specifies whether this panel will show category axis.

#stockGraphs

Type Array of StockGraph objects

#stockLegend

Type StockLegendDefault

Stock chart legend.

#title

Type stringDefault

Title of a panel. Note, StockLegend should be added in order title to be displayed.

#trendLineAlpha

Type numberDefault 1

Trend line opacity.

#trendLineColor

Type stringDefault #00CC00

Trend line color.

#trendLineDashLength

Type numberDefault 0

Trend line dash length.

#trendLineThickness

Type numberDefault 2

Trend line thickness.

60 inherited items

#angle

Type numberDefault 0Inherited from AmRectangularChart

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

#autoMarginOffset

Type numberDefault 10Inherited from AmRectangularChart

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

#autoMargins

Type booleanDefault trueInherited from AmRectangularChart

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.

#backgroundColor

Type stringDefault #FFFFFFInherited from AmChart

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.

#balloon

Type AmBalloonDefault AmBalloonInherited from AmChart

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

#borderAlpha

Type numberDefault 0Inherited from AmChart

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

#borderColor

Type stringDefault #000000Inherited from AmChart

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.

#categoryAxis

Type CategoryAxisDefault instance of CategoryAxisInherited from AmSerialChart

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.

#categoryField

Type stringDefault Inherited from AmSerialChart

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

#chartCursor

Type ChartCursorDefault Inherited from AmRectangularChart

Chart cursor.

#chartData

Type arrayDefault Inherited from AmSerialChart

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

#chartScrollbar

Type ChartScrollbarDefault Inherited from AmRectangularChart

Chart scrollbar.

#color

Type stringDefault #000000Inherited from AmChart

Text color.

#colors

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

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.

#columnSpacing

Type numberDefault 5Inherited from AmSerialChart

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

#columnSpacing3D

Type numberDefault 0Inherited from AmSerialChart

Space between 3D stacked columns.

#columnWidth

Type numberDefault 0.8Inherited from AmSerialChart

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

#dataProvider

Type arrayDefault Inherited from AmSerialChart

Array holding chart's data.

#depth3D

Type numberDefault 0Inherited from AmRectangularChart

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

#endDate

Type DateDefault Inherited from AmSerialChart

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

#endIndex

Type numberDefault Inherited from AmSerialChart

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

#fontFamily

Type stringDefault VerdanaInherited from AmChart

Font family.

#fontSize

Type numberDefault 11Inherited from AmChart

Font size.

#graphs

Type arrayDefault Inherited from AmCoordinateChart

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

#height

Type Number/StringDefault 100%Inherited from AmChart

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.

#legendDiv

Type DIV objectInherited from AmChart

Reference to the div of the legend.

#marginBottom

Type numberDefault 20Inherited from AmRectangularChart

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.

#marginLeft

Type numberDefault 20Inherited from AmRectangularChart

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.

#marginRight

Type numberDefault 20Inherited from AmRectangularChart

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.

#marginsUpdated

Type booleanDefault falseInherited from AmRectangularChart

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

#marginTop

Type numberDefault 20Inherited from AmRectangularChart

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.

#maxSelectedSeries

Type numberDefault Inherited from AmSerialChart

Maximum number of series allowed to select.

#maxSelectedTime

Type numberDefault Inherited from AmSerialChart

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

#minSelectedTime

Type numberDefault 0Inherited from AmSerialChart

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

#numberFormatter

Type objectDefault {precision:-1, decimalSeparator:'.', thousandsSeparator:','}Inherited from AmChart

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.

#panEventsEnabled

Type booleanDefault falseInherited from AmChart

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.

#pathToImages

Type stringInherited from AmChart

Specifies path to the folder where images like resize grips, lens and similar are.

#percentFormatter

Type objectDefault {precision:2, decimalSeparator:'.', thousandsSeparator:','}Inherited from AmChart

Object with precision, decimalSeparator and thousandsSeparator set which will be used for formatting percent values.

#plotAreaBorderAlpha

Type numberDefault 0Inherited from AmCoordinateChart

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

#plotAreaBorderColor

Type stringDefault #000000Inherited from AmCoordinateChart

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.

#plotAreaFillAlphas

Type numberDefault 0Inherited from AmCoordinateChart

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.

#plotAreaFillColors

Type String/ArrayDefault #FFFFFFInherited from AmCoordinateChart

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

#plotAreaGradientAngle

Type numberDefault 0Inherited from AmRectangularChart

If you are using gradients to fill the plot area, you can use this property to set gradient angle. The only allowed values are horizontal and vertical: 0, 90, 180, 270.

#prefixesOfBigNumbers

Type arrayDefault [{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"}]Inherited from AmChart

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.

#prefixesOfSmallNumbers

Type arrayDefault [{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"}]Inherited from AmChart

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.

#rotate

Type booleanDefault falseInherited from AmSerialChart

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

#sequencedAnimation

Type booleanDefault trueInherited from AmCoordinateChart

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

#startAlpha

Type numberDefault 1Inherited from AmCoordinateChart

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.

#startDate

Type DateDefault Inherited from AmSerialChart

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

#startDuration

Type numberDefault 0Inherited from AmCoordinateChart

Duration of the animation, in seconds.

#startEffect

Type stringDefault elasticInherited from AmCoordinateChart

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

#startIndex

Type numberDefault Inherited from AmSerialChart

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

#trendLines

Type arrayInherited from AmRectangularChart

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

#urlTarget

Type stringDefault _selfInherited from AmCoordinateChart

Target of url.

#usePrefixes

Type booleanDefault falseInherited from AmChart

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

#valueAxes

Type arrayDefault Inherited from AmCoordinateChart

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.

#version

Type stringInherited from AmChart

Read-only. Indicates current version of a script.

#zoomOutButton

Type objectDefault {backgroundColor:'#b2e1ff',backgroundAlpha:1}Inherited from AmRectangularChart

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.

#zoomOutOnDataUpdate

Type booleanDefault trueInherited from AmSerialChart

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

#zoomOutText

Type stringDefault Show allInherited from AmRectangularChart

Text in the zoom-out button.

Methods

#addStockGraph()

Returns void

Adds a graph to the panel.

graph - instance of StockGraph

#removeStockGraph()

Returns void

Removes graph from the panel.

graph - instance of StockGraph

36 inherited items

#addChartCursor()

Returns voidInherited from AmRectangularChart

Adds a ChartCursor object to a chart cursor - instace of ChartCursor

#addChartScrollbar()

Returns voidInherited from AmRectangularChart

Adds a ChartScrollbar to a chart scrollbar - instance of ChartScrollbar

#addGraph()

Returns Inherited from AmCoordinateChart

Adds a graph to the chart.

graph - instance of AmGraph

#addLabel()

Returns voidInherited from AmChart

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 of a

#addLegend()

Returns voidInherited from AmChart

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.) legend - AmLegend, legendDivID - id or reference to legend div (optional)

#addListener()

Returns voidInherited from AmChart

Adds event listener to the object.

type - string like 'dataUpdated' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens

#addTitle()

Returns voidInherited from AmChart

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.

#addTrendLine()

Returns voidInherited from AmRectangularChart

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

trendLine

#addValueAxis()

Returns Inherited from AmCoordinateChart

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.

axis - instance of ValueAxis

#animateAgain()

Returns Inherited from AmCoordinateChart

You can trigger the animation of the chart.

#clear()

Returns voidInherited from AmChart

Clears the chart area, intervals, etc.

#clearLabels()

Returns voidInherited from AmChart

Removes all labels added to the chart.

#getCategoryIndexByValue()

Returns NumberInherited from AmSerialChart

Returns index of the specified category value.

value - series (category value) which index you want to find.

#getGraphById()

Returns AmGraphInherited from AmCoordinateChart

Returns graph by id.

id - graph's id, String

#getValueAxisById()

Returns ValueAxisInherited from AmCoordinateChart

Returns value axis by id.

id - value axis' id, String

#hideGraph()

Returns Inherited from AmCoordinateChart

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

graph - instance of AmGraph

#hideGraphsBalloon()

Returns Inherited from AmCoordinateChart

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

graph - instance of AmGraph

#highlightGraph()

Returns Inherited from AmCoordinateChart

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

graph - instance of AmGraph

#invalidateSize()

Returns voidInherited from AmChart

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

#removeChartCursor()

Returns Inherited from AmRectangularChart

Removes cursor from the chart

#removeChartScrollbar()

Returns Inherited from AmRectangularChart

Removes scrollbar from the chart

#removeGraph()

Returns Inherited from AmCoordinateChart

Removes graph from the chart.

graph - instance of AmGraph

#removeLegend()

Returns voidInherited from AmChart

Removes chart's legend.

#removeListener()

Returns voidInherited from AmChart

Removes event listener from chart object.

chart - chart object, type - event name, handler - method

#removeTrendLine()

Returns voidInherited from AmRectangularChart

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

trendLine

#removeValueAxis()

Returns Inherited from AmCoordinateChart

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

axis - instance of ValueAxis

#showGraph()

Returns Inherited from AmCoordinateChart

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

graph - instance of AmGraph

#showGraphsBalloon()

Returns Inherited from AmCoordinateChart

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

graph - instance of AmGraph

#unhighlightGraph()

Returns Inherited from AmCoordinateChart

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

graph - instance of AmGraph

#validateData()

Returns voidInherited from AmChart

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.

#validateNow()

Returns voidInherited from AmChart

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

#write()

Returns voidInherited from AmChart

Adds chart to the specified DIV.

container - id of a DIV or DIV object which will hold the chart

#zoomOut()

Returns Inherited from AmSerialChart

Zooms out, charts shows all available data.

#zoomToCategoryValues()

Returns Inherited from AmSerialChart

Zooms the chart by the value of the category axis.

start - category value, String \ end - category value, String

#zoomToDates()

Returns Inherited from AmSerialChart

Zooms the chart from one date to another.

start - start date, Date object \ end - end date, Date object

#zoomToIndexes()

Returns Inherited from AmSerialChart

Zooms the chart by the index of the category.

start - start index, Number \ end - end index, Number

Events

#changed

Param { type: "changed", target: StockPanel } & {type:"changed", index:Number, zooming:Boolean, chart:AmChart}

Dispatched when cursor position is changed. "index" is a series index over which chart cursors currently is. "zooming" specifies if user is currently zooming (is selecting) the chart.

#zoomed

Param { type: "zoomed", target: StockPanel } & {endDate:Date, endIndex:Number, endValue:String, startDate:Date, startIndex:Number, startValue:String, chart:AmChart}

Dispatched when the chart is zoomed (even for the first time, when chart is initialized)

#clickGraph

Param { type: "clickGraph", target: StockPanel } & {type:"clickGraph", graph:AmGraph, chart:AmChart}

Dispatched when user clicks on a graph.

#clickGraphItem

Param { type: "clickGraphItem", target: StockPanel } & {type:"clickGraphItem", graph:AmGraph, item:GraphDataItem, index:Number, chart:AmChart}

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

#rightClickGraphItem

Param { type: "rightClickGraphItem", target: StockPanel } & {type:"rightClickGraphItem", graph:AmGraph, item:GraphDataItem, index:Number, chart:AmChart}

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

#rollOutGraphItem

Param { type: "rollOutGraphItem", target: StockPanel } & {type:"rollOutGraphItem", graph:AmGraph, item:GraphDataItem, index:Number, chart:AmChart}

Dispatched when user rolls-out of the data item (column/bullet)

#rollOverGraphItem

Param { type: "rollOverGraphItem", target: StockPanel } & {type:"rollOverGraphItem", graph:AmGraph, item:GraphDataItem, index:Number, chart:AmChart}

Dispatched when user rolls-over data item (column/bullet)

#dataUpdated

Param { type: "dataUpdated", target: StockPanel } & {type:"dataUpdated", chart:AmChart}

Dispatched when chart is build for the first time or after validateData() method was called.

#init

Param { type: "init", target: StockPanel } & {type:"init", chart:AmChart}

Dispatched when chart is build for the first time.

#rendered

Param { type: "rendered", target: StockPanel } & {type:"rendered", chart:AmChart}

Dispatched when the chart is build for the first time.