Connector JavaScript API Reference

Constructor

new SpotfireLineChart(lineChartProperties)

Parameters:

Name	Type	Description
`[ lineChartProperties ]`	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.
`lineWidth`	Number	Specifies the width of the lines in the line chart.
`showMarkers`	Boolean	Determines whether or not markers should be displayed for the axis values.
`markerSize`	Number	Specifies the size of the markers, in pixels. Allowed values are 1-100.
`drawAsStepLines`	Boolean	Determines whether or not to draw the lines in incremental steps rather than as straight lines directly between each value.
`breakLinesOnEmptyValues`	Boolean	Determines whether lines should be broken or remain connected when an empty value is found in the data used to create the line.
`compensateForMissingValues`	Boolean	If you are using a Date, Time or DateTime column somewhere in the visualization, it determines whether or not to perform some calculation where a required time period is missing. For example, if you have created a visualization showing cumulative sums and there are missing data for some categories, setting this parameter to true will produce a value of the same size as the previous value instead of interpolating between the values.
`[ 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.
`[ labels ]`	Object
`showLineIdentifier`	Boolean	Specifies whether or not to display labels showing the categories used to create each line (by coloring or line by).
`showIndividualValues`	Boolean	Specifies whether or not to display labels showing the values for all points used to create the line.
`showLabelsFor`	SpotfireLabelVisibilities	Determines whether to show labels with on all lines ('All'), lines containing marked rows only ('Marked rows'), or not to show any labels at all ('None').
`maxNumberOfLabels`	Number	Specifies the maximum number of labels to be shown.