class anychart.core.ui.Table Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Declares table element.
Note: Better to use methods in anychart.ui#table.

Methods Overview

Specific settings
colsCount()	Columns count.
colsMaxWidth()	Column maximum width.
colsMinWidth()	Column minimum width.
colsWidth()	Column width.
contents()	Table content.
getCell()	Returns cell by its row and column number.
getCol()	Returns column instance by its number.
getRow()	Returns row instance by its number.
rowsCount()	Rows count.
rowsHeight()	Row height.
rowsMaxHeight()	Rows maximum height.
rowsMinHeight()	Rows minimum height.
Advanced Text Settings
fontVariant()	Font variant settings.
letterSpacing()	Letter spacing settings.
lineHeight()	Line height settings.
textIndent()	Text indent settings.
textOverflow()	Text overflow settings.
useHtml()	Text useHtml settings.
wordBreak()	Word break mode.
wordWrap()	Word-wrap mode.
Base Text Settings
fontColor()	Font color settings.
fontDecoration()	Font decoration settings.
fontFamily()	Font family settings.
fontOpacity()	Font opacity settings.
fontSize()	Font size settings.
fontStyle()	Font style settings.
fontWeight()	Font weight settings.
hAlign()	Horizontal align settings.
textDirection()	Text direction settings.
textShadow()	Text shadow settings.
vAlign()	Vertical align settings.
Coloring
border()	Border settings.
cellBorder()	Cell border settings.
cellFill()	Cell fill settings.
rowEvenFill()	Row even fill settings.
rowOddFill()	Row odd fill settings.
Events
disablePointerEvents()	Disable pointer events settings.
listen()	Adds an event listener
listenOnce()	Adds a single time event listener
removeAllListeners()	Removes all listeners
unlisten()	Removes the listener
unlistenByKey()	Removes the listener by the key
Export
exports()	Exports settings
print()	Prints all elements.
saveAsCsv()	Saves the table as a CSV file.
saveAsJpg()	Saves into JPEG file.
saveAsPdf()	Saves into PDF file.
saveAsPng()	Saves into PNG file.
saveAsSvg()	Saves into SVG file.
shareWithFacebook()	Opens Facebook sharing dialog.
shareWithLinkedIn()	Opens LinkedIn sharing dialog.
shareWithPinterest()	Opens Pinterest sharing dialog.
shareWithTwitter()	Opens Twitter sharing dialog.
toSvg()	Returns SVG string.
Interactivity
enabled()	Element state (enabled or disabled).
selectable()	Text selectable option.
Size and Position
bottom()	Bottom bound settings.
bounds()	Bounds settings.
cellPadding()	Cell padding settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
left()	Left bound settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound settings.
top()	Top bound settings.
width()	Width settings.
zIndex()	Z-index of the element.
Table Controls
contextMenu()	Context menu settings.
Miscellaneous
container()	Container for the elements.
dispose()	Disposes table.
draw()	Draws the table.
fullScreen()	Fullscreen mode.
getJpgBase64String()	Returns JPG as base64 string.
getPdfBase64String()	Returns PDF as base64 string.
getPngBase64String()	Returns PNG as base64 string.
getSvgBase64String()	Returns SVG as base64 string.
isFullScreenAvailable()	Whether the full screen mode available in the browser or not.
parentBounds()	Getter for the parent bounds.
saveAsXlsx()	Saves table data as an Excel document.
shareAsJpg()	Shares a table as a JPG file and returns a link to the shared image.
shareAsPdf()	Shares a table as a PDF file and returns a link to the shared image.
shareAsPng()	Shares a table as a PNG file and returns a link to the shared image.
shareAsSvg()	Shares a table as a SVG file and returns a link to the shared image.
toCsv()	Returns CSV string with series data.

Methods Description

border

border()

Getter for border of the table (not cells).

Returns:

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

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

Setter for border of the table (not cells).

Detailed description

Overrides this.cellBorder() settings for the borders that are on the border of the table.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| 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 - Self instance for method chaining.

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.

bottom(bottom)

Setter for element bottom bound settings.

Params:

Name	Type	Default	Description
bottom	number \| string \| null	null	Bottom bound settings for the element.

Returns:

anychart.core.ui.Table - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.

bounds(bounds)

Setter for bounds of the element using one parameter.

Params:

Name	Type	Description
bounds	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

bounds(x, y, width, height)

Setter for element bounds settings.

Params:

Name	Type	Default	Description
x	number \| string	null	X-coordinate.
y	number \| string	null	Y-coordinate.
width	number \| string	null	Width.
height	number \| string	null	Height.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

cellBorder

cellBorder()

Getter for cell border settings.

Returns:

anychart.core.ui.table.Border - Cell border stroke.

See listing

var cellBorder = table.cellBorder();

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

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

Detailed description

Note: The last usage of leftBorder(), rightBorder(), topBorder() and bottomBorder() methods determines the border for the corresponding side.
Note: lineJoin settings not working here.

Params:

Name	Type	Default	Description
colorSettings	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 - Self instance for method chaining.

Try it:

Usage sample

cellFill

cellFill()

Getter for the table fill color.

Returns:

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

See listing

var cellFill = table.cellFill();

cellFill(color)

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

Params:

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

Returns:

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

Try it:

Usage sample

cellPadding

cellPadding()

Getter for cell 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 - Cell padding settings.

Try it:

Usage sample

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

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 - 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:

Usage sample

colsCount

colsCount()

Getter for table columns count.

Returns:

number - Columns count.

Try it:

Usage sample

colsCount(count)

Setter for table columns count.

Detailed description

Note: Calculated from the contents if not defined explicitly.

Params:

Name	Type	Default	Description
count	number	4	Columns count to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

colsMaxWidth

colsMaxWidth()

Getter for the column width maximum.

Returns:

string | number | null - Column width maximum.

See listing

var colsMaxWidth = table.colsMaxWidth();

colsMaxWidth(width)

Setter for the column width maximum.

Detailed description

Defaults to null - no maximum width.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

colsMinWidth

colsMinWidth()

Getter for column width minimum.

Returns:

string | number | null - Column width minimum.

See listing

var colsMinWidth = table.colsMinWidth();

colsMinWidth(width)

Setter for column width minimum.

Detailed description

Defaults to null - no minimum width. The method sets a minimum width of columns, that will be to remain after a resize of table.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

colsWidth

colsWidth()

Getter for the column width.

Returns:

string | number | null - Column width.

See listing

var colsWidth = table.colsWidth();

colsWidth(width)

Setter for the column width.

Detailed description

Defaults to null - divide the rest of table width between columns with null width evenly.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

container

container()

Getter for the container.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - An instance of the class for method chaining.

container(element)

Setter for the container.

Params:

Name	Type	Description
element	anychart.graphics.vector.Layer \| anychart.graphics.vector.Stage \| string \| Element	The value to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

contents()

Getter for the table content. Note: Returns cells content ignored rowSpan and colSpan.

Returns:

Array.<Array.<(anychart.core.VisualBase)>> - Table content.

See listing

var contents = table.contents();

contents(tableValues, demergeCells)

Setter for the table content.

Detailed description

Note: Pass null to drop table content.

Params:

Name	Type	Default	Description
tableValues	Array.<Array.<(anychart.core.VisualBase\|string\|number\|undefined)>>		Values to set.
demergeCells	boolean	false	Pass true to demerge all cells.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

contextMenu

contextMenu()Since version 8.4.0

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.

Try it:

Usage sample

contextMenu(settings)Since version 8.4.0

Setter for the context menu.

Detailed description

Sets context menu settings depending on parameter type:

null/boolean - disable or enable context menu.
object - sets context menu settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Context menu settings

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

disablePointerEvents

disablePointerEvents()

Getter for the state of disablePointerEvents option.

Returns:

boolean - If pointer events are disabled.

See listing

var disablePointerEvents = table.disablePointerEvents();

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	DisablePointerEvents option to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

dispose

dispose()

Disposes table.
Removes it from parent layer, nulls links, removes from DOM.

draw

draw()

Draws the table.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

exports

exports()Since version 8.4.0

Getter for the export table.

Returns:

anychart.core.utils.Exports - Exports settings.

See listing

var exports = table.exports();

exports(settings)Since version 8.4.0

Setter for the export table.

Detailed description

To work with exports you need to reference the exports module from AnyChart CDN (https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for latest or https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for the versioned file)

Params:

Name	Type	Description
settings	Object	Export settings.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

fontColor

fontColor()

Getter for the text font color.

Returns:

string - Font color.

See listing

var fontColor = table.fontColor();

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 - 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.

See listing

var fontDecoration = table.fontDecoration();

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	Font decoration to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

fontFamily

fontFamily()

Getter for the font family.

Returns:

string - Font family.

fontFamily(family)

Setter for font family.

Params:

Name	Type	Description
family	string	Font family to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

fontOpacity

fontOpacity()

Getter for the text font opacity.

Returns:

number - Font opacity.

See listing

var fontOpacity = table.fontOpacity();

fontOpacity(opacity)

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

Params:

Name	Type	Description
opacity	number	Font opacity to set.

Returns:

anychart.core.ui.Table - 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.

See listing

var fontStyle = table.fontStyle();

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 - 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.

See listing

var fontVariant = table.fontVariant();

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	Font variant to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

fontWeight

fontWeight()

Getter for the text font weight.

Returns:

string | number - Font weight.

See listing

var fontWeight = table.fontWeight();

fontWeight(weight)

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

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

fullScreen

fullScreen()Since version 8.4.0

Getter for the fullscreen mode.

Returns:

boolean - Full screen state (enabled/disabled).

See listing

var fullScreen = table.fullScreen();

fullScreen(enabled)Since version 8.4.0

Setter for the fullscreen mode.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enable/Disable fullscreen mode.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

getCell

getCell(row, col)

Returns cell by its row and column number.

Params:

Name	Type	Description
row	number	Row index.
col	number	Column index.

Returns:

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

Try it:

Usage sample

getCol

getCol(col)

Returns column instance by its number.

Detailed description

Returns null if there is no column with passed number.

Params:

Name	Type	Description
col	number	A column by number

Returns:

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

Try it:

Usage sample

getJpgBase64String

getJpgBase64String(onSuccess, onError, width, height, quality, forceTransparentWhite)Since version 7.11.1

Returns JPG as base64 string.

Params:

Name	Type	Description
onSuccess	function(response:string)	Function that is called when sharing is complete.
onError	function(response:string)	Function that is called if sharing fails.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
forceTransparentWhite	boolean	Force transparent to white or not.

Try it:

Usage sample

getPdfBase64String

getPdfBase64String(onSuccess, onError, paperSizeOrWidth, landscapeOrWidth, x, y)Since version 7.11.1

Returns PDF as base64 string.

Params:

Name	Type	Description
onSuccess	function(response:string)	Function that is called when sharing is complete.
onError	function(response:string)	Function that is called if sharing fails.
paperSizeOrWidth	number \| string	Any paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidth	number \| boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.

Try it:

Usage sample

getPixelBounds

getPixelBounds()

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

getPngBase64String

getPngBase64String(onSuccess, onError, width, height, quality)Since version 7.11.1

Returns PNG as base64 string.

Params:

Name	Type	Description
onSuccess	function(response:string)	Function that is called when sharing is complete.
onError	function(response:string)	Function that is called if sharing fails.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.

Try it:

Usage sample

getRow

getRow(row)

Returns row instance by its number.

Detailed description

Returns null if there is no row with passed number.

Params:

Name	Type	Description
row	number	A row by number.

Returns:

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

Try it:

Usage sample

getSvgBase64String

getSvgBase64String(onSuccess, onError, paperSizeOrWidth, landscapeOrHeight)Since version 7.11.1

Returns SVG as base64 string.

Params:

Name	Type	Description
onSuccess	function(response:string)	Function that is called when sharing is complete.
onError	function(response:string)	Function that is called if sharing fails.
paperSizeOrWidth	string \| number	Paper Size or width.
landscapeOrHeight	boolean \| string	Landscape or height.

Try it:

Usage sample

hAlign

hAlign()

Getter for the text horizontal align.

Returns:

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

See listing

var hAlign = table.hAlign();

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

Try it:

Usage sample

height

height()

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.

height(height)

Setter for element height setting.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Height settings for the element.

Returns:

anychart.core.ui.Table - Returns self for method chaining.

Try it:

Usage sample

isFullScreenAvailable

isFullScreenAvailable()Since version 8.4.0

Whether the full screen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

Try it:

Usage sample

left

left()

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.

left(left)

Setter for element left bound settings.

Params:

Name	Type	Default	Description
left	number \| string \| null	null	Left bound setting for the element.

Returns:

anychart.core.ui.Table - Returns self for method chaining.

Try it:

Usage sample

letterSpacing

letterSpacing()

Getter for the text letter spacing.

Returns:

string | number - Letter spacing.

See listing

var letterSpacing = table.letterSpacing();

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

Try it:

Usage sample

lineHeight

lineHeight()

Getter for the text line height.

Returns:

string | number - Text line height.

See listing

var lineHeight = table.lineHeight();

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

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method. Function that looks like: function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.

maxHeight(height)

Setter for the maximum height.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.

maxWidth(width)

Setter for the maximum width.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

minHeight

minHeight()

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.

minHeight(height)

Setter for the minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

minWidth

minWidth()

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.

minWidth(width)

Setter for the minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

parentBounds

parentBounds()

Getter for the parent bounds.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Returns:

anychart.math.Rect - The parent bounds of the element.

parentBounds(bounds)

Setter for the parent bounds using single value.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

Name	Type	Description
bounds	anychart.math.Rect \| Object \| number \| null	Bounds to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

parentBounds(left, top, width, height)

Setter for the parent bounds using several values.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

Name	Type	Description
left	number	Left space.
top	number	Top space.
width	number	Element width.
height	number	Element height.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

Params:

Name	Type	Default	Description
paperSizeOrOptions	anychart.graphics.vector.PaperSize \| Object		Paper size or object with options.
landscape	boolean	false	Flag of landscape.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Usage sample

right

right()

Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.

right(right)

Setter for element right bound setting.

Params:

Name	Type	Default	Description
right	number \| string \| null	null	Right bound setting for the element.

Returns:

anychart.core.ui.Table - Returns self for method chaining.

Try it:

Usage sample

rowEvenFill

rowEvenFill()

Getter for the even row fill color.

Returns:

anychart.graphics.vector.Fill - Row even fill color.

See listing

var rowEvenFill = table.rowEvenFill();

rowEvenFill(color)

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

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

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

Try it:

Usage sample

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

Try it:

Usage sample

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

Try it:

Usage sample

rowEvenFill(imageSettings)

Image fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

rowOddFill

rowOddFill()

Getter for the odd row fill color.

Returns:

anychart.graphics.vector.Fill - Row odd fill color.

See listing

var rowOddFill = table.rowOddFill();

rowOddFill(color)

Setter for fill settings using 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)>	null	Color as an object, an array or a string.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

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

Try it:

Usage sample

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

Try it:

Usage sample

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

Try it:

Usage sample

rowOddFill(imageSettings)

Image fill. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

rowsCount

rowsCount()

Getter for table rows count.

Returns:

number - Rows count.

Try it:

Usage sample

rowsCount(count)

Setter for table rows count.

Detailed description

Calculated from the contents if not defined explicitly.

Params:

Name	Type	Default	Description
count	number	5	Rows count to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

rowsHeight

rowsHeight()

Getter for rows height.

Returns:

string | number | null - Rows height.

rowsHeight(height)

Setter for rows height.

Detailed description

Defaults to null - divide the rest of table height between rows with null height evenly.

Params:

Name	Type	Default	Description
height	string \| number \| null	null	Rows height to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

rowsMaxHeight

rowsMaxHeight()

Getter for the row height maximum.

Returns:

string | number | null - Row height maximum.

rowsMaxHeight(height)

Setter for the row height maximum.

Detailed description

Defaults to null - no maximum height.

Params:

Name	Type	Default	Description
height	string \| number \| null	null	Row height maximum to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

rowsMinHeight

rowsMinHeight()

Getter for the row height minimum.

Returns:

string | number | null - Row height minimum.

rowsMinHeight(height)

Setter for the row height minimum.

Detailed description

Defaults to null - no minimum height. The method sets a minimum height of rows, that will be to remain after a resize of table.

Params:

Name	Type	Default	Description
height	string \| number \| null	null	Row height minimum to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

saveAsCsv

saveAsCsv(chartDataExportMode, csvSettings, filename)Since version 7.10.0

Saves the table as a CSV file.

Params:

Name

Type

Description

chartDataExportMode

anychart.enums.ChartDataExportMode | string

Data export mode.

csvSettings

Object.<string, (string|boolean|undefined|function(name:*, value:*))>

CSV settings object:

rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats - Values formatter
headers - Headers formatter

Formatters must be represented as one of:

A function with two arguments such as the field name and value, that returns the formatted value.
The object with the key as the field name, and the value as a format function.

filename

string

File name to save.

Try it:

Usage sample

saveAsJpg

saveAsJpg(width, height, quality, forceTransparentWhite)Since version 7.7.0

Saves the table into JPEG file.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
forceTransparentWhite	boolean	Force transparent to white or not.

Try it:

Usage sample

saveAsPdf

saveAsPdf(paperSize, landscape, x, y)Since version 7.7.0

Saves the table into PDF file.

Params:

Name	Type	Description
paperSize	string	Any paper format like 'a0', 'tabloid', 'b4', etc.
landscape	boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.

Try it:

Usage sample

saveAsPng

saveAsPng(width, height, quality)Since version 7.7.0

Saves the table into PNG file.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.

Try it:

Usage sample

saveAsSvg

saveAsSvg(paperSize, landscape)Since version 7.7.0

Saves the table into SVG file with a paper size and landscape settings.

Params:

Name	Type	Description
paperSize	string	Paper Size.
landscape	boolean	Landscape.

Try it:

Usage sample

saveAsSvg(width, height)Since version 7.7.0

Saves the visual state into SVG file image width and height.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.

Try it:

Usage sample

saveAsXlsx

saveAsXlsx(filename)

Saves table data as an Excel document.

Params:

Name	Type	Description
filename	string	File name to save.

Try it:

Usage sample

selectable

selectable()

Getter for the text selectable option.

Returns:

boolean - Text selectable option.

See listing

var selectable = table.selectable();

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	Text selectable option to set.

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

shareAsJpg

shareAsJpg(onSuccess, onError, asBase64, width, height, quality, forceTransparentWhite, filename)Since version 7.11.1

Shares a table as a JPG file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccess	function(response:string)	Function that is called when sharing is complete.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
forceTransparentWhite	boolean	Force transparent to white or not.
filename	string	File name to save.

Try it:

Usage sample

shareAsPdf

shareAsPdf(onSuccess, onError, asBase64, paperSizeOrWidth, landscapeOrWidth, x, y, filename)Since version 7.11.1

Shares a table as a PDF file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccess	function(response:string)	Function that is called when sharing is complete.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
paperSizeOrWidth	number \| string	Any paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidth	number \| boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.
filename	string	File name to save.

Try it:

Usage sample

shareAsPng

shareAsPng(onSuccess, onError, asBase64, width, height, quality, filename)Since version 7.11.1

Shares a table as a PNG file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccess	function(response:string)	Function that is called when sharing is complete.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
filename	string	File name to save.

Try it:

Usage sample

shareAsSvg

shareAsSvg(onSuccess, onError, asBase64, paperSizeOrWidth, landscapeOrHeight, filename)Since version 7.11.1

Shares a table as a SVG file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccess	function(response:string)	Function that is called when sharing is complete.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
paperSizeOrWidth	string \| number	Paper Size or width.
landscapeOrHeight	boolean \| string	Landscape or height.
filename	string	File name to save.

Try it:

Usage sample

shareWithFacebook

shareWithFacebook(captionOrOptions, link, name, description)Since version 8.4.0

Opens Facebook sharing dialog.

Params:

Name	Type	Description
captionOrOptions	string \| Object	Caption for the main link or object with options.
link	string	The URL is attached to the publication.
name	string	The title for the attached link.
description	string	Description for the attached link.

Try it:

Usage sample

shareWithLinkedIn

shareWithLinkedIn(captionOrOptions, description)Since version 8.4.0

Opens LinkedIn sharing dialog.

Params:

Name	Type	Description
captionOrOptions	string \| Object	Caption for publication or object with options. If not set 'AnyChart' will be used.
description	string	Description.

Try it:

Usage sample

shareWithPinterest

shareWithPinterest(linkOrOptions, description)Since version 8.4.0

Opens Pinterest sharing dialog.

Params:

Name	Type	Description
linkOrOptions	string \| Object	Attached link or object with options. If not set, the image URL will be used.
description	string	Description.

Try it:

Usage sample

shareWithTwitter

shareWithTwitter()Since version 8.4.0

Opens Twitter sharing dialog.

Try it:

Usage sample

textDirection

textDirection()

Getter for the text direction.

Returns:

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

See listing

var textDirection = table.textDirection();

textDirection(value)

Setter for the text direction.

Params:

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

Returns:

anychart.core.ui.Table - Self instance for method chaining.

Try it:

Usage sample

textIndent

textIndent()

Getter for the text indent.

Returns:

number - Text indent.

See listing

var textIndent = table.textIndent();

textIndent(indent)

Setter for the text indent.

Params:

Name	Type	Description
indent	number	Text indent to set.

Returns:

anychart.core.ui.Table - 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.

See listing

var textOverflow = table.textOverflow();

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

Try it:

Usage sample

textShadow

textShadow()

Getter for the text shadow.

Returns:

string - String representation of text shadow.

See listing

var textShadow = table.textShadow();

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

Try it:

Usage sample

toCsv

toCsv(csvSettings)Since version 7.14.0

Returns CSV string with series data.

Params:

Name	Type	Description
csvSettings	Object.<string, (string\|boolean\|undefined)>	CSV settings.

Returns:

string - CSV string.

Try it:

Usage sample

toSvg

toSvg(paperSize, landscape)Since version 7.7.0

Returns SVG string if type of content SVG with parameters otherwise returns empty string.

Params:

Name	Type	Description
paperSize	string	Paper Size.
landscape	boolean	Landscape.

Returns:

string - SVG string or empty string.

Try it:

Usage sample

toSvg(width, height)Since version 7.7.0

Returns SVG string if type of content SVG with determined the width and height otherwise returns empty string.

Params:

Name	Type	Description
width	number	Paper Size or width.
height	number	Landscape or height.

Returns:

string - SVG string or empty string.

Try it:

Usage sample

top

top()

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.

top(top)

Setter for element top bound settings.

Params:

Name	Type	Default	Description
top	number \| string \| null	null	Top bound setting for the element.

Returns:

anychart.core.ui.Table - Returns self for method chaining.

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

Removes a listener added using listen() or listenOnce() methods.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object):boolean\|undefined		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.