Top
You are looking at an outdated 7.14.0 version of this document. Switch to the 7.14.3 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:

Name Type Default Description
value boolean
true
Whether grid should draw first line.

Returns:

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

Try it:

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:

Name Type Description
value boolean Whether grid should draw last line.

Returns:

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

Try it:

enabled

Getter for the grid enabled state.

Returns:

boolean - Grid enabled state.
Setter for the grid 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:

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:

Name Type Description
value anychart.graphics.vector.Fill Color 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:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

horizontal

Getter for the horizontal grid.

Returns:

anychart.core.grids.Map - Grid instance.

Try it:

Setter for the horizontal grid.

Params:

Name Type Description
value boolean | Object Value to set.

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Default 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
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
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 Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

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:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
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.grids.MapSettings - Self instance for method chaining.

Try it:

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:

Name Type Description
value anychart.graphics.vector.Fill Color 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:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

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:

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:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
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.grids.MapSettings - Self instance for method chaining.

Try it:

unlisten

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

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
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:

vertical

Getter for the vertical grid.

Returns:

anychart.core.grids.Map - Grid instance.

Try it:

Setter for the vertical grid.

Params:

Name Type Description
value boolean | Object Value to set.

Returns:

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

Try it:

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:

Name Type Description
value number | anychart.enums.MapGridZIndex Z-index to set.

Returns:

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

Try it: