Connector JavaScript API Reference

Constructor

new SpotfireScatterPlot([scatterPlotProperties])

Parameters:

Name	Type	Description
`[ scatterPlotProperties ]`	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.
`transparency`	Number	Specifies the transparency of the markers, between 0.0 and 1.0.
`xJittering`	Number	Specifies the amount of jittering to use in the X direction. Valid values are in the range [0.0, 0.5].
`yJittering`	Number	Specifies the amount of jittering to use in the Y direction. Valid values are in the range [0.0, 0.5].
`[ 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>
`[ xAxis ]`	SpotfireScaleAxis
`[ yAxis ]`	SpotfireScaleAxis
`[ colors ]`	SpotfireColorAxis
`[ tooltip ]`	SpotfireTooltip
`[ trellis ]`	TrellisDescription ▼
`trellisMode`	SpotfireTrellisModes ▼	'Rows and columns': splits the visualization into different panels for all categories in the selected column or hierarchy. The number of values in the specified column or hierarchy controls the number of panels to be displayed in each row, column, or page, respectively. 'Panels': splits the visualization into different panels for all categories in the selected column or hierarchy, without binding any dimensions to either rows or columns. This means that the number of actual values in the column to split by does not control the number of shown rows or columns in any way.
`rowsColumns`	String
`panels`	String
`rowAxis`	trellisAxisDescription ▼	A row with trellis panels will be created for each value in the column or hierarchy.
`hierarchyOption`	SpotfireTrellisAxisHierarchyOptions ▼	[For hierarchical categories only, but not available for Date, Time or DateTime hierarchies.] 'Use actual combinations in data only (nest)': to display all combinations available in the data; 'Use all possible combinations (cross)': to display all possible combinations, even showing categories that are currently not included in the data.
`nest`	String
`cross`	String
`columnAxis`	trellisAxisDescription ▼	A column with trellis panels will be created for each value in the column or hierarchy.
`hierarchyOption`	SpotfireTrellisAxisHierarchyOptions ▼	[For hierarchical categories only, but not available for Date, Time or DateTime hierarchies.] 'Use actual combinations in data only (nest)': to display all combinations available in the data; 'Use all possible combinations (cross)': to display all possible combinations, even showing categories that are currently not included in the data.
`nest`	String
`cross`	String
`pageAxis`	trellisAxisDescription ▼	A new page with trellis panels will be created for each value in the column or hierarchy.
`hierarchyOption`	SpotfireTrellisAxisHierarchyOptions ▼	[For hierarchical categories only, but not available for Date, Time or DateTime hierarchies.] 'Use actual combinations in data only (nest)': to display all combinations available in the data; 'Use all possible combinations (cross)': to display all possible combinations, even showing categories that are currently not included in the data.
`nest`	String
`cross`	String
`panelAxis`	trellisAxisDescription ▼	Specifies the column or hierarchy to define the categories by which the visualization should be split.
`hierarchyOption`	SpotfireTrellisAxisHierarchyOptions ▼	[For hierarchical categories only, but not available for Date, Time or DateTime hierarchies.] 'Use actual combinations in data only (nest)': to display all combinations available in the data; 'Use all possible combinations (cross)': to display all possible combinations, even showing categories that are currently not included in the data.
`nest`	String
`cross`	String
`manualLayout`	Boolean	To manually specify the number of rows and columns that should be visible without scrolling.
`maxNumberOfRows`	Number	Specifies the maximum number of panels that should be visible on each page.
`maxNumberOfColumns`	Number	Specifies the maximum number of panels that should be visible on each page.
`[ drawingOrder ]`	Object
`columns`	Array.<String>	Specifies the columns to use for defining the drawing order of markers.
`reverse = false`	Boolean	[Only available if a column is provided.] Draws the markers in the opposite order (for the column(s) specified above). That is, front markers are sent backwards and vice versa.
`[ labels ]`	Object
`labelBy`	String	Specifies the column or hierarchy whose values should be presented as labels in the visualization.
`showLabelsFor`	SpotfireLabelVisibilities	Determines whether to show labels on all markers ('All'), marked markers only ('Marked rows'), or not to show any labels at all ('None').
`maxNumberOfLabels`	Number	Specifies the maximum number of labels to be shown. If the number is smaller than the available number of markers, the labels will be equally distributed.
`centerLabelsOnItems`	Boolean	Places the label right on top of the marker instead of drawing a line from the marker to the label, which is the default behavior. This can be a way to use your own images as markers.
`showEmptyLabels`	Boolean	Determines whether or not to show the labels that have no content.
`showAs`	Object	These settings are used when you choose to display anything other than plain text in your labels. For example, the labels could contain web links or images.
`type`	string	Allows you to decide how the data in the selected column should be interpreted. For example, use 'Text' for plain text labels. Use 'Image' if there are binary images in your data that you want to use as labels. Use 'Link' if the text should be interpreted as a web link. Use 'Image from URL' if the image is picked from a web resource location. From enum `SpotfireRendererTypes`
`url`	String	The URL syntax so that it fits your current data.
`size`	Number	Size of labels showing images (available if the selected label output is some kind of image). Between 0 and 100: the labels size is expressed as a percentage of the size of the panel in the range of minimum 15 pixels and maximum the least of the width or height. I.e. a value of 0 will allow images as large as 15 x 15 pixels, and a value of 100 will allow images as large as the least of the width or the height of the panel.