Top

class anychart.standalones.axes.Linear Improve this Doc

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.
orientation()Axis orientation.
padding()Padding settings.
parentBounds()Parent bounds for axis.
width()Axis width.
zIndex()Z-index of the element.
Miscellaneous
container()Container for linear axis.
draw()Drawing of the linear axis.

Methods Description

container

Getter for the axis current container.
Setter for the axis container.

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.standalones.axes.Linear - Self instance for method chaining.

Try it:

draw

Drawing of the linear axis.

Returns:

anychart.standalones.axes.Linear - Self instance for method chaining.

Try it:

drawFirstLabel

Getter for the first label drawing flag.

Returns:

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

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

drawLastLabel

Getter for the last label drawing flag.

Returns:

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

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

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:

getRemainingBounds

Returns remaining parent bounds to use elsewhere.

Returns:

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

Try it:

isHorizontal

Whether an axis is horizontal.

Returns:

boolean - Returns true if the axis is horizontal.

Try it:

labels

Getter for axis labels.

Returns:

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

Try it:

Setter for axis labels.

Params:

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

Returns:

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

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:

minorLabels

Getter for axis minor labels.

Returns:

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

Try it:

Setter for axis minor labels.

Params:

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

Returns:

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

minorTicks

Getter for minor axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.

Try it:

Setter for minor axis ticks.

Params:

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

Returns:

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

orientation

Getter for the axis orientation.

Returns:

anychart.enums.Orientation - Axis orientation.
See listing
var currentAxis = chart.yAxis();
var axisOrientation = currentAxis.orientation();
Setter for the axis orientation.

Params:

Name Type Default Description
value string | anychart.enums.Orientation
"top"
Value to set.

Returns:

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

Try it:

overlapMode

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode - Overlap mode.

Try it:

Setter for labels overlap mode.

Params:

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

Returns:

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

Try it:

padding

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

Params:

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

Returns:

anychart.standalones.axes.Linear - 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:

Setter for the axis paddings in pixels using several numbers.

Params:

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

Returns:

anychart.standalones.axes.Linear - 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:

parentBounds

Getter for bounds.

Returns:

anychart.math.Rect - Current stage bounds.
Setter for bounds using single value.

Params:

Name Type Description
value anychart.math.Rect | Object | null Value to set.

Returns:

anychart.standalones.axes.Linear - Self instance for method chaining.

Try it:

Setter for bounds using several values.

Params:

Name Type Description
left number Left space.
top number Top space.
width number Width axis.
height number Height axis.

Returns:

anychart.standalones.axes.Linear - 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:

scale

Getter for the axis scale.

Returns:

anychart.scales.Base - Axis scale.
See listing
var currentAxis = chart.yAxis();
var axisScale = currentAxis.scale();
Setter for the axis scale.

Params:

Name Type Description
value anychart.scales.Base Value to set.

Returns:

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

Try it:

staggerLines

Getter for stagger lines.

Returns:

number - Stagger line settings.
See listing
var currentAxis = chart.yAxis();
var lines = currentAxis.staggerLines();
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.Linear - Self instance for method chaining.

Try it:

staggerMaxLines

Getter for maximum stagger lines.

Returns:

number - Stagger line settings.
See listing
var currentAxis = chart.yAxis();
var maxLines = currentAxis.staggerMaxLines();
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.Linear - Self instance for method chaining.

Try it:

staggerMode

Getter for the stagger mode state.

Returns:

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

Params:

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

Returns:

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

Try it:

stroke

Getter for axis stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axis stroke settings.
See listing
var currentAxis = chart.yAxis();
var axisStroke = currentAxis.stroke();
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.Linear - Self instance for method chaining.

Try it:

ticks

Getter for axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.

Try it:

Setter for axis ticks.

Params:

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

Returns:

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

title

Getter for the axis title.

Returns:

anychart.core.ui.Title - Axis title.

Try it:

Setter for the axis title.

Params:

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

Returns:

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

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:

width

Getter for the axis width.

Returns:

number string null - Axis width.
See listing
var currentYAxis = chart.yAxis();
var axisWidth = currentYAxis.width();
Setter for the axis width.

Params:

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

Returns:

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

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: