AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.axes.CircularTicks Improve this Doc

Extends: anychart.core.VisualBase

Axis ticks class.

Methods Overview

Specific settings
type()Ticks type.
Coloring
fill()Fill settings.
hatchFill()Hatch fill settings.
stroke()Stroke settings.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
length()Ticks length.
position()Ticks position.
zIndex()Z-index of the element.

Methods Description

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

fill

Getter for ticks fill color.

Returns:

anychart.graphics.vector.Fill | function - Ticks fill color.
Setter for ticks fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
'#545f69'
Color as an object, an array or a string.

Returns:

anychart.core.axes.CircularTicks - Self instance for method chaining.
Ticks fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.axes.CircularTicks - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity (0 to 1).

Returns:

anychart.core.axes.CircularTicks - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

hatchFill

Getter for ticks hatch fill settings.
See listing
var ticksSettings = axis.ticks();
var hatchFill = ticksSettings.hatchFill();
Setter for ticks hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | string
null
Type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.axes.CircularTicks - Self instance for method chaining.
Setter for hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.core.axes.CircularTicks - Self instance for method chaining.
Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.core.axes.CircularTicks - Self instance for method chaining.
Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.core.axes.CircularTicks - Self instance for method chaining.
Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

length

Getter for ticks length.

Returns:

string - Ticks length.
Setter for ticks length.

Params:

NameTypeDefaultDescription
lengthnull | number | string
undefined
Value to set.

Returns:

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

position

Getter for ticks position.

Returns:

anychart.enums.SidePosition | string - Ticks position.
Setter for ticks position.

Params:

NameTypeDefaultDescription
valueanychart.enums.SidePosition | string
'center'
Position to set.

Returns:

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

stroke

Getter for ticks stroke.

Returns:

anychart.graphics.vector.Stroke | function - Ticks stroke settings.
Setter for ticks stroke by function.

Params:

NameTypeDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFillFunction to set

Returns:

anychart.core.axes.CircularTicks - Self instance for method chaining.
Setter for ticks stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'none'
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.axes.CircularTicks - Self instance for method chaining.
Setter for ticks stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

type

Getter for ticks type.

Returns:

anychart.enums.MarkerType | string | function - Ticks type.
Setter for ticks type.

Params:

NameTypeDefaultDescription
typeanychart.enums.MarkerType | string | function(path:anychart.graphics.vector.Path, x:number, y:number, radius:number)
'line'
Value to set.

Returns:

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

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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