class anychart.core.axes.LinearGauge Improve this Doc

Extends: anychart.core.axes.Linear

Linear Gauge axis class.
Any axis must be bound to a scale.
To obtain a new instance of Axis use anychart.standalones.axes#linear.

Methods Overview

Specific settings
drawFirstLabel()	Drawing of the first label.
drawLastLabel()	Drawing of the last label.
labels()	Labels settings.
minorLabels()	Minor labels settings.
minorTicks()	Minor ticks settings.
overlapMode()	Overlap mode for labels.
scale()	Scale settings.
staggerLines()	Stagger lines.
staggerMaxLines()	Maximum stagger lines.
staggerMode()	Stagger mode state.
ticks()	Ticks settings.
title()	Title settings.
Coloring
stroke()	Stroke settings.
Interactivity
enabled()	Element state (enabled or disabled).
Size and Position
getPixelBounds()	Returns pixel bounds of the axis.
getRemainingBounds()	Returns remaining parent bounds to use elsewhere.
isHorizontal()	Whether an axis is horizontal.
offset()	Offset settings
orientation()	Axis orientation.
padding()	Padding settings for the linear axis.
width()	Axis width.
zIndex()	Z-index of the element.

Methods Description

drawFirstLabel

drawFirstLabel()

Getter for the first label drawing flag.

Returns:

boolean - Drawing flag.

See listing

var yAxis = chart.yAxis();
var flag = yAxis.drawFirstLabel();

drawFirstLabel(enabled)

Setter for the first label drawing flag.

Params:

Name	Type	Default	Description
enabled	boolean	true	Value to set.

Returns:

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

Try it:

Usage sample

drawLastLabel

drawLastLabel()

Getter for the last label drawing flag.

Returns:

boolean - Drawing flag.

See listing

var yAxis = chart.yAxis();
var flag = yAxis.drawLastLabel();

drawLastLabel(enabled)

Setter for the last label drawing flag.

Params:

Name	Type	Default	Description
enabled	boolean	true	Value to set.

Returns:

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

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

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

Try it:

Usage sample

getPixelBounds

getPixelBounds()Since version 7.14.0

Returns pixel bounds of the axis.

Returns:

anychart.math.Rect - Pixel bounds of the axis.

Try it:

Usage sample

getRemainingBounds

getRemainingBounds()

Returns remaining parent bounds to use elsewhere.

Returns:

anychart.math.Rect - Parent bounds without the space used by the axis.

Try it:

Usage sample

isHorizontal

isHorizontal()

Whether an axis is horizontal.

Returns:

boolean - Returns true if the axis is horizontal.

Try it:

Usage sample

labels

labels()

Getter for axis labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.

Try it:

Usage sample

labels(settings)

Setter for axis labels.

Detailed description

Sets axis labels settings depending on parameter type:

null/boolean - disable or enable axis labels.
object - sets axis labels settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	true	Labels settings to set.

Returns:

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

Try it:

minorLabels

minorLabels()

Getter for axis minor labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.

Try it:

Usage sample

minorLabels(settings)

Setter for axis minor labels.

Detailed description

Sets axis minor labels settings depending on parameter type:

null/boolean - disable or enable axis minor labels.
object - sets axis minor labels settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	false	Value to set.

Returns:

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

Try it:

minorTicks

minorTicks()

Getter for minor axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.

Try it:

Usage sample

minorTicks(settings)

Setter for minor axis ticks.

Detailed description

Sets axis minor ticks settings depending on parameter type:

null/boolean - disable or enable axis minor ticks.
object - sets axis minor ticks settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	false	Value to set.

Returns:

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

Try it:

offset

offset()Since version 7.11.0

Getter for the axis offset.

Returns:

string - The axis offset.

Try it:

Usage sample

offset(offset)Since version 7.11.0

Setter for the axis offset.

Params:

Name	Type	Description
offset	string	Percent offset.

Returns:

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

Try it:

Usage sample

orientation

orientation()

Getter for the axis orientation.

Returns:

anychart.enums.Orientation | string - Axis orientation.

See listing

var axis = gauge.axis();
var orientation = axis.orientation();

orientation(orientation)

Setter for the axis orientation.

Params:

Name	Type	Default	Description
orientation	anychart.enums.Orientation \| string	'left'	Axis orientation to set.

Returns:

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

Try it:

Usage sample

overlapMode

overlapMode()

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode | string - Overlap mode.

Try it:

Usage sample

overlapMode(mode)

Setter for labels overlap mode.

Params:

Name	Type	Default	Description
mode	anychart.enums.LabelsOverlapMode \| string	'noOverlap'	Value to set.

Returns:

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

Try it:

Usage sample

padding

padding()

Getter for the axis padding.

Detailed description

Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.

Returns:

anychart.core.utils.Padding - Axes padding.

Try it:

Usage sample

padding(padding)

Setter for the axis paddings in pixels using a single value.

Params:

Name	Type	Default	Description
padding	Array.<(number\|string)> \| Object	{top: 0, right: 0, bottom: 0, left: 0}	Padding to set.

Returns:

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

Examples for padding

// all paddings 15px
axis.padding(15);
// all paddings 15px
axis.padding('15px');
// top and bottom 5px, right and left 15px
axis.padding(5, 15);

Try it:

Usage sample

padding(value1, value2, value3, value4)

Setter for the axis paddings in pixels using several numbers.

Params:

Name	Type	Description
value1	string \| number	Top or top-bottom space.
value2	string \| number	Right or right-left space.
value3	string \| number	Bottom space.
value4	string \| number	Left space.

Returns:

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

Examples for padding

// 1) top and bottom 10px, left and right 15px
axis.padding(10, '15px');
// 2) top 10px, left and right 15px, bottom 5px
axis.padding(10, '15px', 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
axis.padding(10, '15px', '5px', 12);

Try it:

Usage sample

scale

scale()

Getter for the axis scale.

Returns:

anychart.scales.Base - Axis scale.

See listing

var axis = gauge.axis();
var scale = axis.scale();

scale(settings)

Setter for the axis scale.
Note: the scale() method should be used after drawing a chart.

Params:

Name	Type	Default	Description
settings	anychart.scales.Base \| Object \| anychart.enums.ScaleTypes \| string	anychart.scales.Linear	Scale settings to set.

Returns:

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

Try it:

Usage sample

staggerLines

staggerLines()

Getter for stagger lines.

Returns:

number - Stagger line settings.

See listing

var yAxis = chart.yAxis();
var lines = yAxis.staggerLines();

staggerLines(count)

Setter for stagger lines.
Note: pass null to enable autocalculation.

Params:

Name	Type	Default	Description
count	number	null	Count of stagger lines.

Returns:

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

Try it:

Usage sample

staggerMaxLines

staggerMaxLines()

Getter for maximum stagger lines.

Returns:

number - Stagger line settings.

See listing

var yAxis = chart.yAxis();
var maxLines = yAxis.staggerMaxLines();

staggerMaxLines(count)

Setter for maximum stagger lines in autocalculation mode (if anychart.core.axes.Linear#staggerLines passed null).

Params:

Name	Type	Default	Description
count	number \| null	2	Limits the number of lines to be used when drawing labels. If we need less - we use less, but never - more.

Returns:

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

Try it:

Usage sample

staggerMode

staggerMode()

Getter for the stagger mode state.

Returns:

boolean - Stagger mode state.

See listing

var yAxis = chart.yAxis();
var flag = yAxis.staggerMode();

staggerMode(enabled)

Setter for the stagger mode state.

Params:

Name	Type	Default	Description
enabled	boolean	true	On/off stagger mode.

Returns:

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

Try it:

Usage sample

stroke

stroke()

Getter for axis stroke settings.

Returns:

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

See listing

var axis = gauge.axis();
var stroke = axis.stroke();

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

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

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| function \| null	'#CECECE'	Stroke settings.
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.

Returns:

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

Try it:

Usage sample

stroke(settings)

Setter for axis stroke settings using an object.

Params:

Name	Type	Description
settings	Object	Object with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

Try it:

Usage sample

ticks

ticks()

Getter for axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.

Try it:

Usage sample

ticks(settings)

Setter for axis ticks.

Detailed description

Sets axis ticks settings depending on parameter type:

null/boolean - disable or enable axis ticks.
object - sets axis ticks settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	true	Value to set.

Returns:

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

Try it:

title

title()

Getter for the axis title.

Returns:

anychart.core.ui.Title - Axis title.

Try it:

Usage sample

title(settings)

Setter for the axis title.

Detailed description

Sets axis title settings depending on parameter type:

null/boolean - disable or enable axis title.
string - sets axis title text value.
object - sets axis title settings.

Params:

Name	Type	Default	Description
settings	null \| boolean \| Object \| string	false	Value to set.

Returns:

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

Try it:

width

width()

Getter for the axis width.

Returns:

number | string | null - Axis width.

See listing

var axis = gauge.axis();
var width = axis.width();

width(width)

Setter for the axis width.

Params:

Name	Type	Default	Description
width	number \| string	null	Axis width to set.

Returns:

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

Try it:

Usage sample

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(zIndex)

Setter for the Z-index of the element.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
zIndex	number	0	Value to set.

Returns:

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

Try it:

Usage sample