AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.ui.table.Column Improve this Doc

Extends: anychart.core.ui.table.Base

Table column settings container.

Methods Overview

Advanced Text Settings
fontVariant()Text font variant settings.
letterSpacing()Text letter spacing settings.
textDirection()Text direction settings.
textIndent()Text line height settings.
textOverflow()Text overflow settings.
textWrap()Text wrap settings.
useHtml()Text useHtml settings.
Base Text Settings
fontColor()Text font color settings.
fontDecoration()Text font decoration settings.
fontFamily()Text font family settings.
fontOpacity()Text font opacity settings.
fontSize()Text font size settings.
fontStyle()Text font style settings.
fontWeight()Text font weight settings.
hAlign()Text horizontal align settings.
lineHeight()Text line height settings.
vAlign()Text vertical align settings.
Coloring
border()Border settings.
cellBorder()Cell border settings.
cellFill()Cell fill settings.
Events
disablePointerEvents()Disable pointer events settings.
Interactivity
selectable()Text selectable option.
Size and Position
cellPadding()Cell padding settings.
maxWidth()Column maximum width settings.
minWidth()Column minimum width settings.
width()Column width settings.
Miscellaneous
getCell()Returns cell of current column by row index.
getColNum()Returns column index.

Methods Description

border

Getter for border settings object.

Returns:

anychart.core.ui.table.Border - Current border settings.
Setter for cell border settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

cellBorder

Getter for border settings object.

Returns:

anychart.core.ui.table.Border - Current border settings.
Setter for cell border settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

cellFill

Getter for current fill color override.

Returns:

anychart.graphics.vector.Fill - Current fill color.
Sets fill settings using an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Fill
undefined
Color as an object or a string.

Returns:

anychart.core.ui.table.Column - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.table.Column - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.ui.table.Column - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

cellPadding

Setter for current cell paddings in pixels using a single value.

Params:

NameTypeDescription
valuenull | Array.<(number|string)> | ObjectValue to set.

Returns:

anychart.core.ui.table.Column - Self instance for method chaining.
Examples for paddings
// all paddings 15px
cell.padding(15);
// all paddings 15px
cell.padding('15px');
// top and bottom 5px ,right and left 15px
cell.padding(anychart.utils.padding(5,15));
Setter for current cell paddings in pixels using several numbers.

Params:

NameTypeDescription
value1string | numberTop or top-bottom space.
value2string | numberRight or right-left space.
value3string | numberBottom space.
value4string | numberLeft space.

Returns:

anychart.core.ui.table.Column - Self instance for method chaining.
Examples for paddings
// 1) top and bottom 10px, left and right 15px
table.cellPadding(10, '15px');
// 2) top 10px, left and right 15px, bottom 5px
table.cellPadding(10, '15px', 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
table.cellPadding(10, '15px', '5px', 12);

disablePointerEvents

Gets current state of disablePointerEvents option.

Returns:

boolean - If pointer events are disabled.
Setter for the text disablePointerEvents option.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

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

fontColor

Getter for the text font color.

Returns:

string - The current font color.
Setter for the text font color. https://www.w3schools.com/html/html_colors.asp

Params:

NameTypeDescription
valuestringValue to set.

Returns:

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

fontDecoration

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - The current font decoration.
Setter for the text font decoration.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.Decoration | string
anychart.graphics.vector.Text.Decoration#NONE
Value to set.

Returns:

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

fontFamily

Getter for the font family.

Returns:

string - The current font family.
Setter for the font family.

Params:

NameTypeDescription
valuestringValue to set.

Returns:

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

fontOpacity

Getter for the text font opacity.

Returns:

number - The current font opacity.
Setter for the text font opacity. Double value from 0 to 1.

Params:

NameTypeDefaultDescription
valuenumber
1
Value to set.

Returns:

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

fontSize

Getter for text font size.

Returns:

string | number - Current font size.
Setter for text font size.

Params:

NameTypeDescription
valuestring | numberValue to set.

Returns:

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

fontStyle

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - The current font style.
Setter for the text font style.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.FontStyle | string
anychart.graphics.vector.Text.FontStyle#NORMAL
Value to set.

Returns:

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

fontVariant

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - The current font variant.
Setter for the text font variant.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.FontVariant | string
anychart.graphics.vector.Text.FontVariant#NORMAL
Value to set.

Returns:

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

fontWeight

Getter for the text font weight.

Returns:

string | number - The current font weight.

Params:

NameTypeDescription
valuestring | numberValue to set.

Returns:

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

getCell

Returns cell of current column by row index.

Params:

NameTypeDescription
rownumberRow index.

Returns:

anychart.core.ui.table.Cell - Cell instance.

getColNum

Returns column index.

Returns:

number - Current column index.

hAlign

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - The current text horizontal align.
Setter for the text horizontal align.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.HAlign | string
anychart.graphics.vector.Text.HAlign#START
Value to set.

Returns:

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

letterSpacing

Getter for the text letter spacing.

Returns:

string | number - The current letter spacing.

Params:

NameTypeDescription
valuestring | numberValue to set.

Returns:

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

lineHeight

Getter for the text line height.

Returns:

string | number - The current text line height.

Params:

NameTypeDescription
valuestring | numberValue to set.

Returns:

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

maxWidth

Getter for column maximum width settings.

Returns:

string | number | null - Current column maximum width.
Getter and setter for column max width settings.

Params:

NameTypeDefaultDescription
valuestring | number | null
null
Value to set.

Returns:

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

minWidth

Getter for column minimum width settings.

Returns:

string | number | null - Current column minimum width.
Setter for column minimum width settings.

Params:

NameTypeDefaultDescription
valuestring | number | null
null
Value to set.

Returns:

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

selectable

Getter for the text selectable option.

Returns:

boolean - The current text selectable option.
Setter for the text selectable.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

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

textDirection

Getter for the text direction.

Returns:

anychart.graphics.vector.Text.Direction | string - Current text direction.
Setter for the text direction.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.Direction | string
anychart.graphics.vector.Text.Direction#LTR
Value to set.

Returns:

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

textIndent

Getter for the text indent.

Returns:

number - The current text indent.
Setter for the text indent.

Params:

NameTypeDescription
valuenumberValue to set.

Returns:

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

textOverflow

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - The current text overflow settings.
Setter for the text overflow settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.TextOverflow | string
anychart.graphics.vector.Text.TextOverflow#CLIP
Value to set.

Returns:

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

textWrap

Getter for the text wrap settings.

Returns:

anychart.graphics.vector.Text.TextWrap | string - The current text wrap settings.
Setter for the text wrap settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.TextWrap | string
anychart.graphics.vector.Text.TextWrap#BY_LETTER
Value to set.

Returns:

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

useHtml

Getter for the useHtml flag.

Returns:

boolean - The current value of useHTML flag.
Setter for flag useHtml.

Params:

NameTypeDefaultDescription
valueboolean
false
Value to set.

Returns:

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

vAlign

Getter for the text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - The current text vertical align.
Setter for the text vertical align.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Text.VAlign | string
anychart.graphics.vector.Text.VAlign#TOP
Value to set.

Returns:

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

width

Getter for column width settings.

Returns:

string | number | null - Current column width.
Setter for column width settings.

Params:

NameTypeDefaultDescription
valuestring | number | null
null
Value to set.

Returns:

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