Class

SpotfireVisualization2D

SpotfireVisualization2D(visualDescription)

Base class for all 2D visualizations that can be added to a TIBCO Spotfire document.

Constructor

new SpotfireVisualization2D(visualDescription)

Parameters:
Name Type Description
visualDescription Object
general [Inherited] Object
title [Inherited] String

The title of the visualization.

description [Inherited] String

The description of the visualization.

showTitleBar [Inherited] Boolean

Specifies whether or not to show the visualization title.

data [Inherited] Object
dataTable [Inherited] String

Specifies the data table on which the visualization will work.

marking [Inherited] String

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

limiting [Inherited] Object

Settings used for limiting the data shown in the visualization.

byMarkings [Inherited] Object

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

markingNames [Inherited] 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 [Inherited] 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 [Inherited] 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 [Inherited] String

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

byFilterings [Inherited] Object

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

filteringNames [Inherited] Array.<String>

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

useCurrentFilteringFromPage [Inherited] 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 [Inherited] Object
useSeparateColorForMarkedItems [Inherited] Boolean

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

transparency Number

Specifies the transparency of the markers, between 0.0 and 1.0.

fonts [Inherited] Object
legend [Inherited] Object

To change the font settings of the legend.

fontFamily [Inherited] String

Specifies a specific font to use.

size [Inherited] Number

Specifies a specific font size to use.

bold [Inherited] Boolean

Specifies if the font style Bold should be used.

italic [Inherited] Boolean

Specifies if the font style Italic should be used.

detailsVisualizationMessage [Inherited] Object

To change the font settings of the details visualization message.

fontFamily [Inherited] String

Specifies a specific font to use.

size [Inherited] Number

Specifies a specific font size to use.

bold [Inherited] Boolean

Specifies if the font style Bold should be used.

italic [Inherited] Boolean

Specifies if the font style Italic should be used.

legend [Inherited] Object
visible [Inherited] Boolean

Specifies whether or not the legend should be shown in the visualization.

position [Inherited] 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 [Inherited] Number

Specifies the width of the legend.

legendItems [Inherited] Array.<Object>

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

[].name [Inherited] String

The name of the legend item to modify.

[].visible [Inherited] Boolean

Specifies whether or not the legend item should be shown.

[].showTitle [Inherited] Boolean

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

showHideItemsRules [Inherited] Array.<Object>
[].expression [Inherited] String

Specifies which column the rule should be applied to.

[].type [Inherited] 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 [Inherited] String

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

[].evaluatePerTrellis [Inherited] String

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

[].displayName [Inherited] String

The name of the rule.

[].enabled [Inherited] Boolean

Specifies whether or not the rule should be active.

[].ruleCondition [Inherited] Object
comparisonOperator [Inherited] String
threshold [Inherited] Object
type [Inherited] String
value [Inherited] Number
stringValue [Inherited] Object
type [Inherited] String
value [Inherited] Number
isBottom [Inherited] Boolean
rank [Inherited] Object
type [Inherited] String
value [Inherited] Number
startValue [Inherited] Object
type [Inherited] String
value [Inherited] Number
endValue [Inherited] Object
type [Inherited] String
value [Inherited] Number
expression [Inherited] String
XAxis SpotfireScaleAxis
YAxis SpotfireScaleAxis
colors SpotfireColorAxis
tooltip Object
items Array.<Object>
[].expression String

Specifies the column and the name of the tooltip using an expression in the format: '[column expression] as [tooltip name]'.

[].renderer SpotfireRenderer
type SpotfireValueRendererType

Specifies the type of the renderer.

url String

[Available for 'Image from URL' and 'Link' renderers only.] Specifies the target URL.

[].size Number

[Available if the selected tooltip value is some kind of image.] Specifies the size in pixels of the image, between 0 and 1600.

format SpotfireTooltipFormats {Enum}

Specifies whether or not the name of the tooltip value should be included along with the value itself

Enum options: valueNamesAndValues, visualizationPropertiesAndValues
trellis SpotfireTrellis

Methods

defaultAppearanceProperties()

Sets the default "Appearance" properties of the visualization.

Inherited From:

getDefaultTitle() → {String}

Gets the default title for the visualization.

Inherited From:

The generated title.

String

getShowHideItemsRule() → {SpotfireShowHideItemsRules}

Gets the "Show/Hide Items" rule, given its display name.

Inherited From:

The "Show/Hide Items" rule.

getUniqueId() → {Number}

Gets a unique identifier for the visualization.

Inherited From:

The generated identifier.

Number

getVisualTypeName() → {String}

Gets the type of the visualization.

Inherited From:

The type of the visualization.

String