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

Table cell.

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()	Cell border settings.
fill()	Fill settings.
Events
disablePointerEvents()	Disable pointer events settings.
Interactivity
selectable()	Text selectable option.
Size and Position
padding()	Padding settings.
Miscellaneous
colSpan()	Cell columns span settings.
content()	Cell content settings.
getBounds()	Returns cell bounds without padding counted (bounds which are used for borders drawing).
getCol()	Returns current cell column instance.
getColNum()	Returns current cell column number.
getRow()	Returns current cell row instance.
getRowNum()	Returns current cell row number.
rowSpan()	Rows columns span settings.

Methods Description

border

border()

Getter for current cell border settings.

Returns:

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

border(strokeOrFill, 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
strokeOrFill	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| function \| null		Fill settings or stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

colSpan

colSpan()

Getter for cell columns span.

Returns:

number - Current columns span.

Try it:

Usage sample

colSpan(value)

Setter for cell columns span.

Detailed description

Note: Cells that are overlapped by other cells are not drawn.

Params:

Name	Type	Default	Description
value	number	1	Count of cells to merge right.

Returns:

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

Try it:

Usage sample

content

content()

Getter for cell content.

Returns:

anychart.core.VisualBase - Current cell content.

content(value)

Setter for cell content.

Params:

Name	Type	Description
value	anychart.core.VisualBase \| string \| number	Value to set.

Returns:

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

Try it:

Usage sample

disablePointerEvents

disablePointerEvents()

Gets current state of disablePointerEvents option.

Returns:

boolean - If pointer events are disabled.

disablePointerEvents(value)

Setter for the text disablePointerEvents option.

Detailed description

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

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

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

fill

fill()

Getter for current cell fill color.

Returns:

anychart.graphics.vector.Fill - Current fill color.

fill(value)

Sets fill settings using an object or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill	null	Color as an object or a string.

Returns:

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

Try it:

fill(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.Cell - Self instance for method chaining.

Try it:

Usage sample

fill(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.Cell - Self instance for method chaining.

Try it:

Usage sample

fill(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.Cell - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)

Image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

fontColor

fontColor()

Getter for the text font color.

Returns:

string - The current font color.

fontColor(value)

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

Params:

Name	Type	Description
value	string	Value to set.

Returns:

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

Try it:

Usage sample

fontDecoration

fontDecoration()

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - The current font decoration.

fontDecoration(value)

Setter for the text font decoration.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.Decoration \| string	anychart.graphics.vector.Text.Decoration#NONE	Value to set.

Returns:

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

Try it:

Usage sample

fontFamily

fontFamily()

Getter for the font family.

Returns:

string - The current font family.

fontFamily(value)

Setter for the font family.

Params:

Name	Type	Description
value	string	Value to set.

Returns:

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

Try it:

Usage sample

fontOpacity

fontOpacity()

Getter for the text font opacity.

Returns:

number - The current font opacity.

fontOpacity(value)

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

Params:

Name	Type	Default	Description
value	number	1	Value to set.

Returns:

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

Try it:

Usage sample

fontStyle

fontStyle()

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - The current font style.

fontStyle(value)

Setter for the text font style.

Params:

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

Returns:

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

Try it:

Usage sample

fontVariant

fontVariant()

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - The current font variant.

fontVariant(value)

Setter for the text font variant.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Text.FontVariant \| string	anychart.graphics.vector.Text.FontVariant#NORMAL	Value to set.

Returns:

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

Try it:

Usage sample

fontWeight

fontWeight()

Getter for the text font weight.

Returns:

string | number - The current font weight.

fontWeight(value)

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

Params:

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

Returns:

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

Try it:

Usage sample

getBounds

getBounds()

Returns cell bounds without padding counted (bounds which are used for borders drawing).

Detailed description

Works only after anychart.core.ui.Table#draw is called.

Returns:

anychart.math.Rect - Current cell bounds.

Try it:

Usage sample

getCol

getCol()

Returns current cell column instance.

Returns:

anychart.core.ui.table.Column - Current cell column instance.

Try it:

Usage sample

getColNum

getColNum()

Returns current cell column number.

Returns:

number - Current cell column number.

Try it:

Usage sample

getRow

getRow()

Returns current cell row instance.

Returns:

anychart.core.ui.table.Row - Current cell row instance.

Try it:

Usage sample

getRowNum

getRowNum()

Returns current cell row number.

Returns:

number - Current cell row number.

Try it:

Usage sample

hAlign

hAlign()

Getter for the text horizontal align.

Returns:

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

hAlign(value)

Setter for the text horizontal align.

Params:

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

Returns:

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

Try it:

Usage sample

letterSpacing

letterSpacing()

Getter for the text letter spacing.

Returns:

string | number - The current letter spacing.

letterSpacing(value)

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

Params:

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

Returns:

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

Try it:

Usage sample

lineHeight

lineHeight()

Getter for the text line height.

Returns:

string | number - The current text line height.

lineHeight(value)

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

Params:

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

Returns:

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

Try it:

Usage sample

padding

padding()

Getter for padding settings.

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.

Try it:

Usage sample

padding(value)

Setter for cell paddings in pixels using a single value.

Params:

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

Returns:

anychart.core.ui.table.Cell - 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));

Try it:

Usage sample

padding(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.Cell - 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);

Try it: