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

class anychart.core.grids.MapSettings Improve this Doc

Extends: anychart.core.Base

Map grid.

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.
Size and Position
zIndex()Z-index setting.

Methods Description

drawFirstLine

Getter for the first line drawing flag.

Returns:

boolean - Drawing flag.
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.
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 - Self instance for method chaining.
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.
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:

minorStroke

Getter for the minor grid stroke line.

Returns:

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

Params:

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

stroke

Getter for the grid stroke line.

Returns:

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

Params:

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

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: