Top
You are looking at an outdated 7.12.0 version of this document. Switch to the 8.0.1 version to see the up to date information.

class anychart.core.axes.MapSettings Improve this Doc

Extends: anychart.core.VisualBase

Map axes settings class.

Methods Overview

Specific settings
enabled()Disable or enable axes.
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.
Export
print()Prints all elements.
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.

Try it:

Setter for the bottom axis.

Params:

Name Type Description
value boolean | Object Settings 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:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

drawLastLabel

Getter for the last label drawing flag.

Returns:

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

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

enabled

Getter for the axes enabled state.

Returns:

boolean - Axes enabled state.
Setter for the axes enabled state.

Params:

Name Type Default Description
value boolean
false
Value to set.

Returns:

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

Try it:

labels

Getter for axes labels.

Returns:

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

Try it:

Setter for axes labels.

Params:

Name Type Default Description
value Object | 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.

Try it:

Setter for the left axis.

Params:

Name Type Description
value boolean | Object Settings for axis.

Returns:

anychart.core.axes.MapSettings - 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 axes minor labels.

Returns:

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

Try it:

Setter for axes minor labels.

Params:

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

Returns:

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

minorTicks

Getter for minor axes ticks.

Returns:

anychart.core.axes.MapTicks - Axes ticks.

Try it:

Setter for minor axes ticks.

Params:

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

Returns:

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

overlapMode

Getter for overlap mode for labels.

Returns:

anychart.enums.LabelsOverlapMode - Overlap mode flag.
Setter for overlap mode for labels.

Params:

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

Returns:

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

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSize anychart.graphics.vector.PaperSize
Paper size.
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:

Getter for the right axis.

Returns:

anychart.core.axes.Map - Right axis instance.

Try it:

Setter for the right axis.

Params:

Name Type Description
value boolean | Object Settings for axis.

Returns:

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

stroke

Getter for axes stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axes line stroke settings.
Setter for axes stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
"#eaeaea"
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
'round'
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
'square'
Line cap style.

Returns:

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

Try it:

ticks

Getter for axes ticks.

Returns:

anychart.core.axes.MapTicks - Axes ticks.

Try it:

Setter for axes ticks.

Params:

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

Returns:

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

title

Getter for axes title.

Returns:

anychart.core.ui.Title - Axes title.

Try it:

Setter for axes title.

Params:

Name Type Default Description
value null | 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.

Try it:

Setter for the top axis.

Params:

Name Type Description
value boolean | Object Settings for axis.

Returns:

anychart.core.axes.MapSettings - 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:

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: