AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.axes.Ticks Improve this Doc

Extends: anychart.core.VisualBase

Axis ticks class.
You can change position, length and line features.

Methods Overview

Coloring
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()Ticks length.
position()Ticks 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.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

length

Getter for ticks length.

Returns:

number - Length of ticks.
See listing
var axisTicks = currentYAxis.ticks();
var ticksLength = axisTicks.length();
Setter for ticks length.

Params:

NameTypeDefaultDescription
valuenumber
6
Value to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback 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 }.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

position

Getter for ticks position.

Returns:

anychart.enums.SidePosition | string - Ticks position.
See listing
var axisTicks = currentYAxis.ticks();
var axisPosition = axisTicks.position();
Setter for ticks position.
You can set ticks inside of a chart area or outside its position.

Params:

NameTypeDefaultDescription
valueanychart.enums.SidePosition | string
"outside"
Value to set.

Returns:

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

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

stroke

Getter for stroke settings.

Returns:

anychart.graphics.vector.Stroke - Returns stroke settings.
See listing
var axisTicks = currentYAxis.ticks();
var ticksPosition = axisTicks.position();
Setter for stroke settings via single parameter.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke
"#cecece"
Fill style as '[thickness ]color[ opacity]'.

Returns:

anychart.core.axes.Ticks - Self instance for method chaining.
Setter for stroke settings via several parameter.
The following options are acceptable: Note: String parts order is significant and '3px red' is not the same as 'red 3px'.

Params:

NameTypeDefaultDescription
colorstring
Stroke color.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

unlisten

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

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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