AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.axes.MapSettings Improve this Doc

Extends: anychart.core.VisualBase

Map axes settings class.

Methods Overview

Specific settings
enabled()Disable or enable axis.
minorTicks()Minor ticks settings.
overlapMode()Overlap mode for labels.
ticks()Ticks settings.
title()Title settings.
Axes and Scales
bottom()Bottom axis settings.
left()Left axis settings.
right()Right axis settings.
top()Top axis 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
Labels
drawFirstLabel()Drawing of the first label.
drawLastLabel()Drawing of the last label.
labels()Labels settings.
minorLabels()Minor labels settings.
Size and Position
zIndex()Z-index of the element.

Methods Description

bottom

Getter for the bottom axis.

Returns:

anychart.core.axes.Map - Bottom axis instance.
Setter for the bottom axis.

Params:

NameTypeDescription
settingsboolean | ObjectSettings for axis.

Returns:

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

drawFirstLabel

Getter for the first label drawing flag.

Returns:

boolean - Drawing flag.
Setter for the first label drawing flag.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

drawLastLabel

Getter for the last label drawing flag.

Returns:

boolean - Drawing flag.
Setter for the last label drawing flag.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

enabled

Getter for the axis enabled state.

Returns:

boolean - Axis enabled state.
Setter for the axis enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
false
Value to set.

Returns:

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

labels

Getter for axis labels.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Value to set.

Returns:

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

left

Getter for the left axis.

Returns:

anychart.core.axes.Map - Left axis instance.
Setter for the left axis.

Params:

NameTypeDescription
settingsboolean | ObjectSettings for axis.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

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

minorTicks

Getter for minor axis ticks.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Value to set.

Returns:

anychart.core.axes.MapSettings - 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.MapSettings - Self instance for method chaining.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.
Getter for the right axis.

Returns:

anychart.core.axes.Map - Right axis instance.
Setter for the right axis.

Params:

NameTypeDescription
settingsboolean | ObjectSettings for axis.

Returns:

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

stroke

Getter for axis stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axis stroke settings.
Setter for axis stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
valueanychart.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
'round'
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
'square'
Line cap style.

Returns:

anychart.core.axes.MapSettings - 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.MapSettings - Self instance for method chaining.

ticks

Getter for axis ticks.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Value to set.

Returns:

anychart.core.axes.MapSettings - 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.MapSettings - Self instance for method chaining.

top

Getter for the top axis.

Returns:

anychart.core.axes.Map - Top axis instance.
Setter for the top axis.

Params:

NameTypeDescription
settingsboolean | ObjectSettings for axis.

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

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