Constructor
protected new SpotfireVisualization([visualDescription])
Creates a new instance of SpotfireVisualization.
Parameters:
| Name | Type | Description |
|---|---|---|
[ visualDescription ]
|
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. |
[ 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. |
[ 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> |
Methods
defaultAppearanceProperties()
Sets the default "Appearance" properties of the visualization.
getShowHideItemsRule()
Gets the "Show/Hide Items" rule, given its display name.
getUniqueId() → {Number}
Gets a unique identifier for the visualization.
The generated identifier.
getVisualTypeName() → {String}
Gets the type of the visualization.
The type of the visualization.