Top
You are looking at an outdated 7.6.0 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

Miscellaneous
cellTextSettings()Getter for label factory.
cellTextSettingsOverrider()Getter for cells text settings overrider.
collapseExpandButtons()Getter for expand or collapse buttons.
defaultWidth()Getter for the current column default width.
depthPaddingMultiplier()Getter for multiplier to choose a left padding.
enabled()Getter for the current element state (enabled or disabled).
setColumnFormat()Sets column format using enum.
textFormatter()Sets cell text value formatter.
title()Getter for column title.
width()Getter for column width.

Methods Description

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 expand or collapse buttons.

Returns:

boolean - Current value.

Try it:

Setter for expand 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 Description
value number Default width value.

Returns:

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

Try it:

depthPaddingMultiplier

Getter for multiplier to choose a left padding.

Returns:

number - Current value.

Try it:

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

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:

textFormatter

Sets cell text value formatter.

Params:

Name Type Default Description
value function
function(dataItem) { return '');}
Function that looks like function( // anychart.data.Tree.DataItem - tree data item){ // this.column 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.

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.

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: