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

class anychart.core.axes.CircularTicks Improve this Doc

Extends: anychart.core.VisualBase

Axis ticks class.

Methods Overview

Specific settings
type()Tick type.
Coloring
fill()Fill settings.
hatchFill()Hatch fill settings.
stroke()Stroke 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
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
length()Tick length.
position()Tick position.
zIndex()Z-index of the element.

Methods Description

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:

fill

Getter for ticks fill color.

Returns:

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

Try it:

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

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
'red'
Color as an object 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:

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

Returns:

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

Try it:

Params:

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

Returns:

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

Try it:

hatchFill

Getter for ticks hatch fill settings.
Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

Name Type Default Description
patternFillOrType anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
null
PatternFill or HatchFill instance or type of hatch fill.
color string
Color.
thickness number
Thickness.
size number
Pattern size.

Returns:

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

Try it:

length

Getter for tick length.

Returns:

string - Current tick length.

Try it:

Setter for tick length.

Params:

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

Returns:

anychart.core.axes.CircularTicks - Self instance 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. 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 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:

position

Getter for tick position.

Returns:

anychart.enums.SidePosition string - Current tick position.

Try it:

Setter for tick position.

Params:

Name Type Default Description
value anychart.enums.SidePosition | string
"center"
Position to set.

Returns:

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

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:

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:

stroke

Getter for tick stroke.

Returns:

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

Try it:

Setter for tick stroke by function.

Params:

Name Type Description
strokeFunction function Function to set

Returns:

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

Try it:

Setter for tick stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
'none'
Fill settings or stroke settings.
thickness number
1
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.core.axes.CircularTicks - Self instance for method chaining.

Try it:

type

Getter for tick type.

Returns:

string anychart.enums.MarkerType function - Current tick type.

Try it:

Setter for tick type.

Params:

Name Type Default Description
value string | anychart.enums.MarkerType | function
"line"
Value to set.

Returns:

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

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:

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: