AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.standalones.Table Improve this Doc

Extends: anychart.core.ui.Table

The Table class contains methods for configuring standalones 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.
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
print()Prints all elements.
saveAsJpg()Saves into JPEG file.
saveAsPdf()Saves into PDF file.
saveAsPng()Saves into PNG file.
saveAsSvg()Saves into SVG file.
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.
Miscellaneous
container()Getter for the element's container.
draw()Draws the table.
parentBounds()Getter for the parent bounds.
saveAsCsv()Saves table data as CSV.
saveAsXlsx()Saves table data as an Excel document.
toCsv()Returns CSV string with series data.

Methods Description

border

Getter for border of the table (not cells).

Returns:

anychart.core.ui.table.Border - Border settings.
Setter for border of the table (not cells).

Params:

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

Returns:

anychart.standalones.Table - Self instance for method chaining.

bottom

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

NameTypeDefaultDescription
bottomnumber | string | null
null
Bottom bound settings for the element.

Returns:

anychart.standalones.Table - Returns self for method chaining.

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for bounds of the element using one parameter.

Params:

NameTypeDescription
boundsanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.standalones.Table - Self instance for method chaining.
Setter for element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

anychart.standalones.Table - Self instance for method chaining.

cellBorder

Getter for cell border settings.

Returns:

anychart.core.ui.table.Border - Cell border stroke.
See listing
var cellBorder = table.cellBorder();
Setter for cell border settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
colorSettingsanychart.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.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.standalones.Table - Self instance for method chaining.

cellFill

Getter for the table fill color.

Returns:

anychart.graphics.vector.Fill - Cell fill color.
See listing
var cellFill = table.cellFill();
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
null
Color as an object, an array or a string.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.standalones.Table - Self instance for method chaining.

cellPadding

Setter for cell paddings in pixels using a single value.

Params:

NameTypeDescription
paddingnull | Array.<(number|string)> | ObjectPadding to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.
Examples for paddings
// all paddings 15px
table.cellPadding(15);
// all paddings 15px
table.cellPadding('15px');
// top and bottom 5px, right and left 15px
table.cellPadding(anychart.utils.padding(5,15));
Setter for 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.standalones.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);

colsCount

Getter for table columns count.

Returns:

number - Columns count.
Setter for table columns count.

Params:

NameTypeDefaultDescription
countnumber
4
Columns count to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

colsMaxWidth

Getter for the column width maximum.

Returns:

string | number | null - Column width maximum.
See listing
var colsMaxWidth = table.colsMaxWidth();
Setter for the column width maximum.

Params:

NameTypeDefaultDescription
widthstring | number | null
null
Column width maximum to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

colsMinWidth

Getter for column width minimum.

Returns:

string | number | null - Column width minimum.
See listing
var colsMinWidth = table.colsMinWidth();
Setter for column width minimum.

Params:

NameTypeDefaultDescription
widthstring | number | null
null
Column width minimum to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

colsWidth

Getter for the column width.

Returns:

string | number | null - Column width.
See listing
var colsWidth = table.colsWidth();
Setter for the column width.

Params:

NameTypeDefaultDescription
widthstring | number | null
null
Column width to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

container

Getter for the element's container.
Setter for the element's container.

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementThe value to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.
Example
// string
 element.container('containerIdentifier');
// DOM-element
 var domElement = document.getElementById('containerIdentifier');
 element.container(domElement);
// Framework-element
 var fwElement = anychart.standalones.table();
 element.container( fwElement.container() );

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();
Setter for the table content.

Params:

NameTypeDefaultDescription
tableValuesArray.<Array.<(anychart.core.VisualBase|string|number|undefined)>>
Values to set.
demergeCellsboolean
false
Pass true to demerge all cells.

Returns:

anychart.standalones.Table - Self instance for method chaining.

disablePointerEvents

Getter for the state of disablePointerEvents option.

Returns:

boolean - If pointer events are disabled.
See listing
var disablePointerEvents = table.disablePointerEvents();
Setter for the text disablePointerEvents option.

Params:

NameTypeDefaultDescription
enabledboolean
false
DisablePointerEvents option to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

draw

Draws the table.

Returns:

anychart.standalones.Table - Self instance for method chaining.

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

fontColor

Getter for the text font color.

Returns:

string - Font color.
See listing
var fontColor = table.fontColor();
Setter for the text font color. https://www.w3schools.com/html/html_colors.asp

Params:

NameTypeDescription
colorstringFont color to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

fontDecoration

Getter for the text font decoration.

