AnyChart
API Reference
Still have questions?
Contact support
Top

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 settings.
bounds()Bounds 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.
right()Right bound settings.
top()Top bound settings.
verticalOffset()Vertical offset
width()Width settings.
zIndex()Z-index of the element.
Miscellaneous
draw()Draws data grid.

Methods Description

backgroundFill

Getter for the background fill.

Returns:

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

Try it:

Setter for 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.
Background fill color with 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:

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:

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:

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:

bottom

Getter for element bottom bound settings.

Returns:

number string undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for 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.VisualBase - Self instance for method chaining.

Try it:

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.core.VisualBase - Self instance for method chaining.

Try it:

column

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:

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

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

columnStroke

Getter for the column stroke.

Returns:

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

Try it:

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:

data

Getter for data.

Returns:

anychart.data.Tree - Returns data tree.

Try it:

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:

draw

Draws data grid.

Returns:

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

Try it:

editStructurePreviewDashStroke

Getter for the structure preview dash stroke in edit mode.

Returns:

string anychart.graphics.vector.Stroke - Structure preview stroke.

Try it:

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:

editStructurePreviewFill

Getter for the structure preview fill in edit mode.

Returns:

anychart.graphics.vector.Fill string - Structure preview fill.

Try it:

Setter for 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.
Structure preview fill color in edit mode with 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:

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:

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:

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:

editStructurePreviewStroke

Getter for the structure preview stroke in edit mode.

Returns:

string anychart.graphics.vector.Stroke - Structure preview stroke.

Try it:

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:

editing

Gets the live edit mode.

Returns:

boolean - Live edit mode.

Try it:

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:

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

endIndex

Getter for the end index.

Returns:

number - End index.

Try it:

Setter for the end index.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it:

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 settings.

Returns:

number string undefined - Element's height setting.
Setter for element height setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

horizontalOffset

Getter for the horizontal offset.

Returns:

number - Horizontal offset.

Try it:

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

horizontalScrollBar

Getter for the horizontal scroll bar.

Returns:

anychart.core.ui.ScrollBar - Scroll bar.

Try it:

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:

left

Getter for element left bound settings.

Returns:

number string undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

listen

Adds an event listener to an implementing object.

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:

listenOnce

Adds an event listener to an implementing object.

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:

maxHeight

Getter for the maximum height.

Returns:

number string null - Element's maximum height.
Setter for the maximum height.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

maxWidth

Getter for the maximum width.

Returns:

number string null - Element's maximum width.
Setter for the maximum width.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minHeight

Getter for the minimum height.

Returns:

number string null - Element's minimum height.
Setter for the minimum height.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minWidth

Getter for the minimum width.

Returns:

number string null - Element's minimum width.
Setter for the minimum width.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

print

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:

removeAllListeners

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:

Getter for element right bound settings.

Returns:

number string undefined - Element's right bound setting.
Setter for element right bound setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

rowEvenFill

Getter for row even fill.

Returns:

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

Try it:

Setter for 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.
Fill color with 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:

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:

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:

Params:

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

Returns:

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

Try it:

rowFill

Getter for row fill.

Returns:

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

Try it:

Setter for 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.
Fill color with 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:

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:

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:

Params:

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

Returns:

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

Try it:

rowHoverFill

Getter for row hover fill.

Returns:

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

Try it:

Setter for 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.
Fill color with 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:

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:

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:

Params:

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

Returns:

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

Try it:

rowOddFill

Getter for row odd fill.

Returns:

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

Try it:

Setter for 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.
Fill color with 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:

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:

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:

Params:

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

Returns:

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

Try it:

rowSelectedFill

Getter for row fill in selected mode.

Returns:

anychart.graphics.vector.Fill string - Select row fill.

Try it:

Setter for 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.
Fill color in selected mode with opacity. Fill as a string or an object.

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:

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:

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:

Params:

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

Returns:

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

Try it:

startIndex

Getter for the start index.

Returns:

number - Start index.

Try it:

Setter for the start index.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it:

tooltip

Getter for tooltip settings.

Returns:

anychart.core.ui.Tooltip - Tooltip settings.

Try it:

Getter for tooltip settings.

Params:

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

Returns:

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

top

Getter for element top bound settings.

Returns:

number string undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

unlisten

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:

unlistenByKey

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:

verticalOffset

Getter for the vertical offset.

Returns:

number - Vertical offset.

Try it:

Setter for the vertical offset.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it:

width

Getter for element width settings.

Returns:

number string undefined - Element's width setting.
Setter for element width setting.

Params:

Name Type Default Description
value number | string | null
null
Width settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: