class anychart.charts.CircularGauge Improve this Doc
Extends: anychart.core.Chart
Circular gauge class. Learn more about Circular Gauge
Methods Overview
| Specific settings | |
| a11y() | Accessibility settings. |
| cap() | Cap settings. |
| getType() | Returns gauge type. |
| globalToLocal() | Converts the global coordinates to local coordinates. |
| localToGlobal() | Converts the local coordinates to global coordinates. |
| startAngle() | Start angle settings. |
| sweepAngle() | Sweep angle settings. |
| toA11yTable() | Creates and returns the chart represented as an invisible HTML table. |
| toHtmlTable() | Creates and returns a chart as HTML table. |
| Axes and Scales | |
| axis() | Axis settings. |
| range() | Range settings. |
| Chart Controls | |
| contextMenu() | Context menu settings. |
| credits() | Credits settings |
| label() | Label settings. |
| title() | Title settings. |
| Coloring | |
| background() | Background settings. |
| fill() | Fill settings. |
| selectRectangleMarqueeFill() | Select marquee fill settings. |
| selectRectangleMarqueeStroke() | Stroke settings. |
| stroke() | Stroke settings. |
| Data | |
| data() | Data settings. |
| noData() | NoData settings. |
| Events | |
| listen() | Adds an event listener. |
| listenOnce() | Adds a single time event listener. |
| removeAllListeners() | Removes all listeners. |
| unlisten() | Removes the listener. |
| unlistenByKey() | Removes the listener by the key. |
| Export | |
| exports() | Exports settings |
| getJpgBase64String() | Returns JPG as base64 string. |
| getPdfBase64String() | Returns PDF as base64 string. |
| getPngBase64String() | Returns PNG as base64 string. |
| getSvgBase64String() | Returns SVG as base64 string. |
| print() | Prints chart. |
| saveAsCsv() | Saves chart data as a CSV file. |
| saveAsJpg() | Saves the chart as JPEG image. |
| saveAsJson() | Saves chart config as JSON document. |
| saveAsPdf() | Saves the chart as PDF image. |
| saveAsPng() | Saves the chart as PNG image. |
| saveAsSvg() | Saves the chart as SVG image. |
| saveAsXlsx() | Saves chart data as an Excel document. |
| saveAsXml() | Saves chart config as XML document. |
| shareAsJpg() | Shares a chart as a JPG file and returns a link to the shared image. |
| shareAsPdf() | Shares a chart as a PDF file and returns a link to the shared image. |
| shareAsPng() | Shares a chart as a PNG file and returns a link to the shared image. |
| shareAsSvg() | Shares a chart as a SVG file and returns a link to the shared image. |
| shareWithFacebook() | Opens Facebook sharing dialog. |
| shareWithLinkedIn() | Opens LinkedIn sharing dialog. |
| shareWithPinterest() | Opens Pinterest sharing dialog. |
| shareWithTwitter() | Opens Twitter sharing dialog. |
| toCsv() | Returns CSV string with the chart data. |
| toSvg() | Returns SVG string. |
| Interactivity | |
| startSelectRectangleMarquee() | Starts select marquee drawing. |
| tooltip() | Tooltip settings. |
| Pointers | |
| bar() | Bar settings. |
| knob() | Knob settings. |
| marker() | Marker settings. |
| needle() | Needle settings. |
| Size and Position | |
| bottom() | Bottom bound setting. |
| bounds() | Bounds settings. |
| circularPadding() | Padding settings. |
| encloseWithStraightLine() | Encloses frame path with a straight line. |
| getPixelBounds() | Returns pixel bounds of the chart. |
| height() | Height setting. |
| left() | Left bound setting. |
| margin() | Margin settings. |
| maxHeight() | Maximum height setting. |
| maxWidth() | Maximum width setting. |
| minHeight() | Minimum height setting. |
| minWidth() | Minimum width setting. |
| padding() | Padding settings. |
| right() | Right bound setting. |
| top() | Top bound setting. |
| width() | Width setting. |
| zIndex() | Z-index of the chart. |
| Specific Pointers Settings | |
| addPointer() | Adds pointers to the gauge. |
| defaultPointerType() | Default pointer type. |
| getPointer() | Returns pointer by id. |
| getPointerAt() | Returns pointer by index. |
| getPointersCount() | Returns the number of pointers. |
| removeAllPointers() | Removes all pointers from the gauge. |
| removePointer() | Removes pointer by id. |
| removePointerAt() | Removes pointer by index. |
| XML/JSON | |
| toJson() | Returns chart configuration as JSON object or string. |
| toXml() | Returns chart configuration as XML string or XMLNode. |
| Miscellaneous | |
| autoRedraw() | Redraw chart after changes or not. |
| cancelMarquee() | Stops marquee action if any. |
| container() | Chart container |
| draw() | Chart drawing |
| fullScreen() | Fullscreen mode. |
| id() | Chart id. |
| inMarquee() | Gets marquee process running value. |
| isFullScreenAvailable() | Whether the fullscreen mode available in the browser or not. |
Methods Description
a11y
Getter for the accessibility setting.
Returns:
anychart.core.utils.ChartA11y - Accessibility settings object. See listing.
var stateOfAccsessibility = chart.a11y();
Setter for the accessibility setting.
Detailed description
If you want to enable accessibility you need to turn it on using anychart.charts.CircularGauge#a11y method.
Sets accessibility setting depending on parameter type:
Sets accessibility setting depending on parameter type:
- boolean - disable or enable accessibility.
- object - sets accessibility setting.
Params:
| Name | Type | Description |
|---|---|---|
| settings | boolean | Object | Whether to enable accessibility or object with settings. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.addPointer
Adds pointers to the gauge.
Params:
| Name | Type | Description |
|---|---|---|
| var_args | anychart.data.View | anychart.data.Set | Array | Circular gauge data. |
Returns:
Array.<anychart.core.gauge.pointers.Base> - Array of created pointers.Try it:
autoRedraw
Getter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.
Flag whether to automatically call chart.draw() on any changes or not.
Returns:
boolean - AutoRedraw flag. See listing
var autoRedraw = chart.autoRedraw();
Setter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.
Flag whether to automatically call chart.draw() on any changes or not.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
axis
Getter for default gauge axis settings.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of gauge axis. |
Returns:
anychart.core.axes.Circular - Axis instance.Try it:
Setter for the gauge axis settings.
Detailed description
Sets gauge axis settings depending on parameter type:
- null/boolean - disable or enable gauge axis.
- object - sets gauge axis settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Axis settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Setter for the gauge axis by index.
Detailed description
Sets gauge axis settings depending on parameter type:
- null/boolean - disable or enable gauge axis by index.
- object - sets gauge axis settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Index of gauge axis. |
| settings | Object | boolean | null | Gauge axis settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.background
Setter for the chart background settings.
Detailed description
Sets chart background settings depending on parameter type:
- null/boolean - disable or enable chart background.
- object - sets chart background settings.
- string - sets chart background color.
Params:
| Name | Type | Description |
|---|---|---|
| settings | string | Object | null | boolean | Background settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.bar
Getter for the bar pointer.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Bar pointer index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.gauge.pointers.Bar - Bar pointer instance by index.Try it:
Setter for the first bar pointer.
Detailed description
Sets first bar pointer settings depending on parameter type:
- null/boolean - disable or enable first bar pointer.
- object - sets first bar pointer settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Bar pointer settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Setter for the bar pointer by index.
Detailed description
Sets bar pointer settings depending on parameter type:
- null/boolean - disable or enable bar pointer by index.
- object - sets bar pointer settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Index of bar pointer. |
| settings | Object | boolean | null | Bar pointer settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.bottom
Getter for the chart's bottom bound setting.
Returns:
number | string | undefined - Chart's bottom bound setting. See listing
var bottom = chart.bottom();
Setter for the chart's bottom bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| bottom | number | string | null | null | Bottom bound setting for the chart. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
bounds
Getter for the chart bounds settings.
Returns:
anychart.core.utils.Bounds - Bounds of the element. See listing
var bounds = chart.bounds();
Setter for the chart bounds using one parameter.
Params:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of teh chart. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
Setter for the chart bounds settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| x | number | string | null | X-coordinate. |
| y | number | string | null | Y-coordinate. |
| width | number | string | null | Width. |
| height | number | string | null | Height. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
cancelMarquee
Stops marquee action if any.
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.cap
Setter for the gauge cap.
Detailed description
Sets gauge cap settings depending on parameter type:
- null/boolean - disable or enable gauge cap.
- object - sets gauge cap settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | false | Gauge cap settings. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.circularPadding
Setter for circular space around the gauge.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| padding | number | string | '10%' | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
container
Getter for the chart container.
Setter for the chart container.
Params:
| Name | Type | Description |
|---|---|---|
| element | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
contextMenu
Setter for the context menu.
Detailed description
Sets context menu settings depending on parameter type:
- null/boolean - disable or enable context menu.
- object - sets context menu settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Context menu settings |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.credits
Setter for chart credits.
Learn more about credits settings.
Detailed description
Note: You can't customize credits without your licence key. To buy licence key go to
Buy page.
Sets chart credits settings depending on parameter type:
Sets chart credits settings depending on parameter type:
- null/boolean - disable or enable chart credits.
- object - sets chart credits settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Credits settings |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.data
Setter for pointers mapping
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Value to set. |
| csvSettings | anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings | If CSV string is passed, you can pass CSV parser settings here as a hash map. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.defaultPointerType
Getter for the gauge pointer type by default.
Returns:
anychart.enums.CircularGaugePointerType | string - Default pointer type. See listing
var defaultPointerType = chart.defaultPointerType();
Setter for the gauge pointer type by default.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | anychart.enums.CircularGaugePointerType | string | 'needle' | Default pointer type. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
draw
Starts the rendering of the chart into the container.
Params:
| Name | Type | Description |
|---|---|---|
| async | boolean | Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
encloseWithStraightLine
Getter for enclosing frame path with a straight line.
Returns:
boolean - Boolean flag.Try it:
Setter for enclosing frame path with a straight line.
Detailed description
Boolean flag works for sweep angle more 180 degrees and encloses gauges frame with a straight line.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Boolean flag. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
exports
Getter for the export charts.
Returns:
anychart.core.utils.Exports - Exports settings. See listing
var exports = chart.exports();
Setter for the export charts.
Detailed description
To work with exports you need to reference the exports module from AnyChart CDN
(https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for latest or https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for the versioned file)
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Export settings. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
fill
Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | '#f5f5f5' | Color as an object or an array. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Fill color with opacity.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity (0 to 1). |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
fullScreen
Getter for the fullscreen mode.
Returns:
boolean - Full screen state (enabled/disabled). See listing
var fullScreen = chart.fullScreen();
Setter for the fullscreen mode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Enable/Disable fullscreen mode. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
getJpgBase64String
Returns JPG as base64 string.
Params:
| Name | Type | Description |
|---|---|---|
| onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
| onError | function(response:string) | Function that is called if sharing fails. |
| width | number | Image width. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| forceTransparentWhite | boolean | Force transparent to white or not. |
Try it:
getPdfBase64String
Returns PDF as base64 string.
Params:
| Name | Type | Description |
|---|---|---|
| onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
| onError | function(response:string) | Function that is called if sharing fails. |
| paperSizeOrWidth | number | string | Any paper format like 'a0', 'tabloid', 'b4', etc. |
| landscapeOrWidth | number | boolean | Define, is landscape. |
| x | number | Offset X. |
| y | number | Offset Y. |
Try it:
getPixelBounds
Returns pixel bounds of the chart.
Returns pixel bounds of the chart due to parent bounds and self bounds settings.
Returns pixel bounds of the chart due to parent bounds and self bounds settings.
Returns:
anychart.math.Rect - Pixel bounds of the chart.Try it:
getPngBase64String
Returns PNG as base64 string.
Params:
| Name | Type | Description |
|---|---|---|
| onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
| onError | function(response:string) | Function that is called if sharing fails. |
| width | number | Image width. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
Try it:
getPointer
Returns pointer by id.
Params:
| Name | Type | Description |
|---|---|---|
| id | number | string | Pointer id. |
Returns:
anychart.core.gauge.pointers.Base - Pointer instance.Try it:
getPointerAt
Returns pointer by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Pointer index. |
Returns:
anychart.core.gauge.pointers.Base - Pointer instance.Try it:
getPointersCount
getSvgBase64String
Returns SVG as base64 string.
Params:
| Name | Type | Description |
|---|---|---|
| onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
| onError | function(response:string) | Function that is called if sharing fails. |
| paperSizeOrWidth | string | number | Paper Size or width. |
| landscapeOrHeight | boolean | string | Landscape or height. |
Try it:
getType
globalToLocal
Converts the global coordinates to local coordinates.
Note: Works only after anychart.charts.CircularGauge#draw is called.
Detailed description
Converts global coordinates of the global document into local coordinates of the container or stage.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
Params:
| Name | Type | Description |
|---|---|---|
| xCoord | number | Global X coordinate. |
| yCoord | number | Global Y coordinate. |
Returns:
Object.<string, number> - Object with XY coordinates.Try it:
height
Getter for the chart's height setting.
Returns:
number | string | undefined - Chart's height setting. See listing
var height = chart.height();
Setter for the chart's height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Height setting for the chart. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
id
Setter for chart id.
Params:
| Name | Type | Description |
|---|---|---|
| id | string | Chart id. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
inMarquee
Gets marquee process running value.
Returns:
boolean - Returns true if there is a marquee process running.isFullScreenAvailable
Whether the fullscreen mode available in the browser or not.
Returns:
boolean - isFullScreenAvailable state.Try it:
knob
Getter for the knob pointer.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Knob pointer index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.gauge.pointers.Knob - Knob pointer instance by index.Try it:
Setter for the first knob pointer.
Detailed description
Sets first knob pointer settings depending on parameter type:
- null/boolean - disable or enable first knob pointer.
- object - sets first knob pointer settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Knob pointer settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Setter for the knob pointer by index.
Detailed description
Sets knob pointer settings depending on parameter type:
- null/boolean - disable or enable knob pointer by index.
- object - sets knob pointer settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Index of knob pointer. |
| settings | Object | boolean | null | Knob pointer settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.label
Getter for the chart label.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | string | number | 0 | Index of instance. |
Returns:
anychart.core.ui.Label - An instance of class.Try it:
Setter for the chart label.
Detailed description
Sets chart label settings depending on parameter type:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | null | boolean | Object | string | false | Chart label instance to add by index 0. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Setter for chart label using index.
Detailed description
Sets chart label settings by index depending on parameter type:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | string | number | 0 | Label index. |
| settings | null | boolean | Object | string | false | Chart label settings. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.left
Getter for the chart's left bound setting.
Returns:
number | string | undefined - Chart's left bound setting. See listing
var left = chart.left();
Setter for the chart's left bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| left | number | string | null | null | Left bound setting for the chart. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note: Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note: Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function(e:Object) | Callback method.
Function that looks like: function(event){
// event.actualTarget - actual event target
// event.currentTarget - current event target
// event.iterator - event iterator
// event.originalEvent - original event
// event.point - event point
// event.pointIndex - event point index
} | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
Adds an event listener to an implementing object.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note: In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note: In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function(e:Object) | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
localToGlobal
Converts the local coordinates to global coordinates.
Note: Works only after anychart.charts.CircularGauge#draw is called.
Detailed description
Converts local coordinates of the container or stage into global coordinates of the global document.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
Params:
| Name | Type | Description |
|---|---|---|
| xCoord | number | Local X coordinate. |
| yCoord | number | Local Y coordinate. |
Returns:
Object.<string, number> - Object with XY coordinates.Try it:
margin
Getter for the chart margin.
Detailed description
Also, you can use anychart.core.utils.Margin#bottom, anychart.core.utils.Margin#left,
anychart.core.utils.Margin#right, anychart.core.utils.Margin#top methods to setting paddings.
Returns:
anychart.core.utils.Margin - Chart margin.Try it:
Setter for the chart margin in pixels using a single complex object.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| margin | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining. Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.margin(5, 15));Try it:
Setter for the chart margin in pixels using several simple values.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value1 | string | number | 0 | Top or top-bottom space. |
| value2 | string | number | 0 | Right or right-left space. |
| value3 | string | number | 0 | Bottom space. |
| value4 | string | number | 0 | Left space. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining. Example.
// 1) all 10px chart.margin(10); // 2) top and bottom 10px, left and right 15px chart.margin(10, "15px"); // 3) top 10px, left and right 15px, bottom 5px chart.margin(10, "15px", 5); // 4) top 10px, right 15px, bottom 5px, left 12px chart.margin(10, "15px", "5px", 12);
Try it:
marker
Getter for the marker pointer.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Marker pointer index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.gauge.pointers.Marker - Marker pointer instance by index.Try it:
Setter for the first marker pointer.
Detailed description
Sets first marker pointer settings depending on parameter type:
- null/boolean - disable or enable first marker pointer.
- object - sets first marker pointer settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Marker pointer settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Setter for the marker pointer by index.
Detailed description
Sets marker pointer settings depending on parameter type:
- null/boolean - disable or enable marker pointer by index.
- object - sets marker pointer settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Index of marker pointer. |
| settings | Object | boolean | null | Marker pointer settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.maxHeight
Getter for the chart's maximum height.
Returns:
number | string | null - Chart's maximum height. See listing
var maxHeight = chart.maxHeight();
Setter for the chart's maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
maxWidth
Getter for the chart's maximum width.
Returns:
number | string | null - Chart's maximum width. See listing
var maxWidth = chart.maxWidth();
Setter for the chart's maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
minHeight
Getter for the chart's minimum height.
Returns:
number | string | null - Chart's minimum height. See listing
var minHeight = chart.minHeight();
Setter for the chart's minimum height.
Detailed description
The method sets a minimum height of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
minWidth
Getter for the chart's minimum width.
Returns:
number | string | null - Chart's minimum width. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); var minWidth = chart.minWidth();
Setter for the chart's minimum width.
Detailed description
The method sets a minimum width of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
needle
Getter for the needle pointer.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Needle pointer index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.gauge.pointers.Needle - Needle pointer instance by index.Try it:
Setter for the first needle pointer.
Detailed description
Sets first needle pointer settings depending on parameter type:
- null/boolean - disable or enable first needle pointer.
- object - sets first needle pointer settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Needle pointer settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Setter for the needle pointer by index.
Detailed description
Sets needle pointer settings depending on parameter type:
- null/boolean - disable or enable needle pointer by index.
- object - sets needle pointer settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Index of needle pointer. |
| settings | Object | boolean | null | Needle pointer settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.noData
Setter for noData settings.
Learn more about "No data" feature
Learn more about "No data" feature
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | NoData settings. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
padding
Getter for the chart padding.
Detailed description
Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left,
anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.
Returns:
anychart.core.utils.Padding - Chart padding.Try it:
Setter for the chart paddings in pixels using a single value.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| padding | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining. See listing.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});Try it:
Setter for the chart paddings in pixels using several numbers.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value1 | string | number | 0 | Top or top-bottom space. |
| value2 | string | number | 0 | Right or right-left space. |
| value3 | string | number | 0 | Bottom space. |
| value4 | string | number | 0 | Left space. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining. Example.
// 1) all 10px chart.padding(10); // 2) top and bottom 10px, left and right 15px chart.padding(10, "15px"); // 3) top 10px, left and right 15px, bottom 5px chart.padding(10, "15px", 5); // 4) top 10px, right 15%, bottom 5px, left 12px chart.padding(10, "15%", "5px", 12);
Try it:
Prints chart.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| paperSize | anychart.graphics.vector.PaperSize | Paper size. | |
| landscape | boolean | false | Flag of landscape. |
Try it:
range
Getter for the circular range.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Circular range index. If not set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axisMarkers.CircularRange - Circular range instance by index.Try it:
Setter for the circular first range settings.
Detailed description
Sets circular first range settings depending on parameter type:
- null/boolean - disable or enable circular first range.
- object - sets circular first range settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Circular range settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Setter for the circular range settings by index.
Detailed description
Sets circular range settings depending on parameter type:
- null/boolean - disable or enable circular range.
- object - sets circular range settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Index of range. |
| settings | Object | boolean | null | Circular range settings to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.removeAllListeners
Removes all listeners from an object. You can also optionally remove listeners of some particular type.
Params:
| Name | Type | Description |
|---|---|---|
| type | string | Type of event to remove, default is to remove all types. |
Returns:
number - Number of listeners removed.Try it:
removeAllPointers
Removes all pointers from the gauge.
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
removePointer
Removes pointer by id.
Params:
| Name | Type | Description |
|---|---|---|
| id | number | string | Pointer id. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
removePointerAt
Removes pointer by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Pointer index. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
right
Getter for the chart's right bound setting.
Returns:
number | string | undefined - Chart's right bound setting. See listing
var right = chart.right();
Setter for the chart's right bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| right | number | string | null | null | Right bound setting for the chart. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
saveAsCsv
Saves chart data as a CSV file.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | anychart.enums.ChartDataExportMode | string | Data export mode. |
| csvSettings | Object.<string, (string|boolean|undefined|function(name:*, value:*))> | CSV settings object:
Formatters must be represented as one of:
|
| filename | string | File name to save. |
Try it:
saveAsJpg
Saves the chart as JPEG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| forceTransparentWhite | boolean | Define, should we force transparent to white background. |
| filename | string | File name to save. |
Try it:
saveAsJson
Saves chart config as JSON document.
Params:
| Name | Type | Description |
|---|---|---|
| filename | string | File name to save. |
Try it:
saveAsPdf
Saves the chart as PDF image.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Any paper format like 'a0', 'tabloid', 'b4', etc. |
| landscape | boolean | Define, is landscape. |
| x | number | Offset X. |
| y | number | Offset Y. |
| filename | string | File name to save. |
Try it:
saveAsPng
Saves the chart as PNG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| filename | string | File name to save. |
Try it:
saveAsSvg
Saves the chart as SVG image using paper size and landscape.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Paper Size. |
| landscape | boolean | Landscape. |
| filename | string | File name to save. |
Try it:
Saves the stage as SVG image using width and height.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Try it:
saveAsXlsx
Saves chart data as an Excel document.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | anychart.enums.ChartDataExportMode | string | Data export mode. |
| filename | string | File name to save. |
| exportOptions | Object.<string, (function(name:*, value:*))> | Export options:
Formatter must be represented as one of:
|
Try it:
saveAsXml
Saves chart config as XML document.
Params:
| Name | Type | Description |
|---|---|---|
| filename | string | File name to save. |
Try it:
selectRectangleMarqueeFill
Getter for the select marquee fill.
Returns:
anychart.graphics.vector.Fill - Select marquee fill. See listing
var selectRectangleMarqueeFill = chart.selectRectangleMarqueeFill();
Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Fill color with opacity. Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
selectRectangleMarqueeStroke
Getter for the select marquee stroke.
Returns:
anychart.graphics.vector.Stroke - Select marquee stroke. See listing.
var selectRectangleMarqueeStroke = chart.selectRectangleMarqueeStroke();
Setter for the select marquee stroke.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
shareAsJpg
shareAsPdf
shareAsPng
shareAsSvg
shareWithFacebook
shareWithLinkedIn
shareWithPinterest
shareWithTwitter
startAngle
Setter for the start angle.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| angle | string | number | 0 | Start angle to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
startSelectRectangleMarquee
Starts select marquee drawing.
Note: Works only after anychart.charts.CircularGauge#draw is called.
Params:
| Name | Type | Description |
|---|---|---|
| repeat | boolean | Whether to start select marquee drawing. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
stroke
Setter for stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | "#ccc" | Stroke settings. |
| thickness | number | Line thickness. | |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
Setter for stroke settings using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with stroke settings from anychart.graphics.vector.Stroke |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
sweepAngle
Setter for the gauge sweep angle.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| angle | string | number | 360 | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
title
Setter for the chart title.
Detailed description
Sets chart title settings depending on parameter type:
- null/boolean - disable or enable chart title.
- string - sets chart title text value.
- object - sets chart title settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | null | boolean | Object | string | false | Chart title text or title instance for copy settings from. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.toA11yTable
Creates and returns the chart represented as an invisible HTML table.
Detailed description
This method generates an invisible HTML table for accessibility purposes. The table is only available for Screen Readers.
Params:
| Name | Type | Description |
|---|---|---|
| title | string | Title to set. |
| asString | boolean | Defines output: HTML string if True, DOM element if False. |
Returns:
Element | string | null - HTML table instance with a11y style (invisible), HTML string or null if parsing chart to table fails.Try it:
toCsv
Returns CSV string with the chart data.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | anychart.enums.ChartDataExportMode | string | Data export mode. |
| csvSettings | Object.<string, (string|boolean|undefined|function(name:*, value:*)|Object)> | CSV settings. CSV settings object: rowsSeparator - string or undefined (default is '\n') columnsSeparator - string or undefined (default is ',') ignoreFirstRow - boolean or undefined (default is 'false') formats - 1) a function with two arguments such as the field name and value, that returns the formatted value or 2) the object with the key as the field name, and the value as a format function. (default is 'undefined'). |
Returns:
string - CSV string.Try it:
toHtmlTable
Creates and returns a chart as HTML table.
Detailed description
This method generates an HTML table which contains chart data.
Params:
| Name | Type | Description |
|---|---|---|
| title | string | Title to set. |
| asString | boolean | Defines output: HTML string if True, DOM element if False. |
Returns:
Element | string | null - HTML table instance, HTML string or null if parsing chart to table fails.Try it:
toJson
Returns chart configuration as JSON object or string.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| stringify | boolean | false | Returns JSON as string. |
Returns:
Object | string - Chart configuration.toSvg
Returns SVG string using paper size and landscape.
Detailed description
Returns SVG string if type of content is SVG otherwise returns empty string.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Paper Size. |
| landscape | boolean | Landscape. |
Returns:
string - SVG content or empty string.Try it:
Returns SVG string using width and height.
Detailed description
Returns SVG string if type of content is SVG otherwise returns empty string.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Returns:
string - SVG content or empty string.Try it:
toXml
Returns chart configuration as XML string or XMLNode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| asXmlNode | boolean | false | Return XML as XMLNode. |
Returns:
string | Node - Chart configuration.tooltip
Getter for the chart tooltip.
Returns:
anychart.core.ui.Tooltip - Tooltip settings. See listing.
var tooltip = chart.tooltip();
Setter for the chart tooltip.
Detailed description
Sets tooltip settings depending on parameter type:
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Chart tooltip settings. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.top
Getter for the chart's top bound setting.
Returns:
number | string | undefined - Chart's top bound setting. See listing
var top = chart.top();
Setter for the chart's top bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| top | number | string | null | null | Top bound setting for the chart. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
unlisten
Removes a listener added using listen() or listenOnce() methods.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function(e:Object) | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
Params:
| Name | Type | Description |
|---|---|---|
| key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
width
Getter for the chart's width setting.
Returns:
number | string | undefined - Chart's width setting. See listing
var width = chart.width();
Setter for the chart's width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Width settings for the chart. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it:
zIndex
Getter for the Z-index of the chart.
Returns:
number - Chart Z-index. See listing
var zIndex = chart.zIndex();
Setter for the Z-index of the chart.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.charts.CircularGauge - Self instance for method chaining.Try it: