AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

class anychart.core.resource.Grid Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Resource Chart grid.

Methods Overview

Specific settings
drawBottomLine()Drawing of the bottom line.
drawLeftLine()Drawing of the left line.
drawRightLine()Drawing of the right line.
drawTopLine()Drawing of the top line.
overlay()Overlay element.
Coloring
background()Background settings.
evenFill()Even fill settings.
evenHatchFill()Even hatch fill settings.
evenHolidayFill()Even holiday fill settings.
evenHolidayHatchFill()Even holiday hatch fill settings.
horizontalStroke()Horizontal stroke settings.
oddFill()Odd fill settings.
oddHatchFill()Odd hatch fill settings.
oddHolidayFill()Odd holiday fill settings.
oddHolidayHatchFill()Odd holiday hatch fill settings.
verticalStroke()Vertical 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.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
bottom()Bottom bound setting.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
height()Height setting.
left()Left bound setting.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
right()Right bound setting.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.

Methods Description

background

Getter for the background.

Returns:

anychart.core.ui.Background - Background settings.
Setter for the background.

Params:

NameTypeDescription
valuestring | Object | null | booleanValue to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

bottom

Getter for element bottom bound setting.

Returns:

number | string | undefined - Current element's bottom bound setting.
Sets element bottom bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Bottom bound setting for the element.

Returns:

anychart.core.resource.Grid - Returns self for method chaining.

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets bounds of the element using one parameter.

Params:

NameTypeDescription
valueanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.
Setter for the element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

drawBottomLine

Getter for the bottom line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentGrid = chart.grid();
var flag = currentGrid.drawBottomLine();
Setter for the bottom line drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

drawLeftLine

Getter for the left line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentGrid = chart.grid();
var flag = currentGrid.drawLeftLine();
Setter for the left line drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

drawRightLine

Getter for the right line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentGrid = chart.grid();
var flag = currentGrid.drawRightLine();
Setter for the right line drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

drawTopLine

Getter for the top line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentGrid = chart.grid();
var flag = currentGrid.drawTopLine();
Setter for the top line drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

evenFill

Getter for the even fill color.

Returns:

anychart.graphics.vector.Fill - The odd fill color.
See listing
var currentGrid = chart.grid();
var evenFillSettings = currentGrid.evenFill();
Setter for even fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.
Even fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.
Linear gradient even 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.resource.Grid - Self instance for method chaining.
Radial gradient even 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.resource.Grid - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

evenHatchFill

Getter for even hatch fill settings.
See listing
var currentActivities = chart.activities();
var currentHatchFill = currentActivities.evenHatchFill();
Setter for even hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string
false
PatternFill or HatchFill instance or type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

evenHolidayFill

Getter for the even holiday fill color.

Returns:

anychart.graphics.vector.Fill - The even fill color.
See listing
var currentGrid = chart.grid();
var evenHolidayFillSettings = currentGrid.evenHolidayFill();
Setter for even holiday fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.
Odd holiday fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.
Linear gradient even holiday 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.resource.Grid - Self instance for method chaining.
Radial gradient even holiday 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.resource.Grid - Self instance for method chaining.
Image even holiday fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

evenHolidayHatchFill

Getter for even holiday hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The even holiday hatch fill.
See listing
var currentActivities = chart.activities();
var currentHatchFill = currentActivities.evenHolidayHatchFill();
Setter for even holiday hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string
false
PatternFill or HatchFill instance or type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

getPixelBounds

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

height

Getter for element height setting.

Returns:

number | string | undefined - Current element's height setting.
Sets element height setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Height setting for the element.

Returns:

anychart.core.resource.Grid - Returns self for method chaining.

horizontalStroke

Getter for the horizontal stroke.

Returns:

anychart.graphics.vector.Stroke | function - The horizontal stroke.
See listing
var currentGrid = chart.grid();
var strokeSettings = currentGrid.horizontalStroke();
Setter for the horizontal 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.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

left

Getter for element left bound setting.

Returns:

number | string | undefined - Current element's left bound setting.
Sets element left bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the element.

Returns:

anychart.core.resource.Grid - Returns self for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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
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.

maxHeight

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.
Setter for maximum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

maxWidth

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.
Setter for maximum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

minHeight

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.
Setter for minimum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

minWidth

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.
Setter for minimum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

oddFill

Getter for the odd fill color.

Returns:

anychart.graphics.vector.Fill - The odd fill color.
See listing
var currentGrid = chart.grid();
var oddFillSettings = currentGrid.oddFill();
Setter for odd fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.
Odd fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.
Linear gradient odd 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.resource.Grid - Self instance for method chaining.
Radial gradient odd 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.resource.Grid - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

oddHatchFill

Getter for odd hatch fill settings.
See listing
var currentActivities = chart.activities();
var currentHatchFill = currentActivities.oddHatchFill();
Setter for odd hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string
false
PatternFill or HatchFill instance or type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

oddHolidayFill

Getter for the odd holiday fill color.

Returns:

anychart.graphics.vector.Fill - The odd fill color.
See listing
var currentGrid = chart.grid();
var oddHolidayFillSettings = currentGrid.oddHolidayFill();
Setter for odd holiday fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.
Odd holiday fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.
Linear gradient odd holiday 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.resource.Grid - Self instance for method chaining.
Radial gradient odd holiday 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.resource.Grid - Self instance for method chaining.
Image odd holiday fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

oddHolidayHatchFill

Getter for odd holiday hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - The odd holiday hatch fill.
See listing
var currentActivities = chart.activities();
var currentHatchFill = currentActivities.oddHolidayHatchFill();
Setter for odd holiday hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string
false
PatternFill or HatchFill instance or type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

overlay

Getter for the overlay element.

Returns:

anychart.core.ui.Overlay - Overlay element.
See listing
var element = grid.overlay();
Setter for the overlay element.

Params:

NameTypeDescription
valueObject | null | booleanValue to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

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.
Getter for element right bound setting.

Returns:

number | string | undefined - Current element's right bound setting.
Sets element right bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Right bound setting for the element.

Returns:

anychart.core.resource.Grid - Returns self for method chaining.

top

Getter for element top bound setting.

Returns:

number | string | undefined - Current element's top bound setting.
Sets element top bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Top bound setting for the element.

Returns:

anychart.core.resource.Grid - Returns self for method chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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.

verticalStroke

Getter for the vertical stroke.

Returns:

anychart.graphics.vector.Stroke | function - The vertical stroke.
See listing
var currentGrid = chart.grid();
var strokeSettings = currentGrid.verticalStroke();
Setter for the vertical 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.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.

width

Getter for element width setting.

Returns:

number | string | undefined - Current element's width setting.
Sets element width setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Width setting for the element.

Returns:

anychart.core.resource.Grid - Returns self for method chaining.

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

anychart.core.resource.Grid - Self instance for method chaining.