AnyChart
API Reference
Still have questions?
Contact support
Top

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

Getter for the first label drawing flag.

Returns:

boolean - Drawing flag.
See listing
var yAxis = chart.yAxis();
var flag = yAxis.drawFirstLabel();
Setter for the first label drawing flag.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

drawLastLabel

Getter for the last label drawing flag.

Returns:

boolean - Drawing flag.
See listing
var yAxis = chart.yAxis();
var flag = yAxis.drawLastLabel();
Setter for the last label drawing flag.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

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.LinearGauge - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

getPixelBounds

Returns pixel bounds of the axis.

Returns:

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

getRemainingBounds

Returns remaining parent bounds to use elsewhere.

Returns:

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

isHorizontal

Whether an axis is horizontal.

Returns:

boolean - Returns true if the axis is horizontal.

labels

Getter for axis labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.
Setter for axis labels.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Labels settings to set.

Returns:

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

minorLabels

Getter for axis minor labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.
Setter for axis minor labels.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Value to set.

Returns:

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

minorTicks

Getter for minor axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.
Setter for minor axis ticks.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Value to set.

Returns:

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

offset

Getter for the axis offset.

Returns:

string - The axis offset.
Setter for the axis offset.

Params:

NameTypeDescription
offsetstringPercent offset.

Returns:

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

orientation

Getter for the axis orientation.

Returns:

anychart.enums.Orientation | string - Axis orientation.
See listing
var axis = gauge.axis();
var orientation = axis.orientation();
Setter for the axis orientation.

Params:

NameTypeDefaultDescription
orientationanychart.enums.Orientation | string
'left'
Axis orientation to set.

Returns:

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

overlapMode

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode | string - Overlap mode.
Setter for labels overlap mode.

Params:

NameTypeDefaultDescription
modeanychart.enums.LabelsOverlapMode | string
'noOverlap'
Value to set.

Returns:

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

padding

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

Params:

NameTypeDefaultDescription
paddingArray.<(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);
Setter for the axis paddings in pixels using several numbers.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
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);

scale

Getter for the axis scale.

Returns:

anychart.scales.Base - Axis scale.
See listing
var axis = gauge.axis();
var scale = axis.scale();
Setter for the axis scale.
Note: the scale() method should be used after drawing a chart.

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Scale settings to set.

Returns:

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

staggerLines

Getter for stagger lines.

Returns:

number - Stagger line settings.
See listing
var yAxis = chart.yAxis();
var lines = yAxis.staggerLines();
Setter for stagger lines.
Note: pass null to enable autocalculation.

Params:

NameTypeDefaultDescription
countnumber
null
Count of stagger lines.

Returns:

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

staggerMaxLines

Getter for maximum stagger lines.

Returns:

number - Stagger line settings.
See listing
var yAxis = chart.yAxis();
var maxLines = yAxis.staggerMaxLines();
Setter for maximum stagger lines in autocalculation mode (if anychart.core.axes.Linear#staggerLines passed null).

Params:

NameTypeDefaultDescription
countnumber | 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.

staggerMode

Getter for the stagger mode state.

Returns:

boolean - Stagger mode state.
See listing
var yAxis = chart.yAxis();
var flag = yAxis.staggerMode();
Setter for the stagger mode state.

Params:

NameTypeDefaultDescription
enabledboolean
true
On/off stagger mode.

Returns:

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

stroke

Getter for axis stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axis stroke settings.
See listing
var axis = gauge.axis();
var stroke = axis.stroke();
Setter for axis stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
'#CECECE'
Stroke settings.
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.LinearGauge - Self instance for method chaining.
Setter for axis stroke settings using an object.

Params:

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

Returns:

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

ticks

Getter for axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.
Setter for axis ticks.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Value to set.

Returns:

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

title

Getter for the axis title.

Returns:

anychart.core.ui.Title - Axis title.
Setter for the axis title.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Value to set.

Returns:

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

width

Getter for the axis width.

Returns:

number | string | null - Axis width.
See listing
var axis = gauge.axis();
var width = axis.width();
Setter for the axis width.

Params:

NameTypeDefaultDescription
widthnumber | string
null
Axis width to set.

Returns:

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

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.LinearGauge - Self instance for method chaining.