Connector JavaScript API Reference

Constructor

new SpotfireTable(tablePlotDescription)

Parameters:

Name	Type	Description
`[ tablePlotDescription ]`	Object
`[ general ]`	Object
`title`	String	The title of the visualization.
`description`	String	The description of the visualization.
`showTitleBar`	Boolean	Specifies whether or not to show the visualization title.
`[ data ]`	VisualDataDescription
`[ appearance ]`	Object
`useSeparateColorForMarkedItems`	Boolean	Specifies whether or not the marking color should be used to distinguish marked items in the visualization.
`headerRowHeight`	Number	Specifies the height of the header row in number of lines.
`dataRowHeight`	Number	Specifies the height of all data rows in number of lines.
`numberOfFrozenColumns`	Number	Specifies how many columns on the left-hand side will be frozen, that is, not scroll out of sight when the scroll bar is moved to the right.
`cellBorderStyle`	SpotfireTableCellBorderStyles ▼	Specifies whether or not cell borders should be visible between the cells in the table.
`none`	String
`solid`	String
`allowTableDataExportInSpotfireWebClients`	Boolean	Specifies whether or not a Spotfire web client user is allowed to export the data from the table.
`[ fonts ]`	Object
`legend`	VisualFontDescription ▼	To change the font settings of the legend.
`fontFamily`	string	Specifies a specific font to use.
`size`	number	Specifies a specific font size to use.
`bold`	boolean	Specifies if the font style Bold should be used.
`italic`	boolean	Specifies if the font style Italic should be used.
`detailsVisualizationMessage`	VisualFontDescription ▼	To change the font settings of the details visualization message.
`fontFamily`	string	Specifies a specific font to use.
`size`	number	Specifies a specific font size to use.
`bold`	boolean	Specifies if the font style Bold should be used.
`italic`	boolean	Specifies if the font style Italic should be used.
`tableText`	VisualFontDescription ▼
`fontFamily`	string	Specifies a specific font to use.
`size`	number	Specifies a specific font size to use.
`bold`	boolean	Specifies if the font style Bold should be used.
`italic`	boolean	Specifies if the font style Italic should be used.
`tableHeader`	VisualFontDescription ▼
`fontFamily`	string	Specifies a specific font to use.
`size`	number	Specifies a specific font size to use.
`bold`	boolean	Specifies if the font style Bold should be used.
`italic`	boolean	Specifies if the font style Italic should be used.
`[ legend ]`	Object
`visible`	Boolean	Specifies whether or not the legend should be shown in the visualization.
`position`	SpotfireLegendPositions ▼	Specifies which side of the visualization the legend should be positioned: the right-hand side or the left-hand side.
`left`	String	To place the legend on the left-hand side. Other available value: 'Left'.
`right`	String	To place the legend on the right-hand side. Other available value: 'Right'.
`width`	Number	Specifies the width, in pixels, of the legend as it is displayed in the user interface.
`legendItems`	Array.<VisualLegendItemDescription>	Defines how the legend items should be displayed. The available options vary between legend items.
`[ showHideItemsRules ]`	Array.<VisualShowHideItemsRuleDescription>
`[ colors ]`	Object
`colorSchemeGroupings`	Array.<SpotfireColoringTable>	Descriptions of the coloring scheme groupings.
`[ columns ]`	Object
`selectedColumns`	Array.<Object>	the list of column to be displayed in the right order
`[].columnName`	String	the column name
`[].renderer`	Object
`type`	String	['Text'\|'Link'\|'Image'\|'Image from URL'], text will represent the value as text, link as an html link on the url below, image as an image, imageFromUrl as an image from the url below. get it from SpotfireValueRendererTypes members
`urlTemplate`	String	depends on the renderer type: none for text, [http\|https]://some_complex_or_not_uri/{$}.[extension] where {$} represents the cell value for link or imageFromUrl
`[].width = 100`	Number	the width (in px I suppose, as no information about the unit is in the C# reference of spotfire)
`addNewColumnsAutomatically`	Boolean	if true, the visualization will add any new columns in the datatable automatically to the table
`[ sortings ]`	Array.<Object>
`[].columnName`	String	the columnName,
`[].direction`	String	['ascending','descending'], the sort direction