Class

SpotfireBoxPlot

SpotfireBoxPlot(boxPlotProperties)

Represents a Box Plot.

Constructor

new SpotfireBoxPlot(boxPlotProperties)

Parameters:
Name Type Description
boxPlotProperties Object
appearance Object
orientation SpotfireBarChartOrientations ▼

Specifies if the bars should be displayed vertically or horizontally in the visualization.
vertical String

To display the bars in the visualization vertically.
Other accepted values: 'Vertical bars', 'Vertical'.
horizontal String

To display the bars in the visualization horizontally.
Other accepted values: 'Horizontal bars', 'Horizontal'.
layout SpotfireBarChartLayouts ▼

Specifies how to place bars in the visualization.
sideBySide String

To place bars from the color category side-by-side instead of stacked on top of each other.
Other available values: 'Side-by-side bars', 'None'.
stack String

To keep color categories stacked on top of each other. Note: This option should not be used if you want to display error bars in the bar chart.
Other available values: 'Stacked bars', 'Stack'.
stack100Percent String

to set the heights of all bars to 100%. The size of the bar segments represents how much of the percentage of the total sum for the group is constituted of the sums of the values in the category. The exact percentage of each category can be seen in the tooltip displayed when hovering with the mouse pointer over a bar segment. Note: This option should not be used if you want to display error bars in the bar chart.
Other available values: 'Stacked bars', 'Stack'.
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.
sortedBarSegmentsByValue 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.
sortSegmentsBySize Boolean

Specifies whether or not the bar segments should be sorted by value.
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.