Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 7.14.3 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.

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:

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:

Name Type Default Description
value number
6
Value to set.

Returns:

anychart.core.axes.Ticks - 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 Object 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 Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

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:

Name Type Default Description
value anychart.enums.SidePosition | string
"outside"
Value to set.

Returns:

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

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSizeOrOptions anychart.graphics.vector.PaperSize | Object
Paper size or object with options.
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 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:

Name Type Default Description
value anychart.graphics.vector.Stroke
"#cecece"
Fill style as '[thickness ]color[ opacity]'.

Returns:

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

Try it:

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:

Name Type Default Description
color string
Stroke color.
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.Ticks - Self instance for method chaining.

Try it:

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 Object 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: