Type class
AmRectangularChart is a base class of AmSerialChart and AmXYChart. It can not be instantiated explicitly.
Inheritance
AmRectangularChart extends AmCoordinateChart
.
AmRectangularChart is extended by AmXYChart
, AmXYChart
, AmSerialChart
, AmSerialChart
.
Properties
angle # |
Type Default The angle of the 3D part of plot area. This creates a 3D effect (if the "depth3D" is > 0). |
---|---|
autoMarginOffset # |
Type Default Space left from axis labels/title to the chart's outside border, if autoMargins set to true. |
autoMargins # |
Type Default 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. |
chartCursor # |
Type Default Chart cursor. |
chartScrollbar # |
Type Default Chart scrollbar. |
depth3D # |
Type Default The depth of the 3D part of plot area. This creates a 3D effect (if the "angle" is > 0). |
marginBottom # |
Type Default 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 Default 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 Default 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 Default Flag which should be set to false if you need margins to be recalculated on next chart.validateNow() call. |
marginTop # |
Type Default 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. |
plotAreaGradientAngle # |
Type Default 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. |
trendLines # |
Type 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 |
zoomOutButton # |
Type Default 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. |
zoomOutText # |
Type Default Text in the zoom-out button. |
colors # |
Type Default Inherited from 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. |
graphs # |
Type Default Inherited from The array of graphs belonging to this chart. To add/remove graph use addGraph/removeGraph methods instead of adding/removing graphs directly to array. |
plotAreaBorderAlpha # |
Type Default Inherited from The opacity of plot area's border. Value range is 0 - 1. |
plotAreaBorderColor # |
Type Default Inherited from 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 Default Inherited from 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 Default Inherited from You can set both one color if you need a solid color or array of colors to generate gradients, for example: ["#000000", "#0000CC"] |
sequencedAnimation # |
Type Default Inherited from Specifies whether the animation should be sequenced or all objects should appear at once. |
startAlpha # |
Type Default Inherited from 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. |
startDuration # |
Type Default Inherited from Duration of the animation, in seconds. |
startEffect # |
Type Default Inherited from Animation effect. Possible values are ">", "<", elastic" and "bounce". |
urlTarget # |
Type Default Inherited from Target of url. |
valueAxes # |
Type Default Inherited from 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. |
backgroundColor # |
Type Default Inherited from 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 Default Inherited from 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 Default Inherited from Opacity of chart's border. Value range is 0 - 1. |
borderColor # |
Type Default Inherited from 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. |
color # |
Type Default Inherited from Text color. |
dataProvider # |
Type Inherited from Array of data objects, for example: [{country:"US", value:524},{country:"UK", value:624},{country:"Lithuania", value:824}]. You can have any number of fields and use any field names. In case of AmMap, data provider should be MapData object. |
fontFamily # |
Type Default Inherited from Font family. |
fontSize # |
Type Default Inherited from Font size. |
height # |
Type Default Inherited from 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 Inherited from Reference to the div of the legend. |
numberFormatter # |
Type Default Inherited from 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 Default Inherited from 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 Inherited from Specifies path to the folder where images like resize grips, lens and similar are. |
percentFormatter # |
Type Default Inherited from Object with precision, decimalSeparator and thousandsSeparator set which will be used for formatting percent values. |
prefixesOfBigNumbers # |
Type Default Inherited from 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 Default Inherited from 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. |
usePrefixes # |
Type Default Inherited from If true, prefixes will be used for big and small numbers. You can set arrays of prefixes via prefixesOfSmallNumbers and prefixesOfBigNumbers properties. |
version # |
Type Inherited from Read-only. Indicates current version of a script. |
There are 30 inherited items currently hidden from this list. |
Methods
addChartCursor( |
Returns Adds a ChartCursor object to a chart cursor - instace of ChartCursor |
---|---|
addChartScrollbar( |
Returns Adds a ChartScrollbar to a chart scrollbar - instance of ChartScrollbar |
addGraph( |
Returns Inherited from Adds a graph to the chart. graph - instance of AmGraph |
addLabel( |
Returns Inherited from 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 Inherited from 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 Inherited from 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 Inherited from 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 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 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 You can trigger the animation of the chart. |
clear() |
Returns Inherited from Clears the chart area, intervals, etc. |
clearLabels() |
Returns Inherited from Removes all labels added to the chart. |
getGraphById( |
Returns Inherited from Returns graph by id. id - graph's id, String |
getValueAxisById( |
Returns Inherited from Returns value axis by id. id - value axis' id, String |
hideGraph( |
Returns Inherited from 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 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 Highlight the graph. Usually this method is called from the Legend, when you roll-over the legend entry. graph - instance of AmGraph |
invalidateSize() |
Returns Inherited from Use this method to force the chart to resize to it's current container size. |
removeChartCursor() |
Returns Removes cursor from the chart |
removeChartScrollbar() |
Returns Removes scrollbar from the chart |
removeGraph( |
Returns Inherited from Removes graph from the chart. graph - instance of AmGraph |
removeLegend() |
Returns Inherited from Removes chart's legend. |
removeListener( |
Returns Inherited from Removes event listener from chart object. chart - chart object, type - event name, handler - method |
removeTrendLine( |
Returns Removes a trend line from a chart. You should call chart.validateNow() in order the changes to be visible. trendLine |
removeValueAxis( |
Returns Inherited from 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 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 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 UnhighlightGraph the graph. Usually this method is called from the Legend, when you roll-out the legend entry. graph - instance of AmGraph |
validateData() |
Returns Inherited from 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 Inherited from 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 Inherited from Adds chart to the specified DIV. container - id of a DIV or DIV object which will hold the chart |
There are 25 inherited items currently hidden from this list. |
Events
#clickGraph |
Param Inherited from Dispatched when user clicks on a graph. |
---|---|
#clickGraphItem |
Param Inherited from Dispatched when user clicks on the data item (column/bullet) |
#rightClickGraphItem |
Param Inherited from Dispatched when user right-clicks on the data item (column/bullet) |
#rollOutGraphItem |
Param Inherited from Dispatched when user rolls-out of the data item (column/bullet) |
#rollOverGraphItem |
Param Inherited from Dispatched when user rolls-over data item (column/bullet) |
#dataUpdated |
Param Inherited from Dispatched when chart is build for the first time or after validateData() method was called. |
#init |
Param Inherited from Dispatched when chart is build for the first time. |
#rendered |
Param Inherited from Dispatched when the chart is build for the first time. |
There are 8 inherited items currently hidden from this list. |
Adapters
AmRectangularChart does not have any adapters.