Returns:

anychart.graphics.vector.Text.Decoration | string - Font decoration.
See listing
var fontDecoration = table.fontDecoration();
Setter for the text font decoration.

Params:

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

Returns:

anychart.standalones.Table - Self instance for method chaining.

fontFamily

Getter for the font family.

Returns:

string - Font family.
Setter for font family.

Params:

NameTypeDescription
familystringFont family to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

fontOpacity

Getter for the text font opacity.

Returns:

number - Font opacity.
See listing
var fontOpacity = table.fontOpacity();
Setter for the text font opacity. Double value from 0 to 1.

Params:

NameTypeDescription
opacitynumberFont opacity to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

fontSize

Getter for the text font size.

Returns:

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

Params:

NameTypeDescription
sizestring | numberFont size to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

fontStyle

Getter for the text font style.

Returns:

anychart.graphics.vector.Text.FontStyle | string - Font style.
See listing
var fontStyle = table.fontStyle();
Setter for the text font style.

Params:

NameTypeDefaultDescription
styleanychart.graphics.vector.Text.FontStyle | string
anychart.graphics.vector.Text.FontStyle#NORMAL
Font style to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

fontVariant

Getter for the text font variant.

Returns:

anychart.graphics.vector.Text.FontVariant | string - Font variant.
See listing
var fontVariant = table.fontVariant();
Setter for the text font variant.

Params:

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

Returns:

anychart.standalones.Table - Self instance for method chaining.

fontWeight

Getter for the text font weight.

Returns:

string | number - Font weight.
See listing
var fontWeight = table.fontWeight();

Params:

NameTypeDescription
weightstring | numberFont weight to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

getCell

Returns cell by its row and column number.

Params:

NameTypeDescription
rownumberRow index.
colnumberColumn index.

Returns:

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

getCol

Returns column instance by its number.

Params:

NameTypeDescription
colnumberA column by number

Returns:

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

getPixelBounds

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

Returns:

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

getRow

Returns row instance by its number.

Params:

NameTypeDescription
rownumberA row by number.

Returns:

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

hAlign

Getter for the text horizontal align.

Returns:

anychart.graphics.vector.Text.HAlign | string - Text horizontal align.
See listing
var hAlign = table.hAlign();
Setter for the text horizontal align.

Params:

NameTypeDefaultDescription
alignanychart.graphics.vector.Text.HAlign | string
anychart.graphics.vector.Text.HAlign#START
Horizontal align to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

height

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.
Setter for element height setting.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the element.

Returns:

anychart.standalones.Table - Returns self for method chaining.

left

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

NameTypeDefaultDescription
leftnumber | string | null
null
Left bound setting for the element.

Returns:

anychart.standalones.Table - Returns self for method chaining.

letterSpacing

Getter for the text letter spacing.

Returns:

string | number - Letter spacing.
See listing
var letterSpacing = table.letterSpacing();

Params:

NameTypeDescription
spacingstring | numberLetter spacing to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

lineHeight

Getter for the text line height.

Returns:

string | number - Text line height.
See listing
var lineHeight = table.lineHeight();

Params:

NameTypeDescription
heightstring | numberLine height to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

maxHeight

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.
Setter for the maximum height.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Maximum height to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

maxWidth

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.
Setter for the maximum width.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Maximum width to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

minHeight

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.
Setter for the minimum height.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Minimum height to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

minWidth

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.
Setter for the minimum width.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Minimum width to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

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.
Setter for the parent bounds using single value.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

NameTypeDescription
boundsanychart.math.Rect | Object | number | nullBounds to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.
Setter for the parent bounds using several values.
Bounds that would be used in case of percent size calculations. Expects pixel values only.

Params:

NameTypeDescription
leftnumberLeft space.
topnumberTop space.
widthnumberElement width.
heightnumberElement height.

Returns:

anychart.standalones.Table - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.
Getter for element right bound settings.

Returns:

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

Params:

NameTypeDefaultDescription
rightnumber | string | null
null
Right bound setting for the element.

Returns:

anychart.standalones.Table - Returns self for method chaining.

rowEvenFill

Getter for the even row fill color.

Returns:

anychart.graphics.vector.Fill - Row even fill color.
See listing
var rowEvenFill = table.rowEvenFill();
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
null
Color as an object, an array or a string.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.standalones.Table - Self instance for method chaining.

rowOddFill

Getter for the odd row fill color.

Returns:

anychart.graphics.vector.Fill - Row odd fill color.
See listing
var rowOddFill = table.rowOddFill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
null
Color as an object, an array or a string.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.standalones.Table - Self instance for method chaining.

rowsCount

Getter for table rows count.

Returns:

number - Rows count.
Setter for table rows count.

Params:

NameTypeDefaultDescription
countnumber
5
Rows count to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

rowsHeight

Getter for rows height.

Returns:

string | number | null - Rows height.
Setter for rows height.

Params:

NameTypeDefaultDescription
heightstring | number | null
null
Rows height to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

rowsMaxHeight

Getter for the row height maximum.

Returns:

string | number | null - Row height maximum.
Setter for the row height maximum.

Params:

NameTypeDefaultDescription
heightstring | number | null
null
Row height maximum to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

rowsMinHeight

Getter for the row height minimum.

Returns:

string | number | null - Row height minimum.
Setter for the row height minimum.

Params:

NameTypeDefaultDescription
heightstring | number | null
null
Row height minimum to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

saveAsCsv

Saves table data as CSV.

Params:

NameTypeDescription
csvSettingsObject.<string, (string|boolean|undefined)>CSV settings.
filenamestringFile name to save.

saveAsJpg

Saves the table into JPEG file.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.

saveAsPdf

Saves the table into PDF file.

Params:

NameTypeDescription
paperSizestringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.

saveAsPng

Saves the table into PNG file.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.

saveAsSvg

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

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.
Saves the visual state into SVG file image width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

saveAsXlsx

Saves table data as an Excel document.

Params:

NameTypeDescription
filenamestringFile name to save.

selectable

Getter for the text selectable option.

Returns:

boolean - Text selectable option.
See listing
var selectable = table.selectable();
Setter for the text selectable.

Params:

NameTypeDefaultDescription
enabledboolean
false
Text selectable option to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

textDirection

Getter for the text direction.

Returns:

anychart.graphics.vector.Text.Direction | string - Text direction.
See listing
var textDirection = table.textDirection();
Setter for the text direction.

Params:

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

Returns:

anychart.standalones.Table - Self instance for method chaining.

textIndent

Getter for the text indent.

Returns:

number - Text indent.
See listing
var textIndent = table.textIndent();
Setter for the text indent.

Params:

NameTypeDescription
indentnumberText indent to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

textOverflow

Getter for the text overflow settings.

Returns:

anychart.graphics.vector.Text.TextOverflow | string - Text overflow settings.
See listing
var textOverflow = table.textOverflow();
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.standalones.Table - Self instance for method chaining.

toCsv

Returns CSV string with series data.

Params:

NameTypeDescription
csvSettingsObject.<string, (string|boolean|undefined)>CSV settings.

Returns:

string - CSV string.

toSvg

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

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.

Returns:

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

Params:

NameTypeDescription
widthnumberPaper Size or width.
heightnumberLandscape or height.

Returns:

string - SVG string or empty string.

top

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

NameTypeDefaultDescription
topnumber | string | null
null
Top bound setting for the element.

Returns:

anychart.standalones.Table - Returns self for method chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

useHtml

Getter for the useHtml flag.

Returns:

boolean - Boolean flag.
See listing
var useHtml = table.useHtml();
Setter for flag useHtml.

Params:

NameTypeDefaultDescription
enabledboolean
false
Value to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

vAlign

Getter for the text vertical align.

Returns:

anychart.graphics.vector.Text.VAlign | string - Text vertical align.
See listing
var vAlign = table.vAlign();
Setter for the text vertical align.

Params:

NameTypeDefaultDescription
alignanychart.graphics.vector.Text.VAlign | string
anychart.graphics.vector.Text.VAlign#TOP
Vertical align to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

width

Getter for element width settings.

Returns:

number | string | undefined - Element's width setting.
Setter for element width setting.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the element.

Returns:

anychart.standalones.Table - Returns self for method chaining.

wordBreak

Getter for the word-break mode.

Returns:

anychart.enums.WordBreak | string - Word-break mode.
See listing
var wordBreak = table.wordBreak();
Setter for the word-break mode.

Params:

NameTypeDefaultDescription
modeanychart.enums.WordBreak | string
'normal'
Value to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

wordWrap

Getter for the word-wrap mode.

Returns:

anychart.enums.WordWrap | string - Word-wrap mode.
See listing
var wordWrap = table.wordWrap();
Setter for the word-wrap mode.

Params:

NameTypeDefaultDescription
modeanychart.enums.WordWrap | string
'normal'
Value to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

anychart.standalones.Table - Self instance for method chaining.