AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.14.0 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.grids.MapSettings Improve this Doc

Extends: anychart.core.Base

Map grid settings.

Methods Overview

Specific settings
drawFirstLine()Drawing first line.
drawLastLine()Drawing last line.
enabled()Disable or enable grids.
Axes and Scales
horizontal()Horizontal grid settings.
vertical()Vertical grid settings.
Coloring
evenFill()Even fill settings.
minorStroke()Stroke settings.
oddFill()Odd fill settings.
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.
Size and Position
zIndex()Z-index setting.

Methods Description

drawFirstLine

Getter for the first line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var grids = map.grids();
var flag = grids.drawFirstLine();
Setter for the first line drawing.

Params:

NameTypeDefaultDescription
valueboolean
true
Whether grid should draw first line.

Returns:

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

drawLastLine

Getter for the last line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var grids = map.grids();
var flag = grids.drawLastLine();
Setter for the last line drawing.

Params:

NameTypeDescription
valuebooleanWhether grid should draw last line.

Returns:

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

enabled

Getter for the grid enabled state.

Returns:

boolean - Grid enabled state.
Setter for the grid enabled state.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

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

evenFill

Getter for grid even fill settings.

Returns:

string | anychart.graphics.vector.Fill - Grid even fill settings.
See listing
var grids = map.grids();
var evenFill = mapGrids.evenFill();
Setter for even fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an array or a string.

Returns:

anychart.core.grids.MapSettings - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.grids.MapSettings - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.grids.MapSettings - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

horizontal

Getter for the horizontal grid.

Returns:

anychart.core.grids.Map - Grid instance.
Setter for the horizontal grid.

Params:

NameTypeDescription
valueboolean | ObjectValue to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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
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.

minorStroke

Getter for the minor grid stroke line.

Returns:

string | anychart.graphics.vector.Stroke - Grid stroke line settings.
See listing
var minorStroke = grids.minorStroke();
Setter for grid stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

oddFill

Getter for grid odd fill settings.

Returns:

string | anychart.graphics.vector.Fill - Grid odd fill settings.
See listing
var grids = map.grids();
var oddFill = mapGrids.oddFill();
Setter for odd fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an array or a string.

Returns:

anychart.core.grids.MapSettings - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.grids.MapSettings - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.grids.MapSettings - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.grids.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.

stroke

Getter for the grid stroke line.

Returns:

string | anychart.graphics.vector.Stroke - Grid stroke line settings.
See listing
var stroke = grids.stroke();
Setter for grid stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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.

vertical

Getter for the vertical grid.

Returns:

anychart.core.grids.Map - Grid instance.
Setter for the vertical grid.

Params:

NameTypeDescription
valueboolean | ObjectValue to set.

Returns:

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

zIndex

Getter for the grid zIndex.

Returns:

number | anychart.enums.MapGridZIndex - Grid z-index.
See listing
var currentZIndex = grids.zIndex();
Setter for the grid zIndex.

Params:

NameTypeDescription
valuenumber | anychart.enums.MapGridZIndexZ-index to set.

Returns:

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