AnyChart
API Reference
Still have questions?
Contact support
Top

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
labels()Labels settings.
setColumnFormat()Column format settings.
Advanced Text Settings
labelsOverrider()labels 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
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

collapseExpandButtons

Getter for expanding or collapse buttons.

Returns:

boolean - Collapse or expand buttons.
Setter for expanding or collapse buttons.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enable/Disable buttons.

Returns:

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

defaultWidth

Getter for the column default width.

Returns:

number - Default width.
Setter for the column default width.

Params:

NameTypeDefaultDescription
widthnumber
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 - Value.
Setter for the multiplier to choose a left padding.

Params:

NameTypeDefaultDescription
paddingnumber
15
Value to set.

Returns:

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

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

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

labels

Getter for labels settings of a column.

Returns:

anychart.core.ui.LabelsFactory - Labels settings.

labelsOverrider

Getter for the labels overrider.

Returns:

function(label:anychart.core.ui.LabelsFactory.Label, item:anychart.data.Tree.DataItem) - Cells text settings overrider.
See listing
var column = dataGrid.column(1);
var labelsOverrider = column.labelsOverrider();
Setter for the labels overrider.

Params:

NameTypeDefaultDescription
overriderFunctionfunction(label:anychart.core.ui.LabelsFactory.Label, item:anychart.data.Tree.DataItem)
function(label, dataItem){}
Text settings overrider function.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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(e:Object)
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.

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.ColumnFormats | stringPreset 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.

title

Getter for the column title.

Returns:

anychart.core.ui.Title - Title instance.
Setter for the column title.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
true
Title settings to set.

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
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.

width

Getter for the column width.

Returns:

number | string - Column width.
Setter for the column width.

Params:

NameTypeDefaultDescription
widthnumber | string
0
Column width to set.

Returns:

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

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

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