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

class anychart.core.ui.DataGrid.Column Improve this Doc

Extends: anychart.core.VisualBase

Data grid column.

Methods Overview

Specific settings
depthPaddingMultiplier()Multiplier to choose a left padding
setColumnFormat()Column format settings.
textFormatter()Sets cell text value formatter.
Advanced Text Settings
cellTextSettings()Label factory settings.
cellTextSettingsOverrider()Cells text settings overrider.
Chart Controls
title()Column title 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
buttonCursor()Button cursor settings.
collapseExpandButtons()Expand or collapse buttons.
enabled()Element state (enabled or disabled).
Size and Position
defaultWidth()Column default width settings.
width()Column width settings.
zIndex()Z-index of the element.

Methods Description

buttonCursor

Getter for the button cursor.

Returns:

anychart.enums.Cursor | string - The button cursor.
See listing
var currentCursor = column.buttonCursor();
Setter for the button cursor.

Params:

NameTypeDefaultDescription
valueCursoranychart.enums.Cursor | string
"pointer"
Cursor type.

Returns:

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

cellTextSettings

Getter for label factory.

Returns:

anychart.core.ui.LabelsFactory - Label factory instance for method chaining.
Setter for label factory to decorate cells.

Params:

NameTypeDescription
valueObjectValue to set.

Returns:

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

cellTextSettingsOverrider

Getter for cells text settings overrider.

Returns:

function - Current cells text settings overrider.
Setter for cells text settings overrider.

Params:

NameTypeDefaultDescription
valuefunction
function(label, dataItem){}
Value to set.

Returns:

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

collapseExpandButtons

Getter for expanding or collapse buttons.

Returns:

boolean - Current value.
Setter for expanding or collapse buttons.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

defaultWidth

Getter for the current column default width.

Returns:

number - The current default width.
Setter for the column default width.

Params:

NameTypeDefaultDescription
valuenumber
undefined
Default width value.

Returns:

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

depthPaddingMultiplier

Getter for the multiplier to choose a left padding.

Returns:

number - Current value.
Setter for the multiplier to choose a left padding.

Params:

NameTypeDefaultDescription
valuenumber
15
Value to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback 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 }.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

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.

setColumnFormat

Sets column format using enum.

Params:

NameTypeDescription
fieldNamestringName of field of data item to work with.
presetValueanychart.enums.ColumnFormatsPreset column format.

Returns:

anychart.core.ui.DataGrid.Column - Self instance for method chaining.
Sets column format using object.

Params:

NameTypeDescription
fieldNamestringName of field of data item to work with.
settingsObjectCustom column format.

Returns:

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

textFormatter

Sets cell text value formatter.

Params:

NameTypeDefaultDescription
valuefunction
function(dataItem) { return '');}
Function that looks like function( // anychart.data.Tree.DataItem - tree data item){ // this.actualEnd - the end date // this.actualStart - the start date // this.autoEnd - automatically calculated end date // this.autoProgress - automatically calculated progress value // this.autoStart - automatically calculated start date // this.id - data item id // this.isResources - flag if chart should be interpreted as resource chart // this.item - current data item // this.name - data item name // this.progressValue - the progress value return textValue; // type string }. Function that returns a text value for the cell by data item.

Returns:

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

title

Getter for column title.

Returns:

anychart.core.ui.Title - Title instance for method chaining.
Setter for column title.

Params:

NameTypeDefaultDescription
valuenull | boolean | Object | string
true
Value to set.

Returns:

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

unlisten

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

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject 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.

width

Getter for column width.

Returns:

number | string - Current column width.
Setter for column width.

Params:

NameTypeDefaultDescription
valuenumber | string
0
Width value.

Returns:

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