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

class anychart.core.axes.Circular Improve this Doc

Extends: anychart.core.VisualBase

Circular axis class.

Methods Overview

Miscellaneous
drawFirstLabel()Getter for the first label drawing flag.
drawLastLabel()Getter for the last label drawing flag.
fill()Getter for current axis fill color.
labels()Getter for labels.
minorLabels()Getter for minor label.
minorTicks()Getter for minor axis ticks.
overlapMode()Getter for overlap mode for labels.
radius()Getter for axis radius.
scale()Getter for axis scale.
startAngle()Getter for start angle.
sweepAngle()Getter for sweep angle.
ticks()Getter for axis ticks.
width()Getter for axis width.

Methods Description

drawFirstLabel

Getter for the first label drawing flag.

Returns:

boolean - Drawing flag.

Try it:

Setter for the first label drawing flag.

Params:

Name Type Default Description
value boolean
true
Drawing flag.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

drawLastLabel

Getter for the last label drawing flag.

Returns:

boolean - Drawing flag.

Try it:

Setter for the last label drawing flag.

Params:

Name Type Default Description
value boolean
true
Drawing flag.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

fill

Getter for current axis fill color.

Returns:

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

Try it:

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

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
{color: "black", opacity: 0.3}
Color as an object or a string.

Returns:

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

Try it:

Linear gradient axis 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.core.axes.Circular - Self instance for method chaining.

Try it:

Radial axis 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.core.axes.Circular - Self instance for method chaining.

Try it:

Image cap fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

labels

Getter for labels.

Returns:

anychart.core.ui.CircularLabelsFactory - Axis labels.

Try it:

Setter for labels.

Params:

Name Type Default Description
value Object | boolean | null
false
Axis labels.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

minorLabels

Getter for minor label.

Returns:

anychart.core.ui.CircularLabelsFactory - Axis labels.

Try it:

Setter for minor label.

Params:

Name Type Default Description
value Object | boolean | null
false
Axis labels.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

minorTicks

Getter for minor axis ticks.

Returns:

anychart.core.axes.CircularTicks - Axis ticks.

Try it:

Setter for minor axis ticks.

Params:

Name Type Default Description
value Object | boolean | null
false
Axis ticks.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

overlapMode

Getter for overlap mode for labels.

Returns:

anychart.enums.LabelsOverlapMode string - Overlap mode flag.

Try it:

Setter for overlap mode for labels.

Params:

Name Type Default Description
value anychart.enums.LabelsOverlapMode | string | boolean
'noOverlap'
Value to set.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

radius

Getter for axis radius.

Returns:

string - Value to set.

Try it:

Setter for axis radius.

Params:

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

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

scale

Getter for axis scale.

Returns:

anychart.scales.Linear anychart.scales.Logarithmic - Current axis scale.

Try it:

Params:

Name Type Description
value anychart.enums.GaugeScaleTypes | anychart.scales.Linear | anychart.scales.Logarithmic | string Scale to set.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

startAngle

Getter for start angle.

Returns:

number - Current start angle.

Try it:

Setter for start angle.

Params:

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

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

sweepAngle

Getter for sweep angle.

Returns:

number - Current sweep angle.

Try it:

Setter for sweep angle.

Params:

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

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

ticks

Getter for axis ticks.

Returns:

anychart.core.axes.CircularTicks - Axis ticks.

Try it:

Setter for axis ticks.

Params:

Name Type Default Description
value Object | boolean | null
true
Axis ticks.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

width

Getter for axis width.

Returns:

string - Current axis width.

Try it:

Setter for axis width.

Params:

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

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it: