Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 7.14.3 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
format()Sets cell text value formatter.
setColumnFormat()Column format settings.
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:

Name Type Default Description
valueCursor anychart.enums.Cursor | string
"pointer"
Cursor type.

Returns:

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

Try it:

cellTextSettings

Getter for label factory.

Returns:

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

Params:

Name Type Description
value Object Value to set.

Returns:

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

Try it:

cellTextSettingsOverrider

Getter for cells text settings overrider.

Returns:

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

Params:

Name Type Default Description
value function
function(label, dataItem){}
Value to set.

Returns:

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

Try it:

collapseExpandButtons

Getter for expanding or collapse buttons.

Returns:

boolean - Current value.

Try it:

Setter for expanding or collapse buttons.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

defaultWidth

Getter for the current column default width.

Returns:

number - The current default width.

Try it:

Setter for the column default width.

Params:

Name Type Default Description
value number
undefined
Default width value.

Returns:

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

Try it:

depthPaddingMultiplier

Getter for the multiplier to choose a left padding.

Returns:

number - Current value.

Try it:

Setter for the multiplier to choose a left padding.

Params:

Name Type Default Description
value number
15
Value to set.

Returns:

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

Try it:

enabled

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

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

format

Sets cell text value formatter.
Learn more about using format() method.

Params:

Name Type Description
function function Function to format data grid text.

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

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:

setColumnFormat

Sets column format using enum.

Params:

Name Type Description
fieldName string Name of field of data item to work with.
presetValue anychart.enums.ColumnFormats Preset column format.

Returns:

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

Try it:

Sets column format using object.

Params:

Name Type Description
fieldName string Name of field of data item to work with.
settings Object Custom column format.

Returns:

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

Try it:

title

Getter for column title.

Returns:

anychart.core.ui.Title - Title instance for method chaining.

Try it:

Setter for column title.

Params:

Name Type Default Description
value null | 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:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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:

width

Getter for column width.

Returns:

number string - Current column width.

Try it:

Setter for column width.

Params:

Name Type Default Description
value number | string
0
Width value.

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

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: