Documentation - SpotfireCombinationChart

Constructor

new SpotfireCombinationChart(combinationChartProperties)

Parameters:

Name	Type	Description
`[ combinationChartProperties ]`	Object
`[ appearance ]`	Object
`transparency`	Number	Specifies the transparency of the markers, between 0.0 and 1.0.
`useSeparateColorForMarkedItems`	Boolean	Specifies whether or not the marking color should be used to distinguish marked items in the visualization.
`[ xAxis ]`	scaleAxisDescription ▼
`range`	Object
`min`	Number	Determines the lower value of the axis range.
`max`	Number	Determines the upper value of the axis range.
`includeOriginInRange`	Boolean	[Available for continuous axes only] Specifies whether or not the value 0 should be included in the axis, regardless of filtering.
`showZoomSlider`	Boolean	Specifies whether or not a zoom slider that you can manually manipulate to view only the interesting markers in the visualization should be visible.
`showGridLines`	Boolean	Specifies whether or not vertical grid lines should be visible.
`logScale`	Boolean	Specifies whether or not the scale changes from a linear scale to a logarithmic base 10 scale.
`reverseScale`	Boolean	Specifies whether or not the current sort order should be reversed, so that the lowest value is displayed at the top of the scale.
`showLabels`	Boolean	Specifies whether or not scale labels should be visible.
`labelOrientation`	SpotfireLabelOrientations {Enum} ▼	Shows scale labels horizontally or vertically.
	Enum options: horizontal, vertical
`maxNumberOfLabels`	Number	Specifies a maximum number of scale labels to be shown, between 0 and 200.
`individualScalingMode`	SpotfireIndividualScalingModes {Enum} ▼	[Available for Y-axis and Value axis only.] Specifies if one scale should be displayed for each category used to color the markers by or for each trellis panel. Note: you should apply a coloring or a trellis before applying this property, see the visualization examples `SpotfireBarChart`.
	Enum options: color, trellis
`ranges`	Array.<Object>	Array of individual scales to apply. Override the range property.
`[].scale`	String	Specifies the scale on which apply the range.
`[].position`	SpotfireScaleDockPositions {Enum} ▼	Specifies if the scale should be placed on the left-hand side of the visualization or on the right-hand side.
	Enum options: left, right
`[].min`	Number	Determines the lower value of the scale range.
`[].max`	Number	Determines the highest value of the scale range.
`[].includeOriginInRange`	Boolean	[Available for continuous axes only.] Specifies whether or not the value 0 should be included in the axis, regardless of filtering.
`[].reverseScale`	Boolean	Specifies whether or not the current sort order should be reversed, so that the lowest value is displayed at the top of the scale.
`[ yAxis ]`	scaleAxisDescription ▼
`range`	Object
`min`	Number	Determines the lower value of the axis range.
`max`	Number	Determines the upper value of the axis range.
`includeOriginInRange`	Boolean	[Available for continuous axes only] Specifies whether or not the value 0 should be included in the axis, regardless of filtering.
`showZoomSlider`	Boolean	Specifies whether or not a zoom slider that you can manually manipulate to view only the interesting markers in the visualization should be visible.
`showGridLines`	Boolean	Specifies whether or not vertical grid lines should be visible.
`logScale`	Boolean	Specifies whether or not the scale changes from a linear scale to a logarithmic base 10 scale.
`reverseScale`	Boolean	Specifies whether or not the current sort order should be reversed, so that the lowest value is displayed at the top of the scale.
`showLabels`	Boolean	Specifies whether or not scale labels should be visible.
`labelOrientation`	SpotfireLabelOrientations {Enum} ▼	Shows scale labels horizontally or vertically.
	Enum options: horizontal, vertical
`maxNumberOfLabels`	Number	Specifies a maximum number of scale labels to be shown, between 0 and 200.
`individualScalingMode`	SpotfireIndividualScalingModes {Enum} ▼	[Available for Y-axis and Value axis only.] Specifies if one scale should be displayed for each category used to color the markers by or for each trellis panel. Note: you should apply a coloring or a trellis before applying this property, see the visualization examples `SpotfireBarChart`.
	Enum options: color, trellis
`ranges`	Array.<Object>	Array of individual scales to apply. Override the range property.
`[].scale`	String	Specifies the scale on which apply the range.
`[].position`	SpotfireScaleDockPositions {Enum} ▼	Specifies if the scale should be placed on the left-hand side of the visualization or on the right-hand side.
	Enum options: left, right
`[].min`	Number	Determines the lower value of the scale range.
`[].max`	Number	Determines the highest value of the scale range.
`[].includeOriginInRange`	Boolean	[Available for continuous axes only.] Specifies whether or not the value 0 should be included in the axis, regardless of filtering.
`[].reverseScale`	Boolean	Specifies whether or not the current sort order should be reversed, so that the lowest value is displayed at the top of the scale.
`[ colors ]`	colorAxisDescription ▼
`columns`	String	Specifies the column or hierarchy to color by.
`[ colorMode ]`	SpotfireColorModes {Enum} ▼	Specifies in which color mode to set up the color scheme. Which modes are available depend on whether the scale is in categorical or continuous mode. For columns in continuous scale mode, you can select one of the following color modes: Gradient, Segments, or Fixed. For columns in categorical scale mode, you can select either Categorical or Fixed color mode.
	Enum options: fixed, categorical, gradient, segments, uniqueValues
`[ oneScalePer ]`	SpotfireOneScalePer {Enum} ▼	Specifies whether there should be one separate scale per trellis panel for trellised bar charts, or if one scale should apply to the entire visualization. Only applicable to columns in continuous scale mode.
	Enum options: column, trellis
`[ templateLibraryPath ]`	String	The path in the library of the file that contains a color scheme to be applied to the visualization.
`[ templateUrl ]`	String	The URL of the file that contains a color scheme to be applied to the visualization.
`[ templateName ]`	String	The name of the document color scheme.
`[ colorRules ]`	Object \| Array.<Object>	Array of color rules to be applied on the visualization.
`displayName`	String	Optionally specify a descriptive name for the rule. The name is used to identify the rule in the Visualization Properties dialog, and it can be displayed in the legend of the visualization. Leave the field blank if you want to use the default rule name.
`color`	String \| Object	Specifies the color to be used for the rule, in the hexadecimal format, or the ARGB object.
`[ a ]`	Number	Opacity factor, between 0 and 255.
`[ r ]`	Number	Red intensity, between 0 and 255.
`[ g ]`	Number	Green intensity, between 0 and 255.
`[ b ]`	Number	Blue intensity, between 0 and 255.
`[ a ]`	Number	Opacity factor, between 0 and 255.
`[ r ]`	Number	Red intensity, between 0 and 255.
`[ g ]`	Number	Green intensity, between 0 and 255.
`[ b ]`	Number	Blue intensity, between 0 and 255.
`type`	SpotfireColoringRulesTypes {Enum} ▼	Specifies which rule type to add. Which types are available depends on the data type of the column, or hierarchy that the rule is applied to.
	Enum options: top, bottom, between, equalTo, notEqualTo, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, booleanExpression, gradient, segments, uniqueValues, string
`value`	Number \| String	Defines the value the rule should apply to. The available options depend on the rule type.
`startValue`	Number	Only available for the "Between" type. Specifies the minimum value the rule should apply to.
`endValue`	Number	Only available for the "Between" type. Specifies the maximum value the rule should apply to.
`expression`	String	Only available for the "Boolean expression" type. Specifies the expression the rule should apply to, all the items for which the expression is true will get the specified color.
`[ colorPoints ]`	Object \| Array.<Object>	Array of anchor points to be applied on the visualization. Available for continuous columns only.
`type`	SpotfireColoringRulesTypes {Enum} ▼	Specifies which point type to add. Only types for continuous columns are available.
	Enum options: top, bottom, between, equalTo, notEqualTo, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, booleanExpression, gradient, segments, uniqueValues, string
`value`	Number \| String	Defines the value the rule should apply to. The available options depend on the point type.
`color`	String \| Object	Specifies the color to be used for the anchor point, in the hexadecimal format, or the ARGB object.
`[ 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`	SpotfireValueRendererTypes {Enum} ▼	Specifies the type of the renderer.
	Enum options: text, link, imageFromUrl
`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 ]`	trellisDescription ▼
`trellisMode`	SpotfireTrellisModes {Enum} ▼	'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.
	Enum options: rowsColumns, panels
`rowAxis`	trellisAxisDescription ▼	A row with trellis panels will be created for each value in the column or hierarchy.
`hierarchyOption`	SpotfireTrellisAxisHierarchyOptions {Enum} ▼	[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.
	Enum options: nest, cross
`columnAxis`	trellisAxisDescription ▼	A column with trellis panels will be created for each value in the column or hierarchy.
`hierarchyOption`	SpotfireTrellisAxisHierarchyOptions {Enum} ▼	[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.
	Enum options: nest, cross
`pageAxis`	trellisAxisDescription ▼	A new page with trellis panels will be created for each value in the column or hierarchy.
`hierarchyOption`	SpotfireTrellisAxisHierarchyOptions {Enum} ▼	[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.
	Enum options: nest, cross
`panelAxis`	trellisAxisDescription ▼	Specifies the column or hierarchy to define the categories by which the visualization should be split.
`hierarchyOption`	SpotfireTrellisAxisHierarchyOptions {Enum} ▼	[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.
	Enum options: nest, cross
`manualLayout`	Boolean	[Available for 'Panels' only.] To manually specify the number of rows and columns that should be visible without scrolling.
`maxNumberOfRows`	Number	[Available for 'Panels' only.] Specifies the maximum number of panels that should be visible on each page.
`maxNumberOfColumns`	Number	[Available for 'Panels' only.] Specifies the maximum number of panels that should be visible on each page.
`[ 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.
`[ 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.
`[ 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