AnyChart
API Reference
Still have questions?
Contact support
    Top

    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.
    Chart Coloring
    palette()Palette settings.
    Coloring
    fill()Odd fill settings.
    minorStroke()Stroke settings.
    stroke()Stroke settings.
    Size and Position
    zIndex()Z-index setting.

    Methods Description

    drawFirstLine

    drawFirstLine()Since version 7.12.0

    Getter for the first line drawing flag.

    Returns:

    boolean - Drawing flag.
    See listing
    var grids = map.grids();
var flag = grids.drawFirstLine();

    drawFirstLine(enabled)Since version 7.12.0

    Setter for the first line drawing.

    Params:

    NameTypeDefaultDescription
    enabledboolean
    true
    		 Whether grid should draw first line.

    Returns:

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

    Try it:

    drawLastLine

    drawLastLine()Since version 7.12.0

    Getter for the last line drawing flag.

    Returns:

    boolean - Drawing flag.
    See listing
    var grids = map.grids();
var flag = grids.drawLastLine();

    drawLastLine(enabled)Since version 7.12.0

    Setter for the last line drawing.

    Params:

    NameTypeDescription
    enabledbooleanWhether grid should draw last line.

    Returns:

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

    Try it:

    enabled

    enabled()Since version 7.12.0

    Getter for the grid enabled state.

    Returns:

    boolean - Grid enabled state.

    enabled(enabled)Since version 7.12.0

    Setter for the grid enabled state.

    Params:

    NameTypeDefaultDescription
    enabledboolean
    false
    		 Value to set.

    Returns:

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

    Try it:

    fill

    fill()Since version 8.0.0

    Getter for grid fill settings.

    Returns:

    string | anychart.graphics.vector.Fill - Grid fill settings.
    See listing
    var grids = map.grids();
var fill = mapGrids.fill();

    fill(color)Since version 8.0.0

    Setter for fill settings using an array, an object or a string. Learn more about coloring.

    Params:

    NameTypeDescription
    coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an array, an object or a string.

    Returns:

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

    Try it:

    fill(fillFunction)Since version 8.0.0

    Setter for fill settings using function.

    Params:

    NameTypeDefaultDescription
    fillFunctionfunction():anychart.graphics.vector.Fill
    function() {
 return this['palette'].itemAt(this['index']);
}
    		 Function that looks like: 
    function(){
   // this.grid - grid instance.
   // this.palette - grid palette.
   // this.index - index of the grid element.
   return fillValue; // type anychart.graphics.vector.Fill
}

    Returns:

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

    Try it:

    fill(color, opacity)Since version 8.0.0

    Fill color with opacity. Fill as a string or an object.

    Params:

    NameTypeDescription
    colorstringColor as a string.
    opacitynumberColor opacity (0 to 1).

    Returns:

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

    Try it:

    fill(keys, angle, mode, opacity)Since version 8.0.0

    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.

    Try it:

    fill(keys, cx, cy, mode, opacity, fx, fy)Since version 8.0.0

    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.

    Try it:

    fill(imageSettings)Since version 8.0.0

    Image fill. Learn more about coloring.

    Params:

    NameTypeDescription
    imageSettingsanychart.graphics.vector.FillObject with settings.

    Returns:

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

    Try it:

    horizontal

    horizontal()Since version 7.12.0

    Getter for the horizontal grid.

    Returns:

    anychart.core.grids.Map - Grid instance.

    Try it:

    horizontal(settings)Since version 7.12.0

    Setter for the horizontal grid.

    Params:

    NameTypeDescription
    settingsboolean | ObjectHorizontal grid settings to set.

    Returns:

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

    Try it:

    minorStroke

    minorStroke()Since version 7.12.0

    Getter for the minor grid stroke line.

    Returns:

    string | anychart.graphics.vector.Stroke - Grid stroke line settings.
    See listing
    var minorStroke = grids.minorStroke();

    minorStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.12.0

    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.
    lineJoinstring | anychart.graphics.vector.StrokeLineJoin
    		Line join style.
    lineCapstring | anychart.graphics.vector.StrokeLineCap
    		Line cap style.
    Returns:
    anychart.core.grids.MapSettings - Self instance for method chaining.
    Try it:
    minorStroke(settings)
    Setter for grid stroke using an object.
    Params:
    NameTypeDescription
    settingsObjectStroke settings from anychart.graphics.vector.Stroke.
    Returns:
    anychart.core.grids.MapSettings - Self instance for method chaining.
    Try it:
    palette
    palette()Since version 8.0.0
    Getter for the colors palette.
    Returns:
    anychart.palettes.RangeColors | anychart.palettes.DistinctColors - Grid palette.
     See listing
    var mapGrids = map.grids();
var palette = mapGrids.palette();
    palette(settings)Since version 8.0.0
    Setter for the grid colors palette.
    Params:
    NameTypeDescription
    settingsanychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string>Grid
colors palette settings to set.
    Returns:
    anychart.core.grids.Map - Self instance for method chaining.
    Try it:
    stroke
    stroke()Since version 7.12.0
    Getter for the grid stroke line.
    Returns:
    string | anychart.graphics.vector.Stroke - Grid stroke line settings.
     See listing
    var stroke = grids.stroke();
    stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.12.0
    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.
    lineJoinstring | anychart.graphics.vector.StrokeLineJoin
    		Line join style.
    lineCapstring | anychart.graphics.vector.StrokeLineCap
    		Line cap style.
    Returns:
    anychart.core.grids.MapSettings - Self instance for method chaining.
    Try it:
    stroke(settings)Since version 7.12.0
    Setter for the grid stroke using an object.
    Params:
    NameTypeDescription
    settingsObjectStroke settings from anychart.graphics.vector.Stroke.
    Returns:
    anychart.core.grids.MapSettings - Self instance for method chaining.
    Try it:
    vertical
    vertical()Since version 7.12.0
    Getter for the vertical grid.
    Returns:
    anychart.core.grids.Map - Grid instance.
    Try it:
    vertical(settings)Since version 7.12.0
    Setter for the vertical grid.
    Params:
    NameTypeDescription
    settingsboolean | ObjectVertical grid settings to set.
    Returns:
    anychart.core.grids.MapSettings - Self instance for method chaining.
    Try it:
    zIndex
    zIndex()Since version 7.12.0
    Getter for the grid zIndex.
    Returns:
    number | anychart.enums.MapGridZIndex | string - Grid z-index.
     See listing
    var zIndex = grids.zIndex();
    zIndex(zIndex)Since version 7.12.0
    Setter for the grid zIndex.
    Params:
    NameTypeDescription
    zIndexnumber | stringZ-index to set.
    Returns:
    anychart.core.grids.MapSettings - Self instance for method chaining.
    Try it: