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.
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
getRemainingBounds()	Returns remaining parent bounds to use elsewhere.
isHorizontal()	Whether an axis is horizontal.
offset()	Offset settings
orientation()	Axis orientation.
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 currentAxis = chart.yAxis();
var flag = currentAxis.drawFirstLabel();

drawFirstLabel(value)

Setter for the first label drawing flag.

Params:

Name	Type	Default	Description
value	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 currentAxis = chart.yAxis();
var flag = currentAxis.drawLastLabel();

drawLastLabel(value)

Setter for the last label drawing flag.

Params:

Name	Type	Default	Description
value	boolean	true	Value to set.

Returns:

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

Try it:

Usage sample

enabled

enabled()

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

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 title.

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(value)

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
value	Object \| boolean \| null	true	Value to set.

Returns:

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

Try it:

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	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	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

minorLabels

minorLabels()

Getter for axis minor labels.

Returns:

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

Try it:

Usage sample

minorLabels(value)

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
value	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(value)

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
value	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(value)Since version 7.11.0

Setter for the axis offset.

Params:

Name	Type	Description
value	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 - Axis orientation.

See listing

var currentAxis = chart.yAxis();
var axisOrientation = currentAxis.orientation();

orientation(value)

Setter for the axis orientation.

Params:

Name	Type	Default	Description
value	string \| anychart.enums.Orientation	"top"	Value 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 - Overlap mode.

Try it:

Usage sample

overlapMode(value)

Setter for labels overlap mode.

Params:

Name	Type	Default	Description
value	anychart.enums.LabelsOverlapMode \| string	"noOverlap"	Value to set.

Returns:

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

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

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:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

scale

scale()

Getter for the axis scale.

Returns:

anychart.scales.Base - Axis scale.

See listing

var currentAxis = chart.yAxis();
var axisScale = currentAxis.scale();

scale(value)

Setter for the axis scale.

Params:

Name	Type	Description
value	anychart.scales.Base	Value 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 currentAxis = chart.yAxis();
var lines = currentAxis.staggerLines();

staggerLines(value)

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

Params:

Name	Type	Default	Description
value	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 currentAxis = chart.yAxis();
var maxLines = currentAxis.staggerMaxLines();

staggerMaxLines(value)

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

Params:

Name	Type	Default	Description
value	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 currentAxis = chart.yAxis();
var flag = currentAxis.staggerMode();

staggerMode(value)

Setter for the stagger mode state.

Params:

Name	Type	Default	Description
value	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 currentAxis = chart.yAxis();
var axisStroke = currentAxis.stroke();

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

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

Params:

Name	Type	Default	Description
value	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	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

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(value)

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
value	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(value)

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
value	null \| boolean \| Object \| string	false	Value to set.

Returns:

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

Try it:

unlisten

unlisten(type, listener, useCapture, listenerScope)

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

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

unlistenByKey

unlistenByKey(key)

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:

Usage sample

width

width()

Getter for the axis width.

Returns:

number | string | null - Axis width.

See listing

var currentYAxis = chart.yAxis();
var axisWidth = currentYAxis.width();

width(value)

Setter for the axis width.

Params:

Name	Type	Default	Description
value	number \| string	null	Value to set.

Returns:

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

Try it:

Usage sample

zIndex

zIndex()

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Usage sample

zIndex(value)

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
value	number	0	Value to set.

Returns:

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

Try it:

Usage sample