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. |
| 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.Try it:
Setter for expanding or collapse buttons.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enable/Disable buttons. |
Returns:
anychart.core.ui.DataGrid.Column - Self instance for method chaining.Try it:
defaultWidth
Setter for the column default width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | undefined | Default width value. |
Returns:
anychart.core.ui.DataGrid.Column - Self instance for method chaining.Try it:
depthPaddingMultiplier
Setter for the multiplier to choose a left padding.
Detailed description
Sets multiplier to choose a left padding in a cell depending on a tree data item's depth.
Used to highlight a hierarchy of data items.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| padding | 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 |
|---|---|---|---|
| enabled | boolean | true | Enabled state 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(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:
| 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:
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
Setter for the column title.
Detailed description
Sets column title settings depending on parameter type:
- null/boolean - disable or enable column title.
- string - sets column title text value.
- object - sets column title settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | null | boolean | Object | string | true | Title settings to set. |
Returns:
anychart.core.ui.DataGrid.Column - Self instance for method chaining.width
Setter for the column width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | 0 | Column width to set. |
Returns:
anychart.core.ui.DataGrid.Column - Self instance for method chaining.Try it:
zIndex
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.core.ui.DataGrid.Column - Self instance for method chaining.Try it: