AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.grids.Linear Improve this Doc

Extends: anychart.core.VisualBase

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

Getter for the grid axis.

Returns:

anychart.core.axes.Linear - Grid axis.
Setter for the grid axis.

Params:

NameTypeDescription
axisanychart.core.axes.LinearAxis instance to set.

Returns:

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

drawFirstLine

Getter for first line drawing flag.

Returns:

boolean - Drawing flag.
Setter for the first line drawing flag.

Params:

NameTypeDefaultDescription
enabledboolean
true
Whether grid should draw first line.

Returns:

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

drawLastLine

Getter for the last line drawing flag.

Returns:

boolean - Drawing flag
Setter for the last line drawing flag.

Params:

NameTypeDefaultDescription
enabledboolean
true
Whether grid should draw last line.

Returns:

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

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.core.grids.Linear - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

fill

Getter for the 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:

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

Returns:

anychart.core.grids.Linear - 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.Linear - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.grids.Linear - 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.Linear - 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.Linear - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

isHorizontal

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

Returns:

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

isMinor

Getter for the minor grid state flag.

Returns:

boolean - State flag.
Setter for the minor grid state flag.

Params:

NameTypeDefaultDescription
enabledboolean
false
Minor or not.

Returns:

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

palette

Getter for the colors palette.
See listing
var palette = grid.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.Linear - Self instance for method chaining.

scale

Getter for the grid scale.

Returns:

anychart.scales.Base - Grid scale.
Setter for the grid scale.

Params:

NameTypeDefaultDescription
settingsObject | anychart.enums.ScaleTypes | string | anychart.scales.Base
anychart.scales.Linear
Value to set.

Returns:

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

stroke

Getter for the grid stroke.

Returns:

string | anychart.graphics.vector.Stroke - Grid stroke settings.
Setter for the grid stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'#CECECE'
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.grids.Linear - Self instance for method chaining.
Setter for the stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

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

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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