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 - 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 column default width.

Returns:

number - 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 - 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 element state (enabled or disabled).

Returns:

boolean - 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:

labels

Getter for labels settings of a column.

Returns:

anychart.core.ui.LabelsFactory - Labels settings.

Try it:

labelsOverrider

Getter for the labels overrider.

Returns:

function - Cells text settings overrider.
See listing
var column = dataGrid.column(1);
var labelsOverrider = column.labelsOverrider();
Setter for the labels overrider.

Params:

Name Type Default Description
overriderFunction function(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.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(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
}
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
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 Default Description
type string
The event type id.
listener function(e:Object)
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
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 | string 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 the column title.

Returns:

anychart.core.ui.Title - Title instance.

Try it:

Setter for the 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 Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
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 the column width.

Returns:

number string - Current column width.

Try it:

Setter for the 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 Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it: