Top
You are looking at an outdated 7.8.0 version of this document. Switch to the 7.14.3 version to see the up to date information.

class anychart.gauges.Circular Improve this Doc

Extends: anychart.core.Chart

Circular gauge class.

Methods Overview

Specific settings
bar()Bar settings.
cap()Cap settings.
getType()Returns gauge type.
knob()Knob settings.
marker()Marker settings.
needle()Needle settings.
startAngle()Start angle settings.
sweepAngle()Sweep angle settings.
Axes and Scales
axis()Axis settings.
range()Cap settings.
Chart Coloring
animation()Animation settings
background()Background settings.
Chart Controls
label()Label settings.
title()Title settings.
Coloring
fill()Fill settings.
stroke()Stroke settings.
Data
data()Data settings.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener.
removeAllListeners()Remove all listeners.
unlisten()Remove of the listener.
unlistenByKey()Remove of the listener by the key.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
tooltip()Tooltip settings.
Size and Position
bottom()Bottom bound setting.
bounds()Bounds settings.
circularPadding()Padding settings.
encloseWithStraightLine()Encloses frame path with straight line.
getPixelBounds()Returns pixel bounds.
height()Height setting.
left()Left bound setting.
margin()Margin settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings.
right()Right bound setting.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.
XML/JSON
toJson()Return chart configuration as JSON object or string.
toXml()Return chart configuration as XML string or XMLNode.
Miscellaneous
container()Getter for the element's container.
draw()Drawing of the chart.

Methods Description

animation

Getter for the current animation setting.

Returns:

anychart.core.utils.Animation - Returns true if the animation is enabled.

Try it:

Setter for the animation setting by one value.

Params:

Name Type Default Description
value boolean | Object
false
Whether to enable animation.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for the animation setting.

Params:

Name Type Default Description
enabled boolean
false
Whether to enable animation.
duration number
1000
Duration in milliseconds.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

axis

Getter for default gauge axis settings.

Returns:

anychart.core.axes.Circular - Axis instance.

Try it:

Setter for gauge axis settings.

Params:

Name Type Default Description
value Object | boolean | null
false
Axis settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.
Setter for gauge axis by index.

Params:

Name Type Default Description
index number
0
Index of gauge axis.
value Object | boolean | null
Gauge axis settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

background

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current chart background.

Try it:

Setter for the chart background.

Params:

Name Type Default Description
value Object
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

bar

Getter for 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 first bar pointer.

Params:

Name Type Default Description
value Object | boolean | null
false
Bar pointer settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.
Setter for bar pointer by index.

Params:

Name Type Default Description
index number
0
Index of bar pointer.
value Object | boolean | null
Bar pointer settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

bottom

Getter for element bottom bound setting.

Returns:

number string undefined - Current element's bottom bound setting.
Sets element bottom bound setting.

Params:

Name Type Default Description
value number | string | null
null
Bottom bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets bounds of the element using one parameter.

Params:

Name Type Description
value anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds Bounds of element.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Setter for the element 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.core.VisualBase - Self instance for method chaining.

Try it:

cap

Getter for gauge cap.

Returns:

anychart.core.gauge.Cap - Cap instance.

Try it:

Gauge cap.

Params:

Name Type Default Description
value Object | boolean
false
Gauge cap settings.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

circularPadding

Getter for circular space around gauge.

Returns:

string - Current circular padding.

Try it:

Setter for circular space around gauge.

Params:

Name Type Default Description
value number | string
"10%"
Value to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

Try it:

container

Getter for the element's container.
Setter for the element's container.

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example
// string
 element.container('containerIdentifier');
// DOM-element
 var domElement = document.getElementById('containerIdentifier');
 element.container(domElement);
// Framework-element
 var fwElement = anychart.ui.title();
 element.container( fwElement.container() );

Try it:

data

Getter for pointers mapping.

Returns:

anychart.data.View - Returns current mapping.

Try it:

Setter for pointers mapping

Params:

Name Type Description
value anychart.data.View | anychart.data.Set | Array | string Value to set.
csvSettings Object.<string, (string|boolean)> If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

draw

Starts the rendering of the chart into the container.

Returns:

anychart.core.Chart - Self instance for method chaining.

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

encloseWithStraightLine

Getter for enclose frame path with straight line.

Returns:

boolean - Current value.

Try it:

Setter for enclose frame path with straight line.

Params:

Name Type Default Description
value boolean
false
Boolean flag.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

Try it:

fill

Getter for current fill color.

Returns:

anychart.graphics.vector.Fill - Current fill color.

Try it:

Sets fill settings using an object or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
{keys: ["#fff", "#dcdcdc"], angle: 315}
Color as an object or a string.

Returns:

anychart.gauges.Circular - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

anychart.gauges.Circular - 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.gauges.Circular - 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.gauges.Circular - Self instance for method chaining.

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

Try it:

getPixelBounds

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

getType

Returns gauge type.

Returns:

