AnyChart
API Reference
Still have questions?
Contact support
    Top
    You are looking at an outdated v7 version of this document. Switch to the v8 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

    buttonCursor()Since version 7.12.0

    Getter for the button cursor.

    Returns:

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

    buttonCursor(valueCursor)Since version 7.12.0

    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.

    Try it:

    cellTextSettings

    cellTextSettings()

    Getter for label factory.

    Returns:

    anychart.core.ui.LabelsFactory - Label factory instance for method chaining.

    cellTextSettings(value)

    Setter for label factory to decorate cells.

    Params:

    NameTypeDescription
    valueObjectValue to set.

    Returns:

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

    Try it:

    cellTextSettingsOverrider

    cellTextSettingsOverrider()

    Getter for cells text settings overrider.

    Returns:

    function - Current cells text settings overrider.

    cellTextSettingsOverrider(value)

    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.

    Try it:

    collapseExpandButtons

    collapseExpandButtons()

    Getter for expanding or collapse buttons.

    Returns:

    boolean - Current value.

    Try it:

    collapseExpandButtons(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.

    Try it:

    defaultWidth

    defaultWidth()Since version 7.6.0

    Getter for the current column default width.

    Returns:

    number - The current default width.

    Try it:

    defaultWidth(value)Since version 7.6.0

    Setter for the column default width.

    Params:

    NameTypeDefaultDescription
    valuenumber
    undefined
    		 Default width value.

    Returns:

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

    Try it:

    depthPaddingMultiplier

    depthPaddingMultiplier()

    Getter for the multiplier to choose a left padding.

    Returns:

    number - Current value.

    Try it:

    depthPaddingMultiplier(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.

    Try it:

    enabled

    enabled()

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

    Returns:

    boolean - The current element state.

    Try it:

    enabled(value)

    Setter for the element enabled state.

    Params:

    NameTypeDefaultDescription
    valueboolean
    true
    		 Value to set.

    Returns:

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

    Try it:

    format

    format(function)

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

    Params:

    NameTypeDescription
    functionfunctionFunction to format data grid text.

    Returns:

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

    Try it:

    listen

    listen(type, listener, useCapture, listenerScope)

    Adds an event listener to an implementing object.

    Params:

    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		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.
    Try it:
    listenOnce
    listenOnce(type, listener, useCapture, listenerScope)
    Adds an event listener to an implementing object.
    Params:
    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		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.
    Try it:
    print
    print(paperSizeOrOptions, landscape)
    Prints all elements on related stage.
    Params:
    NameTypeDefaultDescription
    paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
    		Paper size or object with options.
    landscapeboolean
    false
    		 Flag of landscape.
    Try it:
    removeAllListeners
    removeAllListeners(type)
    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.
    Try it:
    setColumnFormat
    setColumnFormat(fieldName, presetValue)Since version 7.6.0
    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.
    Try it:
    setColumnFormat(fieldName, settings)Since version 7.6.0
    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.
    Try it:
    title
    title()
    Getter for column title.
    Returns:
    anychart.core.ui.Title - Title instance for method chaining.
    Try it:
    title(value)
    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.
    Try it:
    unlisten
    unlisten(type, listener, useCapture, listenerScope)
    Removes a listener added using listen() or listenOnce() methods.
    Params:
    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		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.
    Try it:
    unlistenByKey
    unlistenByKey(key)
    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.
    Try it:
    width
    width()
    Getter for column width.
    Returns:
    number | string - Current column width.
    Try it:
    width(value)
    Setter for column width.
    Params:
    NameTypeDefaultDescription
    valuenumber | string
    0
    		 Width value.
    Returns:
    anychart.core.ui.DataGrid.Column - Self instance for method chaining.
    Try it:
    zIndex
    zIndex()
    Getter for the current Z-index of the element.
    Returns:
    number - The current zIndex.
    Try it:
    zIndex(value)
    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.
    Try it: