Class pvc.options.plots.SunburstPlot

Extends Plot.

Class Summary
Constructor Attributes	Constructor Name and Description
	SunburstPlot The options documentation class of the Sunburst plot.

Field Summary
Field Attributes	Field Name and Description
Axes
<constant>	colorAxis The index of the color axis to use for the plot.
Data
	dataPart The data part value of the subset of data that the plot consumes.
General
	name The name of the plot being defined or configured.
	type The type of the plot being defined or configured.
Layout
	valuesMask The values mask used to build the text of value labels.
Style
	colorMode Controls how colors are drawn from the color scale to paint visual elements.
	emptySlicesLabel Defines a label to use for empty slices.
	emptySlicesVisible Indicates if empty slices should be shown.
	extensionPoints The extension points object contains style definitions for various visual elements of the chart.
<deprecated>	showValues Indicates if value labels are shown next to the visual elements.
	sliceOrder The slices' layout order.
<constant>	valuesAnchor The sunburst's value label is always anchored to the center of the associated slice.
	valuesFont The font of a value label.
	valuesOptimizeLegibility Indicates if legibility of value labels should be optimized.
	valuesOverflow The behavior to apply when the text of a value label does not fit within the bounds of its associated slice.
	valuesVisible Indicates if value labels are shown next to the visual elements.
Visual Roles
	visualRoles The plot's visual roles map.

Class Detail

pvc.options.plots.SunburstPlot

The options documentation class of the Sunburst plot.

Field Detail

<constant> {number} colorAxis

The index of the color axis to use for the plot.

{string} dataPart

The data part value of the subset of data that the plot consumes.

This option can only be used in code, from within pvc.options.charts.BasicChart#plots.

By default, for internal plots, like main and plot2, data is partitioned into two data parts, "0" and "1", respectively, according to the chart's plot2Series, or plot2SeriesIndexes, options (depending on the chart type, pvc.options.charts.BarChart#plot2Series, or pvc.options.charts.PointChart#plot2Series).

The internal trend plot, by default, represents the data part value "trend".

For external plots, the default data part value is "0".

See pvc.options.charts.BasicChart#dataPartRole for more information.

Borrowed from:: Plot

{string} name

The name of the plot being defined or configured.

This option can only be used in code, from within pvc.options.charts.BasicChart#plots.

To configure an internal plot, its reserved name is specified:

main: the main plot of a chart; for example, a bar chart has a main plot of type bar
plot2: the special second plot; this is the plot that, in applicable chart types, is activated when the option plot2 is true; configuring the second plot this way implicitly activates it, and the value of option plot2 is ignored.
trend: the special trend plot; this is the plot that, in applicable chart types, is activated when other plots specify one of the options trend or trendType.

In this case, if Plot#type is also specified, it must match the plot type of the corresponding internal plot.

To define a new plot, specify a Plot#type and, no name, or one that is not reserved.

The name of a plot cannot have dot (".") character in it.

Borrowed from:: Plot

{string} type

The type of the plot being defined or configured.

This option can only be used in code, from within pvc.options.charts.BasicChart#plots.

The current list of plot types is:

bar: bar plot
water: waterfall plot
box: box plot
heatGrid: heat-grid plot
point: point plot (area/line/dot)
scatter: metric point plot (area/line/dot)
pie: pie
sunburst: sunburst
treemap: treemap
bullet: bullet

See Plot#name for more information.

Borrowed from:: Plot

{string} valuesMask

The values mask used to build the text of value labels.

The mask may contain scene variable names and/or scene atom names, like in the examples:

scene variables: {category}: {value} EUR, could yield Drinks: 3.45 EUR
atom variables: {#family} - {#product}, could yield Plains - Boeing 747

The default value depends on the plot type.

Borrowed from:: Plot

{pvc.options.varia.SunburstColorMode} colorMode

Controls how colors are drawn from the color scale to paint visual elements.

Default Value:: 'fan'

{string} emptySlicesLabel

Defines a label to use for empty slices. Only applicable if SunburstPlot#emptySlicesVisible is true.

{boolean} emptySlicesVisible

Indicates if empty slices should be shown. Shown empty slices will have the same color as their parent slice.

Default Value:: false

{pvc.options.ext.SunburstPlotExtensionPoints} extensionPoints

The extension points object contains style definitions for various visual elements of the chart.

<deprecated> {boolean} showValues

Indicates if value labels are shown next to the visual elements.

Deprecated:
Use #valuesVisible instead.

Default Value:: false

Borrowed from:: Plot

{pvc.options.varia.SliceOrder} sliceOrder

The slices' layout order.

<constant> {pvc.options.varia.MarkAnchor} valuesAnchor

The sunburst's value label is always anchored to the center of the associated slice.

{string} valuesFont

The font of a value label.

This property can also be specified through the "label" extension point of a plot.

In some charts the value label font is taken into account for layout purposes.

Default Value:: '10px sans-serif'

Borrowed from:: Plot

{boolean} valuesOptimizeLegibility

Indicates if legibility of value labels should be optimized.

The current algorithm varies the text color so that it has enough contrast for the known background color.

It is applied only when a value label is considered to be inside its associated slice. Presently, it is considered to be inside, if the center point of the label is within the bounds of the slice.

Default Value:: true

{pvc.options.varia.ValuesOverflow} valuesOverflow

The behavior to apply when the text of a value label does not fit within the bounds of its associated slice.

This option applies only when Plot#valuesVisible is true.

Moreover, it also applies only for certain configurations of value label placement, relative to the associated slice. Presently, the supported placements are:

non-negative text margin, pvc.options.marks.LabelExtensionPoint#textMargin.
text align is center — pvc.options.marks.LabelExtensionPoint#textAlign is pvc.options.varia.TextAlignment#Center,
text is aligned with the middle angle of the slice — the label has a pvc.options.marks.LabelExtensionPoint#textAngle (modulo) equal to the middle angle of the slice.

When an unsupported placement occurs, the label is shown.

Note that for the purposes of hiding and trimming, the value of pvc.options.marks.LabelExtensionPoint#textMargin is used for more that the distance between the anchor points of the label and the slice. It is also included as a required margin at the opposite side of the configured text alignment. Also, half of the text margin is included on the bottom and top sides.

Default Value:: 'hide'

{boolean} valuesVisible

Indicates if value labels are shown next to the visual elements.

Default Value:: true

{map(string : pvc.options.VisualRole)|pvc.options.visualRoles.SunburstPlotVisualRoles} visualRoles

The plot's visual roles map.

Types By Namespace

cdo

def

pvc

pvc.data

pvc.options

pvc.options.axes

pvc.options.charts

pvc.options.ext

pvc.options.format

pvc.options.marks

pvc.options.panels

pvc.options.plots

pvc.options.varia

pvc.options.visualRoles

pvc.visual

Class pvc.options.plots.SunburstPlot