class anychart.standalones.DataGrid Improve this Doc

The DataGrid class contains methods for configuring standalones data grid.

Methods Overview

Specific settings
buttons()	DataGrid button settings.
column()	Column settings.
endIndex()	End index.
headerHeight()	Header height.
onEditEnd()	onEditStart function.
onEditStart()	onEditStart function.
startIndex()	Start index.
Coloring
backgroundFill()	Background fill settings.
columnStroke()	Column stroke settings.
headerFill()	Row fill settings.
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.
rowStroke()	Row stroke settings.
Data
data()	Data settings.
Interactivity
edit()	Live edit settings.
enabled()	Element state (enabled or disabled).
horizontalScrollBar()	Horizontal scroll bar settings.
tooltip()	Tooltip settings.
verticalScrollBar()	Vertical scroll bar settings.
Size and Position
bottom()	Bottom bound settings.
bounds()	Bounds settings.
defaultRowHeight()	Default row height settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
horizontalOffset()	Horizontal offset.
left()	Left bound settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
parentBounds()	Parent bounds settings.
right()	Right bound settings.
top()	Top bound settings.
verticalOffset()	Vertical offset
width()	Width settings.
zIndex()	Z-index of the element.
Miscellaneous
container()	Getter for the data grid container.
draw()	Draws data grid.

Methods Description

backgroundFill

backgroundFill()Since version 7.6.0

Getter for background fill.

Returns:

anychart.graphics.vector.Fill | string - Background fill.

Try it:

Usage sample

backgroundFill(color)Since version 7.6.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 object, an array or a string.

Returns:

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

Try it:

backgroundFill(color, opacity)Since version 7.6.0

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

Try it:

Usage sample

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

Setter for the 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.standalones.DataGrid - Self instance for method chaining.

Try it:

Usage sample

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

Setter for the 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.standalones.DataGrid - Self instance for method chaining.

Try it:

Usage sample

backgroundFill(imageSettings)Since version 7.6.0

Setter for the image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.

bottom(bottom)

Setter for element bottom bound settings.

Params:

Name	Type	Default	Description
bottom	number \| string \| null	null	Bottom bound settings for the element.

Returns:

anychart.standalones.DataGrid - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for element bounds settings.

Returns:

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

bounds(bounds)

Setter for bounds of the element using one parameter.

Params:

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

Returns:

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

Try it:

Usage sample

bounds(x, y, width, height)

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

Try it:

Usage sample

buttons

buttons()Since version 8.2.0

Getter for button settings.

Returns:

anychart.core.gantt.DataGridButton - Button settings.

Try it:

Usage sample

buttons(settings)Since version 8.2.0

Setter for button settings.

Params:

Name	Type	Description
settings	Object	Button settings to set.

Returns:

anychart.standalones.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.

Returns:

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

Try it:

Usage sample

column(settings)

Setter for the first column.

Params:

Name	Type	Description
settings	anychart.core.ui.DataGrid.Column \| Object	Column settings to set.

Returns:

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

Try it:

Usage sample

column(index, settings)

Setter for the column by index.

Params:

Name	Type	Description
index	number	Column index.
settings	anychart.core.ui.DataGrid.Column \| Object	Column settings to set.

Returns:

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

Try it:

Usage sample

columnStroke

columnStroke()

Getter for the column stroke.

Returns:

string | anychart.graphics.vector.Stroke - Column stroke.

Try it:

Usage sample

columnStroke(color)

Setter for the column stroke.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| string	'#cecece'	Stroke color to set.

Returns:

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

Try it:

Usage sample

columnStroke(settings)

Setter for the column stroke using an object.

Params:

Name	Type	Description
settings	Object	Stroke settings from anychart.graphics.vector.Stroke.

Returns:

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

Try it:

Usage sample

container

container()

Getter for the data grid container.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - Data grid container.

See listing

var dataGrid = anychart.standalones.dataGrid();
var container = dataGrid.container();

container(element)

Setter for the data grid container.

Params:

Name	Type	Description
element	string \| anychart.graphics.vector.Layer \| anychart.graphics.vector.Stage	The value to set.

Returns:

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

Try it:

Usage sample

data

data()

Getter for data.

Returns:

anychart.data.Tree - Returns data tree.

Try it:

Usage sample

data(data)

Setter for new data.

Params:

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

Returns:

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

Try it:

Usage sample

defaultRowHeight

defaultRowHeight()Since version 7.12.0

Getter for the default row height.

Returns:

number - Default row height.

See listing

var height = dataGrid.defaultRowHeight();

defaultRowHeight(height)Since version 7.12.0

Setter for the default row height.

Params:

Name	Type	Default	Description
height	number	20	Default row height to set.

Returns:

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

Try it:

Usage sample

draw

draw()

Draws data grid.

Returns:

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

Try it:

Usage sample

edit

edit()Since version 8.3.0

Getter for live edit settings.

Returns:

anychart.core.gantt.edit.StructureEdit - Live edit settings.

Try it:

Usage sample

edit(settings)Since version 8.3.0

Setter for live edit settings. Learn more about Live editing.

Detailed description

Sets live edit settings depending on parameter type:

boolean - disable or enable live edit.
object - sets live edit settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean	false	Live edit settings to set.

Returns:

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

Try it:

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

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

endIndex

endIndex()

Getter for the end index.

Returns:

number - End index.

Try it:

Usage sample

endIndex(index)

Setter for the end index.

Detailed description

This method as setter works only for a 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
index	number	0	End index to set.

Returns:

anychart.standalones.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.

headerFill

headerFill()

Getter for the header fill.

Returns:

anychart.graphics.vector.Fill | string - Returns header fill color.

See listing

var headerFill = dataGrid.headerFill()

headerFill(color)

Setter for fill settings using an object, an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	'#fff'	Color as an object, an array or a string.

Returns:

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

Try it:

headerFill(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.standalones.DataGrid - Self instance for method chaining.

Try it:

Usage sample

headerFill(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.standalones.DataGrid - Self instance for method chaining.

Try it:

Usage sample

headerFill(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.standalones.DataGrid - Self instance for method chaining.

Try it:

Usage sample

headerFill(imageSettings)

Image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

headerHeight

headerHeight()Since version 7.8.0

Getter for the header height.

Returns:

number - Header height.

Try it:

Usage sample

headerHeight(height)Since version 7.8.0

Setter for the header height.

Params:

Name	Type	Default	Description
height	number	25	Header height to set.

Returns:

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

Try it:

Usage sample

height

height()

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.

height(height)

Setter for element height setting.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Height settings for the element.

Returns:

anychart.standalones.DataGrid - Returns self for method chaining.

Try it:

Usage sample

horizontalOffset

horizontalOffset()

Getter for the horizontal offset.

Returns:

number - Horizontal offset.

Try it:

Usage sample

horizontalOffset(offset)

Setter for the horizontal offset.

Params:

Name	Type	Default	Description
offset	number	0	Horizontal offset to set.

Returns:

anychart.standalones.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(settings)Since version 7.12.0

Setter for the horizontal scroll bar.

Params:

Name	Type	Description
settings	Object	Horizontal scroll bar settings to set.

Returns:

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

Try it:

Usage sample

left

left()

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.

left(left)

Setter for element left bound settings.

Params:

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

Returns:

anychart.standalones.DataGrid - Returns self for method chaining.

Try it:

Usage sample

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.

maxHeight(height)

Setter for the maximum height.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Maximum height to set.

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.

maxWidth(width)

Setter for the maximum width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Maximum width to set.

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.

minHeight(height)

Setter for the 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
height	number \| string \| null	null	Minimum height to set.

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.

minWidth(width)

Setter for the 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
width	number \| string \| null	null	Minimum width to set.

Returns:

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

Try it:

Usage sample

onEditEnd

onEditEnd()Since version 8.2.0

Getter for the onEditEnd function.

Returns:

function():Object|undefined - Returns onEditEnd function.

See listing

var dataGrid = chart.dataGrid();
var onEditEnd = dataGrid.onEditEnd();

onEditEnd(onEditEndFunction)Since version 8.2.0

Setter for the onEditEnd function.

Detailed description

To apply the changes, the function must return an object with an itemMap, where the fields correspond to dataItem fields.
The function is called when changing the focus or pressing the enter key.
When the editing is canceled (pressing the escape key), the function isn't called and the changes aren't applied, the input disappears.

Params:

Name	Type	Default	Description
onEditEndFunction	function():Object\|undefined	function() { return this[columnIndex] == 1 ? {itemMap: {name: this['value']}} : {cancelEdit: true}; }	OnEditEnd function to set. Function that looks like: function(){ // this.columnIndex - The column index for the editing. Type is a number // this.item - Corresponding dataItem. Type is anychart.data.Tree.DataItem // this.value - The value entered by the user. Type is a string return Object with a map itemMap or null/undefined; // Data changes don't occur at all when: - the function returns null or undefined - the object contains 'cancelEdit' field set to 'true': {'cancelEdit': true} }

Name

Type

Default

Description

onEditEndFunction

function():Object|undefined

function() {
 return this[columnIndex] == 1 ? {itemMap: {name: this['value']}} : {cancelEdit: true};
 }

OnEditEnd function to set.
Function that looks like:

function(){
 // this.columnIndex - The column index for the editing. Type is a number
 // this.item - Corresponding dataItem. Type is anychart.data.Tree.DataItem
 // this.value - The value entered by the user. Type is a string
 return Object with a map itemMap or null/undefined;
 // Data changes don't occur at all when:
  - the function returns null or undefined
  - the object contains 'cancelEdit' field set to 'true': {'cancelEdit': true}
}

Returns:

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

Try it:

Usage sample

onEditStart

onEditStart()Since version 8.2.0

Getter for the onEditStart function.

Returns:

function():Object|undefined - Returns onEditStart function.

See listing

var dataGrid = chart.dataGrid();
var onEditStart = dataGrid.onEditStart();

onEditStart(onEditStartFunction)Since version 8.2.0

Setter for the onEditStart function.

Detailed description

The onEditStart function is called before the edit control appears.
On appear, input contains text defined by the 'value'-field of the object returned by the onEditStart function.
In order for an input to appear, the function must return an object with the string field 'value', the value of which is set in the appeared input.

Params:

Name	Type	Default	Description
onEditStartFunction	function():Object\|undefined	function() { return this[columnIndex] < 1 ? {cancelEdit: true} : {'value: this['value']}; }	OnEditStart function to set. Function that looks like: function(){ // this.columnIndex - The column index from anychart.core.ui.DataGrid#column method. Type is a number // this.item - DataItem (literally corresponding row). Type is anychart.data.Tree.DataItem // this.value - The current text value of a cell. Type is a string return Object or null/undefined; // The input editing doesn't appear: - if the function returns null or undefined - if the object contains 'cancelEdit' field set to 'true': {'cancelEdit': true} }

Name

Type

Default

Description

onEditStartFunction

function():Object|undefined

function() {
return this[columnIndex] < 1 ? {cancelEdit: true} : {'value: this['value']};
}

OnEditStart function to set.
Function that looks like:

function(){
 // this.columnIndex - The column index from anychart.core.ui.DataGrid#column method. Type is a number
 // this.item - DataItem (literally corresponding row). Type is anychart.data.Tree.DataItem
 // this.value - The current text value of a cell. Type is a string
 return Object or null/undefined;
 // The input editing doesn't appear:

 - if the function returns null or undefined

 - if the object contains 'cancelEdit' field set to 'true': {'cancelEdit': true}

}

Returns:

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

Try it:

Usage sample

parentBounds

parentBounds()

Getter for parent bounds.
As a getter falls back to stage bounds.

Returns:

anychart.math.Rect - Parent bounds.

See listing

var dataGrid = anychart.standalones.dataGrid();
var parentBounds = dataGrid.parentBounds();

parentBounds(bounds)

Setter for bounds using single value.

Params:

Name	Type	Description
bounds	anychart.math.Rect \| Object \| null	Parent bounds to set.

Returns:

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

Try it:

Usage sample

parentBounds(left, top, width, height)

Setter for bounds using several values.

Params:

Name	Type	Description
left	number	Left space.
top	number	Top space.
width	number	A width for a dataGrid.
height	number	A height for a dataGrid.

Returns:

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

Try it:

Usage sample

right

right()

Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.

right(right)

Setter for element right bound setting.

Params:

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

Returns:

anychart.standalones.DataGrid - Returns self for method chaining.

Try it:

Usage sample

rowEvenFill

rowEvenFill()

Getter for row even fill.

Returns:

anychart.graphics.vector.Fill | string - Row even fill.

Try it:

Usage sample

rowEvenFill(color)

Setter for fill settings using an object, an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	'#fafafa'	Color as an object, an array or a string.

Returns:

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

Try it:

Usage sample

rowFill

rowFill()

Getter for row fill.

Returns:

anychart.graphics.vector.Fill | string - Row fill color.

Try it:

Usage sample

rowFill(color)

Setter for 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
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	'#fff'	Color as an object, an array or a string.

Returns:

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

Try it:

Usage sample

rowHoverFill

rowHoverFill()

Getter for row hover fill.

Returns:

anychart.graphics.vector.Fill | string - Row hover fill.

Try it:

Usage sample

rowHoverFill(color)

Setter for fill settings using an object, an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	'#edf8ff'	Color as an object, an array or a string.

Returns:

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

Try it:

Usage sample

rowOddFill

rowOddFill()

Getter for row odd fill.

Returns:

anychart.graphics.vector.Fill | string - Row odd fill.

Try it:

Usage sample

rowOddFill(color)

Setter for fill settings using an object, an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	'#fff'	Color as an object, an array or a string.

Returns:

anychart.standalones.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.standalones.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.standalones.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.standalones.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.standalones.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 - Select row fill.

Try it:

Usage sample

rowSelectedFill(color)Since version 7.8.0

Setter for row fill settings in selected mode using an array, an object or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	function(){return this.sourceColor}	Color as an array, an object or a string.

Returns:

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

Try it:

Usage sample

rowStroke

rowStroke()Since version 7.6.0

Getter for the row stroke.

Returns:

string | anychart.graphics.vector.Stroke - Row stroke.

Try it:

Usage sample

rowStroke(color)Since version 7.6.0

Setter for the row stroke.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string	'#cecece'	Color to set.

Returns:

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

Try it:

Usage sample

rowStroke(settings)Since version 7.6.0

Setter for the row stroke using an object.

Params:

Name	Type	Description
settings	Object	Stroke settings from anychart.graphics.vector.Stroke.

Returns:

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

Try it:

Usage sample

startIndex

startIndex()

Getter for the start index.

Returns:

number - Start index.

Try it:

Usage sample

startIndex(index)

Setter for the start index.

Detailed description

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

Params:

Name	Type	Default	Description
index	number	0	Start index to set.

Returns:

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

Try it:

Usage sample

tooltip()

tooltip(settings)

Getter for tooltip settings.

Detailed description

Params:

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

Returns:

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

Try it:

top

top()

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.

top(top)

Setter for element top bound settings.

Params:

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

Returns:

anychart.standalones.DataGrid - Returns self for method chaining.

Try it:

Usage sample

verticalOffset

verticalOffset()

Getter for the vertical offset.

Returns:

number - Vertical offset.

Try it:

Usage sample

verticalOffset(offset)

Setter for the vertical offset.

Detailed description

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

Params: