class anychart.core.grids.Stock Improve this Doc

Stock grid.

Methods Overview

Specific settings
axis()	Axis settings.
drawFirstLine()	Drawing first line.
drawLastLine()	Drawing last line.
isMinor()	Minor grid or not.
Chart Coloring
palette()	Palette settings.
Coloring
fill()	Fill settings.
stroke()	Stroke fill settings.
Interactivity
enabled()	Element state (enabled or disabled).
Scales
scale()	Scale settings.
Size and Position
isHorizontal()	Whether an grid has horizontal layout.
zIndex()	Z-index of the element.

Methods Description

axis

axis()Since version 7.10.0

Getter for the grid axis.

Returns:

anychart.core.axes.StockDateTime | anychart.core.axes.Linear - Grid axis.

Try it:

Usage sample

axis(axis)Since version 7.10.0

Getter for the grid axis.

Params:

Name	Type	Description
axis	anychart.core.axes.StockDateTime \| anychart.core.axes.Linear	Axis instance to set.

Returns:

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

Try it:

Usage sample

drawFirstLine

drawFirstLine()Since version 7.7.0

Getter for the first line drawing flag.

Returns:

boolean - Drawing flag.

Try it:

Usage sample

drawFirstLine(enabled)Since version 7.7.0

Setter for the first line drawing flag. Whether to draw the first line.

Params:

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

Returns:

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

Try it:

Usage sample

drawLastLine

drawLastLine()Since version 7.7.0

Getter for the last line drawing flag.

Returns:

boolean - Drawing flag.

Try it:

Usage sample

drawLastLine(enabled)Since version 7.7.0

Setter for the last line drawing flag. Whether to draw the last line.

Params:

Name	Type	Default	Description
enabled	boolean	true	Whether grid should draw last line.

Returns:

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

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

fill

fill()Since version 8.0.0

Getter for grid fill settings.

Returns:

anychart.graphics.vector.Fill - Grid fill settings.

See listing

var plotGrid = plot.yGrid();
var fill = plotGrid.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:

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.Stock - Self instance for method chaining.

Try it:

fill(fillFunction)Since version 8.0.0

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 }

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:

Usage sample

fill(color, opacity)Since version 8.0.0

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.

Returns:

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

Try it:

Usage sample

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

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.Stock - Self instance for method chaining.

Try it:

Usage sample

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

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.Stock - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)Since version 8.0.0

Image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

isHorizontal

isHorizontal()Since version 7.7.0

Whether an grid has horizontal layout.
Layout is define by anychart.core.grids.Stock#layout method.

Returns:

boolean - Returns true if the grid's layout is horizontal.

Try it:

Usage sample

isMinor

isMinor()Since version 7.7.0

Getter for the minor grid state flag.

Returns:

boolean - Boolean flag.

Try it:

Usage sample

isMinor(enabled)Since version 7.7.0

Setter for the minor grid state flag. Whether it is a minor grid or not.

Params:

Name	Type	Default	Description
enabled	boolean	false	Minor or not.

Returns:

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

Try it:

Usage sample

palette

palette()Since version 8.0.0

Getter for the colors palette.

Returns:

anychart.palettes.RangeColors | anychart.palettes.DistinctColors - Grid palette.

See listing

var plotGrid = plot.yGrid();
var fill = plotGrid.fill();

palette(settings)Since version 8.0.0

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.

Try it:

scale

scale()Since version 7.7.0

Getter for the grid scale.

Returns:

anychart.scales.Base | anychart.scales.StockScatterDateTime - Grid scale.

See listing

var plot = chart.plot();
var grid = plot.grid();
var scale = grid.scale()

scale(settings)Since version 7.7.0

Setter for the grid scale.

Params:

Name	Type	Default	Description
settings	Object \| anychart.scales.Base \| anychart.scales.StockScatterDateTime	anychart.scales.Linear	Scale settings to set.

Returns:

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

Try it:

Usage sample

stroke

stroke()Since version 7.7.0

Getter for the grid stroke.

Returns:

anychart.graphics.vector.Stroke - Grid stroke settings.

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.7.0

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	'#CECECE'	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.