Class

SpotfireTable

SpotfireTable(tablePlotDescription)

Represents a table plot description.

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 Object
dataTable String

Specifies the data table on which the visualization will work.

marking String

Specifies the marking that will be used to mark items in the visualization.

limiting Object

Settings used for limiting the data shown in the visualization.

byMarkings Object

Settings used for limiting the data shown in the visualization using the markings.

markingNames Array.<String>

Lists the available markings that can be used to limit what is shown in the visualization. This means that the visualization only displays data that has been marked in other visualizations (master visualizations).

combinationBehavior String

['AND'|'OR'], specifies how the data in the markings should be combined if you have listed more than one marking. AND: to show the intersection of the selected markings; OR: to show the union of the selected markings.

emptyBehavior String

['ALL','EMPTY','MESSAGE'], specifies what the visualization should show when no items have been marked in its master visualizations. ALL: to show all the data from the master visualizations that control the content, if no items have been marked in those visualizations; EMPTY: to display only the scales and axis selectors if no items have been marked in the master visualizations; MESSAGE: to display a message if no items have been marked in the master visualizations. The axis selectors will also be visible.

emptyMessage String

the message that will be displayed if no items have been marked in the master visualizations.

byFilterings Object

Defines how different filtering schemes in the analysis should affect the visualization.

filteringNames Array.<String>

Lists the available filtering schemes that can be used to limit what is shown in the visualization.

useCurrentFilteringFromPage Boolean

Specifies whether or not the visualization should utilize the filtering scheme that is used on the page where the visualization is located. If you move the visualization to a new page, then the visualization will automatically start reacting on the filtering scheme that is used on the new page.

appearance Object
useSeparateColorForMarkedItems Boolean

Specifies whether or not the marking color should be used to distinguish marked items in the visualization.

headerRowHeight = 5 Number

the header row height in number of line

dataRowHeight = 5 Number

the data row height in number of line

numberOfFrozenColumns = 0 Number

number of frozen column

cellBorderStyle = SpotfireTableCellBorderStyles.None String

['Solid'|'None'], display or not cells border. Can be set from SpotfireTableCellBorderStyles

allowTableDataExportInSpotfireWebClients Boolean

specifies whether or not a TIBCO Spotfire web client user is allowed to export the data from the table

fonts Object
legend Object

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 Object

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 Object
fontFamily String

Specifies a specific font to use.

size Integer

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 Object
fontFamily String

Specifies a specific font to use.

size Integer

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  {Enum} 

Specifies which side of the visualization the legend should be positioned: the right-hand side or the left-hand side.

Enum options: left, right
width Number

Specifies the width of the legend.

legendItems Array.<Object>

Defines how the legend items should be displayed. The available options vary between legend items.

[].name String

The name of the legend item to modify.

[].visible Boolean

Specifies whether or not the legend item should be shown.

[].showTitle Boolean

Specifies whether or not the legend item title should be shown.

showHideItemsRules Array.<Object>
[].expression String

Specifies which column the rule should be applied to.

[].type SpotfireShowHideItemsRulesTypes  {Enum} 

Specifies the rule type. Which types are available depends on the data type of the column the rule is applied to.

Enum options: top, bottom, between, equalTo, notEqualTo, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, booleanExpression, string
[].hideMatchedItems String

Specifies whether or not the items that match the rule should be hidden.

[].evaluatePerTrellis String

If the visualization is trellised , specifies whether or not the rule should be applied once for each trellis panel.

[].displayName String

The name of the rule.

[].enabled Boolean

Specifies whether or not the rule should be active.

[].ruleCondition Object
comparisonOperator String
threshold Object
type String
value Number
stringValue Object
type String
value Number
isBottom Boolean
rank Object
type String
value Number
startValue Object
type String
value Number
endValue Object
type String
value Number
expression String
colors Object
colorSchemeGroupings Array.<coloringTableDefinition>

Definition of the coloring

[].name String

The name of the color scheme grouping

[].templateUrl String

The url of the file that contains the color rules template to apply for this coloring.

[].templateLibraryPath String
[].oneScalePer SpotfireOneScalePer  {Enum} 

Set the one scale paremeter. You can choose value in SpotfireOneScalePer enum like implementation

Enum options: column, trellis
[].applyTo SpotfireApplyTo  {Enum} 
Enum options: background, text
[].mappings Array.<String>

Collection of column names where to apply coloring (used by table plot)

[].colorRules Array.<SpotfireColoringRules>

Array of coloring rules definition.

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 Integer

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