Connector JavaScript API Reference

Constructor

new SpotfireBarChart([barChartProperties])

Parameters:

Name	Type	Description
`[ barChartProperties ]`	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.
`orientation`	SpotfireBarChartOrientations {Enum} ▼	Specifies if the bars should be displayed vertically or horizontally in the visualization.
	Enum options: vertical, horizontal
`layout`	SpotfireBarChartLayouts {Enum} ▼	Specifies how to place bars in the visualization.
	Enum options: sideBySide, stack, stack100Percent
`barWidth`	Number	Specifies the width of the bars, between 0 and 100.
`showShadowBars`	Boolean	Specifies whether or not a gray shadow should be shown behind all visible bars, indicating the height of the bar if all filters are reset and all data is available.
`sortBarsByValue`	Boolean	Specifies whether or not the bars should be sorted from the highest to the lowest bar. When filtering is applied, the sorting is updated.
`sortSegmentsBySize`	Boolean	Specifies whether or not the bar segments should be sorted within each stacked bar by size. The highest segment is placed at the base of the bar, and the lowest segment at the top.
`reverseBarSegmentOrder`	Boolean	Specifies whether or not the current order of the bar segments in each bar should be reversed, that is, the segment currently placed at the top will be placed at the bottom, the segment next to top will be placed second-bottom, and so on.
`compensateForMissingValues`	Boolean	Use this option if you are using a Date, Time or DateTime column somewhere in the visualization and you need 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 option to true will produce a bar of the same size as the previous bar instead of showing no bar at all. Enabling this setting will temporarily add new rows with empty values for the missing periods so that they can be used in the calculation.
`[ xAxis ]`	SpotfireScaleAxis
`[ yAxis ]`	SpotfireScaleAxis
`[ colors ]`	SpotfireColorAxis
`[ tooltip ]`	SpotfireTooltip ▼
`tooltipItems`	Array.<TooltipItemDescription> ▼
`[].expression`	string	the expression to be used to create the tooltip item
`[].size`	number	the size of the tooltip item
`[].renderer`	RendererDescription	the renderer description to be used
`displayItems`	Array.<String>	Specifies which tooltip items will be shown by their names (specified by "as [tooltip name]" in the expression field). Note: You can use the axis names such as "X", "Category axis", "Color by", "Size by", etc. to display default tooltips.
`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	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.
`[ 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 ▼
`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`	String \| 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`	String \| 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.
`byExpression`	String	Specifies the boolean expression to use for limiting the data 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 {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, 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.
`[].name`	String	The name of the legend item to modify, as it is displayed in the user interface.
`[].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.
`[].showAxisSelector`	Boolean	Specifies whether or not the axis selector for the legend item should be shown.
`[ showHideItemsRules ]`	Array.<visualShowHideItemsRuleDescription> ▼
`[].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
`[ labels ]`	Object
`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').
`labelOrientation`	SpotfireLabelOrientations {Enum} ▼	Determines whether to display the labels horizontally or vertically.
	Enum options: horizontal, vertical
`completeBar`	Boolean	Determines whether or not to show labels on the complete bar.
`barSegments`	Boolean	Determines whether or not to show labels on the bar segments.
`labelType`	SpotfireLabelInformationTypes	Specifies whether to display the value of the bar segment ('Value') or the percentage of the bar segments in relation to the total value ('Percentage').
`maxNumberOfLabels`	Number	Specifies the maximum number of labels to be shown. If the number is smaller than the available number of bars, the labels will be equally distributed along the category axis.
`barPercentageDecimals`	Number	Specifies the number of decimals to show when 100% bars are used.