AnyChart
API Reference
Still have questions?
Contact support
Top

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 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.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 = yAxis.ticks();
var ticksLength = axisTicks.length();
Setter for ticks length.

Params:

NameTypeDefaultDescription
lengthnumber
6
Value to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object 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 = yAxis.ticks();
var axisPosition = axisTicks.position();
Setter for ticks position.
You can set ticks inside of a chart area or outside its position.

Params:

NameTypeDefaultDescription
positionanychart.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 = yAxis.ticks();
var ticksPosition = axisTicks.position();
Setter for stroke settings via single parameter.

Params:

NameTypeDefaultDescription
coloranychart.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.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Params:

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

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object 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 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.Ticks - Self instance for method chaining.