anychart.enums.GaugeTypes - Current gauge type.

Try it:

height

Getter for element height setting.

Returns:

number string undefined - Current element's height setting.
Sets element height setting.

Params:

Name Type Default Description
value number | string | null
null
Height setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

knob

Getter for 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 first knob pointer.

Params:

Name Type Default Description
value Object | boolean | null
false
Knob pointer settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.
Setter for knob pointer by index.

Params:

Name Type Default Description
index number
0
Index of knob pointer.
value Object | boolean | null
Knob pointer settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

label

Getter for 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 chart label.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for chart label.

Params:

Name Type Default Description
index string | number
Label index.
value null | boolean | Object | string
false
Chart label settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

left

Getter for element left bound setting.

Returns:

number string undefined - Current element's left bound setting.
Sets element left bound setting.

Params:

Name Type Default Description
value number | string | null
null
Left bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

margin

Getter for the current chart margin.

Returns:

anychart.core.utils.Margin - The current chart margin.
Setter for the chart margin in pixels using a single complex object.

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.core.Chart - 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.space(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.core.Chart - 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 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 first marker pointer.

Params:

Name Type Default Description
value Object | boolean | null
false
Marker pointer settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.
Setter for marker pointer by index.

Params:

Name Type Default Description
index number
0
Index of marker pointer.
value Object | boolean | null
Marker pointer settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

maxHeight

Getter for maximum height.

Returns:

number string null - Current element's maximum height.
Setter for maximum height.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

maxWidth

Getter for maximum width.

Returns:

number string null - Current element's maximum width.
Setter for maximum width.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minHeight

Getter for minimum height.

Returns:

number string null - Current element's minimum height.
Setter for minimum height.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minWidth

Getter for minimum width.

Returns:

number string null - Current element's minimum width.
Setter for minimum width.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

needle

Getter for 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 first needle pointer.

Params:

Name Type Default Description
value Object | boolean | null
false
Needle pointer settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.
Setter for needle pointer by index.

Params:

Name Type Default Description
index number
0
Index of needle pointer.
value Object | boolean | null
Needle pointer settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

padding

Getter for the current chart padding.

Returns:

anychart.core.utils.Padding - Current chart padding.
Setter for the chart paddings in pixels using a single value.

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
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.core.Chart - 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:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSize anychart.graphics.vector.PaperSize
Paper size.
landscape boolean
false
Flag of landscape.

Try it:

range

Getter for 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 circular first range settings.

Params:

Name Type Default Description
value Object | boolean | null
false
Circular range settings to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.
Setter for circular range settings by index.

Params:

Name Type Default Description
index number
0
Index of range.
value Object | boolean | null
Circular range settings to set.

Returns:

anychart.gauges.Circular - 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:

Getter for element right bound setting.

Returns:

number string undefined - Current element's right bound setting.
Sets element right bound setting.

Params:

Name Type Default Description
value number | string | null
null
Right bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

startAngle

Getter for gauge start angle.

Returns:

number - Current value of start angle.

Try it:

Setter for gauge start angle.

Params:

Name Type Default Description
value string | number
0
Value to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

Try it:

stroke

Getter for current stroke settings.

Returns:

anychart.graphics.vector.Stroke - Current stroke settings.

Try it:

Setter for stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
value 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 anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

Try it:

sweepAngle

Getter for gauge sweep angle.

Returns:

number - Current value of sweep angle.

Try it:

Setter for gauge sweep angle.

Params:

Name Type Default Description
value string | number
360
Value to set.

Returns:

anychart.gauges.Circular - Self instance for method chaining.

Try it:

title

Getter for chart title.

Returns:

anychart.core.ui.Title - The current chart title.

Try it:

Setter for the chart title.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

anychart.core.Chart - Self instance for method chaining.

toJson

Return chart configuration as JSON object or string.

Params:

Name Type Default Description
stringify boolean
false
Returns JSON as string.
includeTheme boolean
false
If the current theme properties should be included into the result.

Returns:

Object string - Chart configuration.

toXml

Return chart configuration as XML string or XMLNode.

Params:

Name Type Default Description
asXmlNode boolean
false
Return XML as XMLNode.
includeTheme boolean
false
If the current theme properties should be included into the result.

Returns:

string Node - Chart configuration.

tooltip

Getter for current chart tooltip.

Returns:

anychart.core.ui.ChartTooltip anychart.core.ui.Tooltip - An instance of class for method chaining.
Example
var tooltipSettings = chart.tooltip();
Setter for chart tooltip.

Params:

Name Type Description
value Object | boolean | null

Returns:

anychart.core.Chart - Self instance for method chaining.

top

Getter for element top bound setting.

Returns:

number string undefined - Current element's top bound setting.
Sets element top bound setting.

Params:

Name Type Default Description
value number | string | null
null
Top bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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 element width setting.

Returns:

number string undefined - Current element's width setting.
Sets element width setting.

Params:

Name Type Default Description
value number | string | null
null
Width setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: