class anychart.core.grids.Map Improve this Doc
Extends: anychart.core.VisualBase
Map grids.
Methods Overview
Specific settings | |
drawFirstLine() | Drawing first line. |
drawLastLine() | Drawing last line. |
enabled() | Disable or enable grid. |
Chart Coloring | |
palette() | Palette settings. |
Coloring | |
fill() | Fill settings. |
minorStroke() | Stroke 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. See listing
var grids = map.grids(); var horizontalGrids = mapGrids.horizontal(); var flag = horizontalGrids.drawFirstLine();
Setter for the first line drawing.
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | Whether grid should draw first line. |
Returns:
anychart.core.grids.Map - 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 horizontalGrids = mapGrids.horizontal(); var flag = horizontalGrids.drawLastLine();
Setter for the last line drawing.
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | Whether grid should draw last line. |
Returns:
anychart.core.grids.Map - 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 |
---|---|---|---|
enabled | boolean | false | Value to set. |
Returns:
anychart.core.grids.Map - Self instance for method chaining.Try it:
fill
Getter for grid fill settings.
Returns:
string | anychart.graphics.vector.Fill - Grid fill settings. See listing
var fill = grid.fill();
Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an array, an object or a string. |
Returns:
anychart.core.grids.Map - Self instance for method chaining.Setter for fill settings using function.
Params:
Name | Type | Default | Description |
---|---|---|---|
fillFunction | function():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 with opacity. Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity (0 to 1). |
Returns:
anychart.core.grids.Map - 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.Map - 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.Map - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.grids.Map - Self instance for method chaining.Try it:
minorStroke
Getter for the minor grid stroke line.
Returns:
string | anychart.graphics.vector.Stroke - Minor grid stroke settings. See listing
var minorStroke = grid.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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.grids.Map - Self instance for method chaining.Try it:
Setter for grid stroke using an object.
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.grids.Map - Self instance for method chaining.Try it:
palette
Getter for the colors palette.
See listing
var mapGrids = map.grids(); var horizontalGrids = mapGrids.horizontal(); var palette = horizontalGrids.palette();
Setter for the grid colors palette.
Detailed description
Note: You can use predefined palettes from anychart.palettes.
Params:
Name | Type | Description |
---|---|---|
settings | anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> | Grid colors palette settings to set. |
Returns:
anychart.core.grids.Map - Self instance for method chaining.stroke
Getter for the grid stroke line.
Returns:
string | anychart.graphics.vector.Stroke - Grid stroke settings. See listing
var stroke = grid.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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.grids.Map - Self instance for method chaining.Try it:
Setter for the grid stroke using an object.
Params:
Name | Type | Description |
---|---|---|
settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.grids.Map - Self instance for method chaining.Try it:
zIndex
Setter for the grid zIndex.
Params:
Name | Type | Description |
---|---|---|
zIndex | number | Z-index to set. |
Returns:
anychart.core.grids.Map - Self instance for method chaining.Try it: