class anychart.core.ui.DataGrid Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Data grid element.
The Data grid is a part of Gantt chart but it also can be used independently.

Methods Overview

Specific settings
column()	Column settings.
endIndex()	End index.
startIndex()	Start index.
Coloring
backgroundFill()	Background fill settings.
columnStroke()	Column stroke settings.
editStructurePreviewDashStroke()	Structure preview dash stroke in edit mode.
editStructurePreviewFill()	Structure preview fill in edit mode.
editStructurePreviewStroke()	Structure preview stroke in edit mode.
rowEvenFill()	Row even fill settings.
rowFill()	Row fill settings.
rowHoverFill()	Row fill settings in hover mode.
rowOddFill()	Row odd fill settings.
rowSelectedFill()	Row fill settings in selected mode.
Data
data()	Data 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
editing()	Live edit mode.
enabled()	Element state (enabled or disabled).
horizontalScrollBar()	Horizontal scroll bar settings.
tooltip()	Tooltip settings.
Size and Position
bottom()	Bottom bound setting.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height setting.
horizontalOffset()	Horizontal offset.
left()	Left bound setting.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound setting.
top()	Top bound setting.
verticalOffset()	Vertical offset
width()	Width setting.
zIndex()	Z-index of the element.
Miscellaneous
draw()	Draws data grid.

Methods Description

backgroundFill

backgroundFill()Since version 7.8.0

Getter for the current background fill.

Returns:

anychart.graphics.vector.Fill | string - Current background fill.

Try it:

Usage sample

backgroundFill(value)Since version 7.8.0

Sets background fill settings using an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	"none"	Color as an array or a string.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

backgroundFill(color, opacity)Since version 7.8.0

Background fill color with opacity.

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	Default	Description
color	string	"none"	Color as a string.
opacity	number		Color opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

backgroundFill(keys, angle, mode, opacity)Since version 7.8.0

Linear gradient background 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.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

backgroundFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.8.0

Radial gradient background 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.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

backgroundFill(imageSettings)Since version 7.8.0

Image background fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound setting.

Returns:

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

bottom(value)

Sets element bottom bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Bottom bound setting for the element.

Returns:

anychart.core.ui.DataGrid - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.

bounds(value)

Sets bounds of the element using one parameter.

Params:

Name	Type	Description
value	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

bounds(x, y, width, height)

Setter for the element bounds settings.

Params:

Name	Type	Default	Description
x	number \| string	null	X-coordinate.
y	number \| string	null	Y-coordinate.
width	number \| string	null	Width.
height	number \| string	null	Height.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

column

column(index)

Getter for column by index. Gets column by index or creates a new one if column doesn't exist yet.

Params:

Name	Type	Description
index	number	Column index or column.

Returns:

anychart.core.ui.DataGrid.Column - Column by index.

Try it:

Usage sample

column(value)

Setter for first column.

Params:

Name	Type	Description
value	anychart.core.ui.DataGrid.Column	Column to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

column(index, value)

Setter for column by index.

Params:

Name	Type	Description
index	number	Column index or column.
value	anychart.core.ui.DataGrid.Column	Column to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

columnStroke

columnStroke()

Getter for the current column stroke.

Returns:

string | anychart.graphics.vector.Stroke - The current column stroke.

Try it:

Usage sample

columnStroke(value)

Setter for the column stroke.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Stroke \| string	"#ccd7e1"	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

data

data()

Getter for data.

Returns:

anychart.data.Tree - Returns current data tree.

Try it:

Usage sample

data(value)

Setter for new data.

Params:

Name	Type	Description
value	anychart.data.Tree	New data tree.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

draw

draw()

Draws data grid.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

editStructurePreviewDashStroke

editStructurePreviewDashStroke()Since version 7.8.0

Getter for the current structure preview dash stroke in edit mode.

Returns:

string | anychart.graphics.vector.Stroke - The current structure preview stroke.

Try it:

Usage sample

editStructurePreviewDashStroke(value)Since version 7.8.0

Setter for the structure preview dash stroke in edit mode.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Stroke \| string	{color: "#4285F4", dash: "4 4"}	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

editStructurePreviewFill

editStructurePreviewFill()Since version 7.8.0

Getter for the current structure preview fill in edit mode.

Returns:

anychart.graphics.vector.Fill | string - The current structure preview fill.

Try it:

Usage sample

editStructurePreviewFill(value)Since version 7.8.0

Sets structure preview fill settings in edit mode using an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	{color: "#4285F4", opacity: 0.2}	Color as an array or a string.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

editStructurePreviewFill(color, opacity)Since version 7.8.0

Structure preview fill color in edit mode with opacity.

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	Default	Description
color	string	"none"	Color as a string.
opacity	number		Color opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

editStructurePreviewFill(keys, angle, mode, opacity)Since version 7.8.0

Linear gradient structure preview fill in edit mode. 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.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

editStructurePreviewFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.8.0

Radial gradient structure preview fill in edit mode. 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.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

editStructurePreviewFill(imageSettings)Since version 7.8.0

Image structure preview fill in edit mode. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

editStructurePreviewStroke

editStructurePreviewStroke()Since version 7.8.0

Getter for the current structure preview stroke in edit mode.

Returns:

string | anychart.graphics.vector.Stroke - The current structure preview stroke.

Try it:

Usage sample

editStructurePreviewStroke(value)Since version 7.8.0

Setter for the structure preview stroke in edit mode.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Stroke \| string	{color: "#4285F4", thickness: 2}	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

editing

editing()Since version 7.8.0

Gets the current live edit mode.

Returns:

boolean - The current live edit mode.

Try it:

Usage sample

editing(value)Since version 7.8.0

Enables or disables live edit mode.

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

anychart.standalones.DataGrid - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

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

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

endIndex

endIndex()

Getter for end index.

Returns:

number - Current end index.

Try it:

Usage sample

This method as setter works only for standalone element.
If full data doesn't fit into visible area, DataGrid will show a range of display data ended by this value.
Note: Has higher priority than anychart.core.ui.DataGrid#startIndex.

Params:

Name	Type	Default	Description
value	number	0	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

getPixelBounds

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

height()

Getter for element height setting.

Returns:

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

height(value)

Sets element height setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Height setting for the element.

Returns:

anychart.core.ui.DataGrid - Returns self for method chaining.

Try it:

Usage sample

horizontalOffset

horizontalOffset()

Getter for horizontal offset.

Returns:

number - Current value.

Try it:

Usage sample

horizontalOffset(value)

Setter for horizontal offset.

Params:

Name	Type	Default	Description
value	number	0	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

horizontalScrollBar

horizontalScrollBar()Since version 7.12.0

Getter for the horizontal scroll bar.

Returns:

anychart.core.ui.ScrollBar - Scroll bar.

Try it:

Usage sample

horizontalScrollBar(value)Since version 7.12.0

Setter for the horizontal scroll bar.

Params:

Name	Type	Description
value	Object	Object with settings.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

left

left()

Getter for element left bound setting.

Returns:

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

left(value)

Sets element left bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Left bound setting for the element.

Returns:

anychart.core.ui.DataGrid - Returns self for method chaining.

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		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 }`.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

maxHeight

maxHeight()

Getter for maximum height.

Returns:

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

maxHeight(value)

Setter for maximum height.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

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

maxWidth(value)

Setter for maximum width.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

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

minHeight(value)

Setter for minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

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

minWidth(value)

Setter for minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

Params:

Name	Type	Default	Description
paperSizeOrOptions	anychart.graphics.vector.PaperSize \| Object		Paper size or object with options.
landscape	boolean	false	Flag of landscape.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Usage sample

right

right()

Getter for element right bound setting.

Returns:

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

right(value)

Sets element right bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Right bound setting for the element.

Returns:

anychart.core.ui.DataGrid - Returns self for method chaining.

Try it:

Usage sample

rowEvenFill

rowEvenFill()

Getter for row even fill.

Returns:

anychart.graphics.vector.Fill | string - Current row even fill.

Try it:

Usage sample

rowEvenFill(value)

Sets fill settings using an object or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	"#fafafa"	Color as an object or a string.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

rowEvenFill(color, opacity)

Fill color with opacity.

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

Try it:

Usage sample

rowEvenFill(keys, angle, mode, opacity)

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

Try it:

Usage sample

rowEvenFill(keys, cx, cy, mode, opacity, fx, fy)

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

Try it:

Usage sample

rowEvenFill(imageSettings)

Image fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

rowFill

rowFill()

Getter for rows fill.

Returns:

anychart.graphics.vector.Fill | string - Current rows fill.

Try it:

Usage sample

rowFill(value)

Sets fill settings using an object or a string. Learn more about coloring.

Detailed description

Note: resets settings of anychart.core.ui.DataGrid#oddFill and anychart.core.ui.DataGrid#evenFill.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	"#fff"	Color as an object or a string.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

rowFill(color, opacity)

Fill color with opacity.

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

Try it:

Usage sample

rowFill(keys, angle, mode, opacity)

Linear gradient fill. Learn more about coloring.

Detailed description

Note: resets settings of anychart.core.ui.DataGrid#oddFill and anychart.core.ui.DataGrid#evenFill.

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

Try it:

Usage sample

rowFill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient fill. Learn more about coloring.

Detailed description

Note: resets settings of anychart.core.ui.DataGrid#oddFill and anychart.core.ui.DataGrid#evenFill.

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

Try it:

Usage sample

rowFill(imageSettings)

Image fill. Learn more about coloring.

Detailed description

Note: resets settings of anychart.core.ui.DataGrid#oddFill and anychart.core.ui.DataGrid#evenFill.

Params:

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

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

rowHoverFill

rowHoverFill()

Getter for row hover fill.

Returns:

anychart.graphics.vector.Fill | string - Current row hover fill.

Try it:

Usage sample

rowHoverFill(value)

Sets fill settings using an object or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	"#edf8ff"	Color as an object or a string.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

rowHoverFill(color, opacity)

Fill color with opacity.

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

Try it:

Usage sample

rowHoverFill(keys, angle, mode, opacity)

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

Try it:

Usage sample

rowHoverFill(keys, cx, cy, mode, opacity, fx, fy)

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

Try it:

Usage sample

rowHoverFill(imageSettings)

Image fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

rowOddFill

rowOddFill()

Getter for row odd fill.

Returns:

anychart.graphics.vector.Fill | string - Current row odd fill.

Try it:

Usage sample

rowOddFill(value)

Sets fill settings using an object or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	"#fff"	Color as an object or a string.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

rowOddFill(color, opacity)

Fill color with opacity.

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

Try it:

Usage sample

rowOddFill(keys, angle, mode, opacity)

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

Try it:

Usage sample

rowOddFill(keys, cx, cy, mode, opacity, fx, fy)

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

Try it:

Usage sample

rowOddFill(imageSettings)

Image fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

rowSelectedFill

rowSelectedFill()Since version 7.8.0

Getter for row fill in selected mode.

Returns:

anychart.graphics.vector.Fill | string - Current value row fill in selected mode.

Try it:

Usage sample

rowSelectedFill(value)Since version 7.8.0

Sets row fill settings in selected mode using an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	"#d2eafa"	Color as an array or a string.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

rowSelectedFill(color, opacity)Since version 7.8.0

Fill color in selected mode 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.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

rowSelectedFill(keys, angle, mode)Since version 7.8.0

Linear gradient fill in selected mode. 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.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

rowSelectedFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.8.0

Radial gradient fill in selected mode. 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.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

rowSelectedFill(imageSettings)Since version 7.8.0

Image fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

startIndex

startIndex()

Getter for start index.

Returns:

number - Current start index.

Try it:

Usage sample

startIndex(value)

Setter for start index.

Detailed description

This method as setter works only for standalone element.
If full data doesn't fit into visible area, DataGrid will show a range of display data started from this value.

Params:

Name	Type	Default	Description
value	number	0	Value to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

Usage sample

tooltip()

tooltip(value)

Getter for tooltip settings.

Detailed description

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	true	Tooltip settings.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.

Try it:

top

top()

Getter for element top bound setting.

Returns:

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

top(value)

Sets element top bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Top bound setting for the element.

Returns:

anychart.core.ui.DataGrid - Returns self for method chaining.

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

unlistenByKey

unlistenByKey(key)

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

Name	Type	Description
key	Object	The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

verticalOffset

verticalOffset()

Getter for vertical offset.

Returns:

number - Current vertical offset.

Try it:

Usage sample

verticalOffset(value)

Setter for vertical offset.

Detailed description

This method as setter works only for standalone element.
Gantt Chart defines vertical offset for data grid automatically and you can't customize it by instance.

Params: