AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.grids.Surface Improve this Doc

Extends: anychart.core.VisualBase

Surface grid class.

Methods Overview

Specific settings
drawFirstLine()Drawing first line.
drawLastLine()Drawing first line.
isMinor()Minor grid or not.
Coloring
fill()Fill settings.
palette()Palette settings.
stroke()Stroke settings.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
zIndex()Z-index of the element.

Methods Description

drawFirstLine

Getter for the first line drawing.

Returns:

boolean - Drawing flag.
See listing
var xGrid = chart.xGrid();
var drawFirstLine = xGrid.drawFirstLine();
Setter for the first line drawing.

Params:

NameTypeDefaultDescription
enabledboolean
true
Whether the grid should draw the first line.

Returns:

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

drawLastLine

Getter for the last line drawing.

Returns:

boolean - Drawing flag.
See listing
var xGrid = chart.xGrid();
var drawLastLine = xGrid.drawLastLine();
Setter for the last line drawing.

Params:

NameTypeDefaultDescription
enabledboolean
true
Whether the grid should draw the last line.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

isMinor

Getter for the minor grid state flag.

Returns:

boolean - State flag.
See listing
var xGrid = chart.xGrid();
var isMinor = xGrid.isMinor();
Setter for the minor grid state flag.

Params:

NameTypeDefaultDescription
enabledboolean
false
Minor or not.

Returns:

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

stroke

Getter for the stroke.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
See listing
var chart = anychart.surface(data);
var stroke = chart.stroke();
Setter for the stroke. 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.Surface - Self instance for method chaining.
Setter for stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

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