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

Base class for Row, Column and Cell. Contains text settings and lazy settings object initialization. Also knows about table, so it can send messages to the table.

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.
textShadow()	Text font color settings.
vAlign()	Text vertical align settings.
Coloring
border()	Border settings.
Events
disablePointerEvents()	Disable pointer events settings.
Interactivity
selectable()	Text selectable option.

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.Base - Self instance for method chaining.

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.Base - 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.Base - 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.Base - 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.Base - 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.Base - 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.Base - 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.Base - 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.Base - Self instance for method chaining.

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.Base - 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.Base - 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.Base - 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.Base - 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.Base - 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.Base - 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.Base - Self instance for method chaining.

Try it:

Usage sample

textShadow

textShadow()

Getter for the text font color.

Returns:

string - String representation of text shadow.

textShadow(textShadow)

Setter for the text shadow.

Params:

Name	Type	Default	Description
textShadow	anychart.graphics.vector.TextShadow \| string	'none'	Text shadow to set.

Returns:

anychart.core.ui.table.Base - 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.Base - 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.Base - 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.Base - 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.Base - Self instance for method chaining.

Try it:

Usage sample

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

Methods Overview

Methods Description

border

disablePointerEvents

fontColor

fontDecoration

fontFamily

fontOpacity

fontSize

fontStyle

fontVariant

fontWeight

hAlign

letterSpacing

lineHeight

selectable

textDirection

textIndent

textOverflow

textShadow

useHtml

vAlign

wordBreak

wordWrap