class anychart.core.axes.SurfaceTicks Improve this Doc

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

Methods Overview

Coloring
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

enabled()

Getter for the ticks state (enabled or disabled).

Returns:

boolean - Element state.

enabled(enabled)

Setter for the ticks enabled state.

Params:

Name	Type	Description
enabled	boolean	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

length

length()

Getter for ticks length.

Returns:

number - Length of ticks.

See listing

var axisTicks = yAxis.ticks();
var ticksLength = axisTicks.length();

length(length)

Setter for ticks length.

Params:

Name	Type	Default	Description
length	number	6	Value to set.

Returns:

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

Try it:

Usage sample

position

position()

Getter for ticks position.

Returns:

anychart.enums.SidePosition | string - Ticks position.

See listing

var axisTicks = yAxis.ticks();
var axisPosition = axisTicks.position();

position(position)

Setter for ticks position.
You can set ticks inside of a chart area or outside its position.

Params:

Name	Type	Default	Description
position	anychart.enums.SidePosition \| string	'outside'	Value to set.

Returns:

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

Try it:

Usage sample

stroke

stroke()

Getter for stroke settings.

Returns:

anychart.graphics.vector.Stroke - Returns stroke settings.

See listing

var axisTicks = yAxis.ticks();
var ticksPosition = axisTicks.position();

stroke(color)

Setter for stroke settings via single parameter.

Params:

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

Returns:

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

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)

Setter for stroke settings via several parameter.
The following options are acceptable:

String formatted as '[thickness ]color[ opacity]':
1. 'color' - https://www.w3schools.com/html/html_colors.asp.
2. 'thickness color' - like a CSS border, e.g. '3 red' or '3px red'
3. 'color opacity' - as a fill string, e.g. '#fff 0.5'
4. 'thickness color opacity' - as a complex string, e.g. '3px #00ff00 0.5'
anychart.graphics.vector.Stroke object
Keys array anychart.graphics.vector.GradientKey
null - reset current stroke settings.

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	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.