Inheritance: AmAngularGauge → AmChart
Extension for AmChart to create gauge charts.
var chart = AmCharts.makeChart("chartdiv",{
"type": "gauge",
"arrows": [
{
"value": 130
}
],
"titles": [
{
"text": "Speedometer",
"size": 15
}
],
"axes": [
{
"bottomText": "0 km/h",
"endValue": 220,
"valueInterval": 10,
"bands": [
{
"color": "#00CC00",
"endValue": 90,
"startValue": 0
},
{
"color": "#ffac29",
"endValue": 130,
"startValue": 90
},
{
"color": "#ea3838",
"endValue": 220,
"startValue": 130,
"innerRadius": "95%"
}
]
}
]
});
| Property | Type | Default | Description |
|---|---|---|---|
| accessible | Boolean | true | When enabled, chart adds aria-label attributes to columns, bullets or map objects. You can control values of these labels using properties like accessibleLabel of AmGraph. Note, not all screen readers support these tags. We tested this mostly with NVDA Screen reader. WAI-ARIA is now official W3 standard, so in future more readers will handle this well. We will be improving accessibility on our charts, so we would be glad to hear your feedback. |
| accessibleTitle | String | <title> element will be added to <svg> node if you set any. It is read by most of the screen readers. | |
| addClassNames | Boolean | false | Specifies, if class names should be added to chart elements. |
| adjustSize | Boolean | true | Uses the whole space of the canvas to draw the gauge. |
| allLabels | Array[Label] | [] | Array of Labels. Example of label object, with all possible properties: {"x": 20, "y": 20, "text": "this is label", "align": "left", "size": 12, "color": "#CC0000", "alpha": 1, "rotation": 0, "bold": true, "url": "http://www.amcharts.com"} |
| arrows | Array[GaugeArrow] | Array of arrows. | |
| autoDisplay | Boolean | false | If you set it to true the chart will automatically monitor changes of display style of chart’s container (or any of it’s parents) and will render chart correctly if it is changed from none to block. We recommend setting it to true if you change this style at a run time, as it affects performance a bit. |
| autoResize | Boolean | true | Set this to false if you don't want chart to resize itself whenever its parent container size changes. |
| autoTransform | Boolean | false | If you set it to true and your chart div (or any of the parent div) has css scale applied, the chart will position mouse at a correct position. Default value is false because this operation consumes some CPU and quite a few people are using css transfroms. |
| axes | Array[GaugeAxis] | Array of axes. | |
| backgroundAlpha | Number | 0 | Opacity of background. Set it to >0 value if you want backgroundColor to work. However we recommend changing div's background-color style for changing background color. |
| backgroundColor | Color | #FFFFFF | 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 | AmBalloon | 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. |
| borderAlpha | Number | 0 | Opacity of chart's border. Value range is 0 - 1. |
| borderColor | Color | #000000 | 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. |
| classNamePrefix | String | amcharts | This prefix is added to all class names which are added to all visual elements of a chart in case addClassNames is set to true. |
| clockWiseOnly | Boolean | false | In case you use gauge to create a clock, set this to true. |
| color | Color | #000000 | Text color. |
| creditsPosition | String | top-left | Non-commercial version only. Specifies position of link to amCharts site. Allowed values are: top-left, top-right, bottom-left and bottom-right. |
| dataLoader | Object | A config object for Data Loader plugin. Please refer to the following page for more information. | |
| dataProvider | Array[Object] | 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. The data set data. Important: if you are using date/time-based category axis, the data points needs to come pre-ordered in ascending order. Data with incorrect order might result in visual and functional glitches on the chart. | |
| decimalSeparator | String | . | Decimal separator. |
| defs | Object | Using this property you can add any additional information to SVG, like SVG filters or clip paths. The structure of this object should be identical to XML structure of a object you are adding, only in JSON format. | |
| export | Object | Export config. Specifies how export to image/data export/print/annotate menu will look and behave. You can find a lot of examples in amcharts/plugins/export folder. More details can be found here. | |
| faceAlpha | Number | 0 | Gauge face opacity. |
| faceBorderAlpha | Number | 0 | Gauge face border opacity. |
| faceBorderColor | Color | #555555 | Gauge face border color. |
| faceBorderWidth | Number | 1 | Gauge face border width. |
| faceColor | Color | #FAFAFA | Gauge face color, requires faceAlpha > 0 |
| facePattern | Object | Gauge face image-pattern. Example: {"url":"../amcharts/patterns/black/pattern1.png", "width":4, "height":4} | |
| fontFamily | String | Verdana | Font family. |
| fontSize | Number | 11 | Font size. |
| gaugeX | Number | Gauge's horizontal position in pixel, origin is the center. Centered by default. | |
| gaugeY | Number | Gauge's vertical position in pixel, origin is the center. Centered by default. | |
| handDrawn | Boolean | false | If you set this to true, the lines of the chart will be distorted and will produce hand-drawn effect. Try to adjust chart.handDrawScatter and chart.handDrawThickness properties for a more scattered result. |
| handDrawScatter | Number | 2 | Defines by how many pixels hand-drawn line (when handDrawn is set to true) will fluctuate. |
| handDrawThickness | Number | 1 | Defines by how many pixels line thickness will fluctuate (when handDrawn is set to true). |
| hideBalloonTime | Number | 150 | Time, in milliseconds after which balloon is hidden if the user rolls-out of the object. Might be useful for AmMap to avoid balloon flickering while moving mouse over the areas. Note, this is not duration of fade-out. Duration of fade-out is set in AmBalloon class. |
| language | String | Allows changing language easily. Note, you should include language js file from amcharts/lang or ammap/lang folder and then use variable name used in this file, like chart.language = "de"; Note, for maps this works differently - you use language only for country names, as there are no other strings in the maps application. | |
| legend | AmLegend | Legend of a chart. | |
| legendDiv | String | Read-only. Reference to the div of the legend. | |
| listeners | Array[Object] | You can add listeners of events using this property. Example: listeners = [{"event":"dataUpdated", "method":handleEvent}]; | |
| marginBottom | Number | 10 | Bottom spacing between chart and container. |
| marginLeft | Number | 10 | Left-hand spacing between chart and container. |
| marginRight | Number | 10 | Right-hand spacing between chart and container. |
| marginTop | Number | 10 | Top spacing between chart and container. |
| minRadius | Number | 10 | Minimum radius of a gauge. |
| panEventsEnabled | Boolean | true | 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. 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, otherwise - false. |
| path | String | amcharts/ | Specifies absolute or relative path to amCharts files, i.e. "amcharts/". (where all .js files are located) If relative URLs are used, they will be relative to the current web page, displaying the chart. You can also set path globally, using global JavaScript variable AmCharts_path. If this variable is set, and "path" is not set in chart config, the chart will assume the path from the global variable. This allows setting amCharts path globally. I.e.: var AmCharts_path = "/libs/amcharts/"; "path" parameter will be used by the charts to locate it's files, like images, plugins or patterns. |
| pathToImages | String | Specifies path to the folder where images like resize grips, lens and similar are. IMPORTANT: Since V3.14.12, you should use "path" to point to amCharts directory instead. The "pathToImages" will be automatically set and does not need to be in the chart config, unless you keep your images separately from other amCharts files. | |
| percentPrecision | Number | 2 | Precision of percent values. -1 means percent values won't be rounded at all and show as they are. |
| precision | Number | -1 | Precision of values. -1 means values won't be rounded at all and show as they are. |
| prefixesOfBigNumbers | Array[Object] | [{"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"}] | 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 | Array[Object] | [{"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"}] | 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. |
| processCount | Number | 1000 | If processTimeout is > 0, 1000 data items will be parsed at a time, then the chart will make pause and continue parsing data until it finishes. |
| processTimeout | Number | 0 | If you set it to 1 millisecond or some bigger value, chart will be built in chunks instead of all at once. This is useful if you work with a lot of data and the initial build of the chart takes a lot of time, which freezes the whole web application by not allowing other processes to do their job while the chart is busy. |
| responsive | Object | A config object for Responsive plugin. Please refer to the following page for more information. | |
| startDuration | Number | 1 | Duration of arrow animation. |
| startEffect | String | easeInSine | Transition effect of the arrows, possible effects: easeOutSine, easeInSine, elastic, bounce. |
| svgIcons | Boolean | true | Charts will use SVG icons (some are loaded from images folder and some are drawn inline) if browser supports SVG. his makes icons look good on retina displays on all resolutions. |
| tapToActivate | Boolean | true | Charts which require gestures like swipe (charts with scrollbar/cursor) or pinch (maps) used to prevent regular page scrolling and could result page to stick to the same spot if the chart occupied whole screen. Now, in order these gestures to start working user has to touch the chart/maps once. Regular touch events like touching on the bar/slice/map area do not require the first tap and will show balloons and perform other tasks as usual. If you have a map or chart which occupies full screen and your page does not require scrolling, set tapToActivate to false – this will bring old behavior back. |
| theme | String | none | Theme of a chart. Config files of themes can be found in amcharts/themes/ folder. More info about using themes. |
| thousandsSeparator | String | , | Thousands separator. |
| titles | Array[Title] | [] | Array of Title objects. |
| touchClickDuration | Number | 0 | If you set it to 200 (milliseconds) or so, the chart will fire clickGraphItem or clickSlice (AmSlicedChart) or clickMapObject only if user holds his/her finger for 0.2 seconds (200 ms) on the column/bullet/slice/map object. |
| type | String | Type of a chart. Required when creating chart using JSON. Possible types are: serial, pie, xy, radar, funnel, gauge, map, stock. | |
| usePrefixes | Boolean | false | If true, prefixes will be used for big and small numbers. You can set arrays of prefixes via prefixesOfSmallNumbers and prefixesOfBigNumbers properties. |
| version | String | Read-only. Indicates current version of a script. |
| Name | Parameters | Returns | Description |
|---|---|---|---|
| addArrow(arrow) | arrow - GaugeArrow | Adds arrow to the chart. | |
| addAxis(axis) | axis - GaugeAxis | Adds axis to angular gauge. | |
| addLabel(x, y, text, align, size, color, rotation, alpha, bold, url) | 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 | 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. | |
| addLegend(legend, legendDivID) | legend - AmLegend, legendDivID - id or reference to legend div (optional) | 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.) | |
| addListener(type, handler) | 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 | Adds event listener to the object. | |
| addTitle(text, size, color, alpha, bold) | text - text of a title size - font size color - title color alpha - title opacity bold - boolean value indicating if title should be bold. | 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. | |
| clear() | Clears the chart area, intervals, etc. | ||
| clearLabels() | Removes all labels added to the chart. | ||
| invalidateSize() | Use this method to force the chart to resize to it's current container size. | ||
| makeChart(container, config, delay) | container - id of a DIV or reference of the container element - config contains the whole setup for the chart - delay in milliseconds to delay the initiation of the chart | chart instance | This method allows to create charts with a single config. |
| removeArrow(arrow) | arrow - GaugeArrow | Removes arrow from the chart. | |
| removeAxis(axis) | axis - GaugeAxis | Removes axis from the chart. | |
| removeLegend() | Removes chart's legend. | ||
| removeListener(chart, type, handler) | chart - chart object, type - event name, handler - method | Removes event listener from chart object. | |
| validateData() | 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(validateData, skipEvents) | This method should be called after you changed one or more properties of any class. The chart will redraw after this method is called.Both attributes, validateData and skipEvents are optional (false by default). | ||
| write(container) | container - id of a DIV or DIV object which will hold the chart | Adds chart to the specified DIV. |
| Name | Event object | Description |
|---|---|---|
| animationFinished | {type:"animationFinished", chart:AmChart} | Dispatched when initial chart animations are finished. |
| buildStarted | {type:"buildStarted", chart:AmChart} | Fired just before the chart starts to build itself for the first time. Note: you might need to set processTimeout to > 0 value in order to register this event properly. |
| dataUpdated | {type:"dataUpdated", chart:AmChart} | Dispatched when chart is build for the first time or after validateData() method was called. |
| drawn | {type:"drawn", chart:AmChart} | Fired every time chart is drawn or re-drawn - graph toggle, chart area resize, etc. Please note, that this event will not fire on zoom. Use "zoomed" event instead to catch those events. |
| init | {type:"init", chart:AmChart} | Dispatched when chart is build for the first time. |
| rendered | {type:"rendered", chart:AmChart} | Dispatched when the chart is build for the first time and each time after chart.validateNow() method is called and the chart is build. |