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.
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
enabledboolean
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
enabledbooleanWhether 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
enabledboolean
false
Value to set.

Returns:

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

fill

Getter for grid fill settings.

Returns:

string | anychart.graphics.vector.Fill - Grid fill settings.
See listing
var grids = map.grids();
var fill = mapGrids.fill();
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.
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.
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.
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
settingsboolean | ObjectHorizontal grid settings 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(e:Object)
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(e:Object)
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.
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.
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.

palette

Getter for the colors palette.
See listing
var mapGrids = map.grids();
var palette = mapGrids.palette();
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.

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.
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.
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.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
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
settingsboolean | ObjectVertical grid settings to set.

Returns:

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

zIndex

Getter for the grid zIndex.

Returns:

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

Params:

NameTypeDescription
zIndexnumber | stringZ-index to set.

Returns:

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