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

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.
useHtml()	Text useHtml settings.
wordBreak()	Word break mode.
wordWrap()	Word-wrap mode.
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 column by row index.
getColNum()	Gets column index.

Methods Description

border

border()

Getter for border settings object.

Returns:

anychart.core.ui.table.Border - Border settings.

border(color, thickness, dashpattern, lineJoin, lineCap)

Setter for cell border settings. Learn more about stroke settings.

Detailed description

Note: Pass null to reset to default settings.
Note: lineJoin settings not working here.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| function \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

cellBorder

cellBorder()

Getter for border settings object.

Returns:

anychart.core.ui.table.Border - Border settings.

cellBorder(color, thickness, dashpattern, lineJoin, lineCap)

Setter for cell border settings. Learn more about stroke settings.

Detailed description

Note: Pass null to reset to default settings.
Note: lineJoin settings not working here.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| function \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

cellFill

cellFill()

Getter for fill color override.

Returns:

anychart.graphics.vector.Fill - Fill color.

cellFill(color)

Setter for fill settings using an object, an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	undefined	Color as an object, an array or a string.

Returns:

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

Try it:

cellFill(color, opacity)

Fill color with opacity. Fill as a string or an object.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

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

Try it:

Usage sample

cellFill(keys, angle, mode, opacity)

Linear gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

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

Try it:

Usage sample

cellFill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

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

Try it:

Usage sample

cellFill(imageSettings)

Image fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

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

Try it:

Usage sample

cellPadding

cellPadding()

Getter for padding settings object.

Detailed description

Also, you can use anychart.core.ui.table.Padding#bottom, anychart.core.ui.table.Padding#left, anychart.core.ui.table.Padding#right, anychart.core.ui.table.Padding#top methods to setting paddings.

Returns:

anychart.core.ui.table.Padding - Padding settings object.

Try it:

Usage sample

cellPadding(padding)

Setter for cell paddings in pixels using a single value.

Params:

Name	Type	Description
padding	null \| Array.<(number\|string)> \| Object	Cell padding to set.

Returns:

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

Examples for paddings

// all paddings 15px
column.cellPadding(15);
// all paddings 15px
column.cellPadding('15px');
// top and bottom 5px ,right and left 15px
column.cellPadding(anychart.utils.padding(5,15));

Try it:

Usage sample

cellPadding(value1, value2, value3, value4)

Setter for cell paddings in pixels using several numbers.

Params:

Name	Type	Description
value1	string \| number	Top or top-bottom space.
value2	string \| number	Right or right-left space.
value3	string \| number	Bottom space.
value4	string \| number	Left space.

Returns:

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

Examples for paddings

// 1) top and bottom 10px, left and right 15px
column.cellPadding(10, '15px');
// 2) top 10px, left and right 15px, bottom 5px
column.cellPadding(10, '15px', 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
column.cellPadding(10, '15px', '5px', 12);

Try it:

Usage sample

disablePointerEvents

disablePointerEvents()

Getter for the state of disablePointerEvents option.

Returns:

boolean - If pointer events are disabled.

disablePointerEvents(enabled)

Setter for the text disablePointerEvents option.

Detailed description

This options defines whether the text should pass mouse events through.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

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

fontColor

fontColor()

Getter for the text font color.

Returns:

string - Font color.

fontColor(color)

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

Params:

Name	Type	Description
color	string	Font color to set.

Returns:

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

Try it:

Usage sample

fontDecoration

fontDecoration()

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - Font decoration.

fontDecoration(type)

Setter for the text font decoration.

Params:

Name	Type	Default	Description
type	anychart.graphics.vector.Text.Decoration \| string	anychart.graphics.vector.Text.Decoration#NONE	Font decoration to set.

Returns:

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

Try it:

Usage sample

fontFamily

fontFamily()

Getter for the font family.

Returns:

string - Font family.

fontFamily(family)

Setter for the font family.

Params:

Name	Type	Description
family	string	Font family to set.

Returns:

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

Try it:

Usage sample

fontOpacity

fontOpacity()

Getter for the text font opacity.

Returns:

number - Font opacity.

fontOpacity(opacity)

Setter for the text font opacity. Double value from 0 to 1.

Params:

Name	Type	Default	Description
opacity	number	1	Font opacity to set.

Returns:

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

Try it:

Usage sample

Name	Type	Description
size	string \| number	Font size to set.

fontStyle

fontStyle()

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - Font style.

fontStyle(style)

Setter for the text font style.

Params:

Name	Type	Default	Description
style	anychart.graphics.vector.Text.FontStyle \| string	anychart.graphics.vector.Text.FontStyle#NORMAL	Font style to set.

Returns:

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

Try it:

Usage sample

fontVariant

fontVariant()

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - Font variant.

fontVariant(type)

Setter for the text font variant.

Params:

Name	Type	Default	Description
type	anychart.graphics.vector.Text.FontVariant \| string	anychart.graphics.vector.Text.FontVariant#NORMAL	Font variant to set.

Returns:

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

Try it:

Usage sample

fontWeight

fontWeight()

Getter for the text font weight.

Returns:

string | number - Font weight.

fontWeight(weight)

Setter for the text font weight. https://www.w3schools.com/cssref/pr_font_weight.asp

Params:

Name	Type	Description
weight	string \| number	Value to set.

Returns:

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

Try it:

Usage sample

getCell

getCell(row)

Returns cell of column by row index.

Params:

Name	Type	Description
row	number	Row index.

Returns:

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

Try it:

Usage sample

getColNum

getColNum()

Gets column index.

Returns:

number - Returns column index.

Try it:

Usage sample

hAlign

hAlign()

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - Text horizontal align.

hAlign(align)

Setter for the text horizontal align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.HAlign \| string	anychart.graphics.vector.Text.HAlign#START	Horizontal align to set.

Returns:

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

Try it:

Usage sample

letterSpacing

letterSpacing()

Getter for the text letter spacing.

Returns:

string | number - The letter spacing.

letterSpacing(spacing)

Setter for the text letter spacing. https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

Params:

Name	Type	Description
spacing	string \| number	Letter spacing to set.

Returns:

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

Try it:

Usage sample

lineHeight

lineHeight()

Getter for the text line height.

Returns:

string | number - Text line height.

lineHeight(height)

Setter for the text line height. https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

Params:

Name	Type	Description
height	string \| number	Line height to set.

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for column maximum width settings.

Returns:

string | number | null - Column maximum width.

maxWidth(width)

Setter for column maximum width settings.

Detailed description

Note: Pass null to set the default value.

Params:

Name	Type	Default	Description
width	string \| number	null	Maximum width to set.

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for column minimum width settings.

Returns:

string | number | null - Column minimum width.

minWidth(width)

Setter for column minimum width settings.

Detailed description

Note: Pass null to set the default value. The method sets a minimum width of a column, that will be to remain after a resize of table.

Params:

Name	Type	Default	Description
width	string \| number \| null	null	Minimum width to set.

Returns:

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

Try it:

Usage sample

selectable

selectable()

Getter for the text selectable option.

Returns:

boolean - Text selectable option.

selectable(enabled)

Setter for the text selectable.

Detailed description

This options defines whether the text can be selected. If set to false one can't select the text.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

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

Try it:

Usage sample

textDirection

textDirection()

Getter for the text direction.

Returns:

anychart.graphics.vector.Text.Direction | string - Text direction.

textDirection(type)

Setter for the text direction.

Params:

Name	Type	Default	Description
type	anychart.graphics.vector.Text.Direction \| string	anychart.graphics.vector.Text.Direction#LTR	Text direction to set.

Returns:

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

Try it:

Usage sample

textIndent

textIndent()

Getter for the text indent.

Returns:

number - Text indent.

textIndent(indent)

Setter for the text indent.

Params:

Name	Type	Description
indent	number	Text indent to set.

Returns:

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

Try it:

Usage sample

textOverflow

textOverflow()

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.

textOverflow(value)

Setter for the text overflow settings.

Params:

Name	Type	Default	Description
value	anychart.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.

Try it:

Usage sample

useHtml

useHtml()

Getter for the useHtml flag.

Returns:

boolean - Value of useHTML flag.

useHtml(enabled)

Setter for flag useHtml.

Detailed description

This property defines whether HTML text should be parsed.

Params:

Name	Type	Default	Description
enabled	boolean	false	Value to set.

Returns:

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

Try it:

Usage sample

vAlign

vAlign()

Getter for the text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - Text vertical align.

vAlign(align)

Setter for the text vertical align.

Params:

Name	Type	Default	Description
align	anychart.graphics.vector.Text.VAlign \| string	anychart.graphics.vector.Text.VAlign#TOP	Vertical align to set.

Returns:

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

Try it:

Usage sample

width

width()

Getter for column width settings.

Returns:

string | number | null - Column width.

width(width)

Setter for column width settings.

Detailed description

Note: Pass null to set the default value.

Params:

Name	Type	Default	Description
width	string \| number	null	Column width to set.

Returns:

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

Try it:

Usage sample

wordBreak

wordBreak()Since version 8.0.0

Getter for the word-break mode.

Returns:

anychart.enums.WordBreak | string - Word-break mode.

See listing

var wordBreak = cell.wordBreak();

wordBreak(mode)Since version 8.0.0

Setter for the word-break mode.

Params:

Name	Type	Default	Description
mode	anychart.enums.WordBreak \| string	'normal'	Value to set.

Returns:

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

Try it:

Usage sample

wordWrap

wordWrap()Since version 8.0.0

Getter for the word-wrap mode.

Returns:

anychart.enums.WordWrap | string - Word-wrap mode.

See listing

var wordWrap = cell.wordWrap();

wordWrap(mode)Since version 8.0.0

Setter for the word-wrap mode.

Params:

Name	Type	Default	Description
mode	anychart.enums.WordWrap \| string	'break-word'	Value to set.

Returns:

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

Try it:

Usage sample

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

Methods Overview

Methods Description

border

cellBorder

cellFill

cellPadding

disablePointerEvents

fontColor

fontDecoration

fontFamily

fontOpacity

fontSize

fontStyle

fontVariant

fontWeight

getCell

getColNum

hAlign

letterSpacing

lineHeight

maxWidth

minWidth

selectable

textDirection

textIndent

textOverflow

useHtml

vAlign

width

wordBreak

wordWrap