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

class anychart.core.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

Getter for the current background fill.

Returns:

anychart.graphics.vector.Fill | string - Current background fill.
Sets background fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.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:

NameTypeDefaultDescription
colorstring
"none"
Color as a string.
opacitynumber
Color opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Linear gradient background fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Radial gradient background fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Image background fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

bottom

Getter for element bottom bound setting.

Returns:

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

Params:

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

Returns:

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

bounds

Getter for the element bounds settings.

Returns:

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

Params:

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

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Setter for the element bounds settings.

Params:

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

Returns:

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

column

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

Params:

NameTypeDescription
indexnumberColumn index or column.

Returns:

anychart.core.ui.DataGrid.Column - Column by index.
Setter for first column.

Params:

NameTypeDescription
valueanychart.core.ui.DataGrid.ColumnColumn to set.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Setter for column by index.

Params:

NameTypeDescription
indexnumberColumn index or column.
valueanychart.core.ui.DataGrid.ColumnColumn to set.

Returns:

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

columnStroke

Getter for the current column stroke.

Returns:

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

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | string
"#ccd7e1"
Value to set.

Returns:

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

data

Getter for data.

Returns:

anychart.data.Tree - Returns current data tree.
Setter for new data.

Params:

NameTypeDescription
valueanychart.data.TreeNew data tree.

Returns:

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

draw

Draws data grid.

Returns:

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

editStructurePreviewDashStroke

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

Returns:

string | anychart.graphics.vector.Stroke - The current structure preview stroke.
Setter for the structure preview dash stroke in edit mode.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | string
{color: "#4285F4", dash: "4 4"}
Value to set.

Returns:

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

editStructurePreviewFill

Getter for the current structure preview fill in edit mode.

Returns:

anychart.graphics.vector.Fill | string - The current structure preview fill.
Sets structure preview fill settings in edit mode using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.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:

NameTypeDefaultDescription
colorstring
"none"
Color as a string.
opacitynumber
Color opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Linear gradient structure preview fill in edit mode. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Radial gradient structure preview fill in edit mode. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Image structure preview fill in edit mode. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

editStructurePreviewStroke

Getter for the current structure preview stroke in edit mode.

Returns:

string | anychart.graphics.vector.Stroke - The current structure preview stroke.
Setter for the structure preview stroke in edit mode.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | string
{color: "#4285F4", thickness: 2}
Value to set.

Returns:

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

editing

Gets the current live edit mode.

Returns:

boolean - The current live edit mode.
Enables or disables live edit mode.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

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

enabled

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

Returns:

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

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

endIndex

Getter for end index.

Returns:

number - Current end index.
Setter end index.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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

getPixelBounds

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

Returns:

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

height

Getter for element height setting.

Returns:

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

Params:

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

Returns:

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

horizontalOffset

Getter for horizontal offset.

Returns:

number - Current value.
Setter for horizontal offset.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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

horizontalScrollBar

Getter for the horizontal scroll bar.

Returns:

anychart.core.ui.ScrollBar - Scroll bar.
Setter for the horizontal scroll bar.

Params:

NameTypeDescription
valueObjectObject with settings.

Returns:

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

left

Getter for element left bound setting.

Returns:

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

Params:

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

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method. Function that looks like function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

maxHeight

Getter for maximum height.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

maxWidth

Getter for maximum width.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minHeight

Getter for minimum height.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minWidth

Getter for minimum width.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

print

Prints all elements on related stage.

Params:

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

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.
Getter for element right bound setting.

Returns:

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

Params:

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

Returns:

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

rowEvenFill

Getter for row even fill.

Returns:

anychart.graphics.vector.Fill | string - Current row even fill.
Sets fill settings using an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.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:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

rowFill

Getter for rows fill.

Returns:

anychart.graphics.vector.Fill | string - Current rows fill.
Sets fill settings using an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.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:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

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

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

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

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

rowHoverFill

Getter for row hover fill.

Returns:

anychart.graphics.vector.Fill | string - Current row hover fill.
Sets fill settings using an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.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:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

rowOddFill

Getter for row odd fill.

Returns:

anychart.graphics.vector.Fill | string - Current row odd fill.
Sets fill settings using an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.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:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

rowSelectedFill

Getter for row fill in selected mode.

Returns:

anychart.graphics.vector.Fill | string - Current value row fill in selected mode.
Sets row fill settings in selected mode using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.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:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Linear gradient fill in selected mode. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.

Returns:

anychart.core.ui.DataGrid - Self instance for method chaining.
Radial gradient fill in selected mode. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

startIndex

Getter for start index.

Returns:

number - Current start index.
Setter for start index.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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

tooltip

Getter for tooltip settings.

Returns:

anychart.core.ui.Tooltip - Current settings tooltip.
Getter for tooltip settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Tooltip settings.

Returns:

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

top

Getter for element top bound setting.

Returns:

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

Params:

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

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

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

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

verticalOffset

Getter for vertical offset.

Returns:

number - Current vertical offset.
Setter for vertical offset.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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

width

Getter for element width setting.

Returns:

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

Params:

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

Returns:

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

zIndex

Getter for the current Z-index of the element.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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