Class

SpotfirePieChart

SpotfirePieChart(pieChartProperties)

Constructor

new SpotfirePieChart(pieChartProperties)

Parameters:
Name Type Description
pieChartProperties Object
[ size ] Object
sectorSizeBy Array.<String>

Specifies a column or hierarchy whose categories will determine the size of the pie sectors. This is always an aggregated measure.
pieSize Number

Specifies the absolute pie size within the visualization area.
pieSizeBy String

Sizes the pies according to the values in the specified column. Only relevant when there are more than one pie available (via trellising).
scaleRange Object

Determines what scale to use for the size of the pie. Only relevant when there are more than one pie available (via trellising).
min Number

Minimum limit that should be mapped to the pie size. Leave null to set it to "Automatic".
max Number

Maximum limit that should be mapped to the pie size. Leave null to set it to "Automatic".
[ colors ] SpotfireColorAxis
[ labels ] Object
showSectorPercentage Boolean

Specifies whether ot not to display labels showing the percentage of the total that each sector represents.
showSectorValue Boolean

Specifies whether or not to display the value of the sector. For example, sum of sales for apples, if the sector size is defined by sum of sales and the color is defined by fruit or vegetable type.
showSectorCategory Boolean

Specifies whether or not to display the category defining the sector. For example, "apples", if the sector color is defined by fruit or vegetable type.
labelPosition SpotfireLabelPositions ▼

Specifies whether the labels should be placed 'Inside pie' or 'Outside pie'.
inside String

The label is placed inside the marker.
outside String

The label is placed outside the marker.
showLabelsFor SpotfireLabelVisibilities

Determines whether to show labels for all pie sectors ('All'), pie sectors 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.
sectorPercentageThreshold Number

Excludes the labels for the sectors whose percentage falls below the specified threshold value.
sectorPercentageDecimals Number

Specifies the number of decimals to display for the percentage value. The number specified here will also affect the number of decimals shown for pie sectors in the tooltip.