Model Index

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.PiePlot


Extends Plot.

Class Summary
Constructor Attributes Constructor Name and Description
 
The options documentation class of the Pie plot.
Field Summary
Field Attributes Field Name and Description
Axes
<constant>  
The index of the color axis to use for the plot.
Data
 
The data part value of the subset of data that the plot consumes.
General
 
The name of the plot being defined or configured.
 
The type of the plot being defined or configured.
Layout
 
Increment radius of an active slice, in pixel units or as a percentage.
 
The index of the exploded slice, or null, for all slices to be exploded.
 
Increment radius of an exploded slice, in pixel units or as a percentage.
 
The style used to place value labels.
 
The values mask used to build the text of value labels.
Layout > Linked Labels
 
The width of the link line handle width, in em units.
 
The length of the link line segment that is inset into a slice, in pixel units, or as a percentage.
 
The width of the columns reserved, on each side of the pie, for laying out the linked label marks.
 
The minimum vertical space between consecutive link labels, in em units.
 
The width of the space that separates the label from the end of the line segment that starts in the link elbow, in pixel units, or as a percentage.
 
The length of the link line segment that extends outwards from the slice, until it reaches the link line "elbow", in pixel units, or as a percentage.
Style
 
The extension points object contains style definitions for various visual elements of the chart.
<deprecated>  
Indicates if value labels are shown next to the visual elements.
 
The alignment of a value label relative to its corresponding visual element position.
 
The font of a value label.
 
Indicates if legibility of value labels should be optimized.
 
The behavior to apply when the text of a value label does not fit within the bounds of its associated slice.
 
Indicates if value labels are shown next to the visual elements.
Visual Roles
 
The plot's visual roles map.
Class Detail
pvc.options.plots.PiePlot
The options documentation class of the Pie 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

{number|string} activeSliceRadius
Increment radius of an active slice, in pixel units or as a percentage.

When the value is a string, and if it is suffixed with "%", it represents a percentage of the biggest radius that can fit in the client area of the plot.

This property is only relevant if pvc.options.charts.Chart#hoverable is true.

The normal radius is the biggest radius that can fit in the client area of the plot minus the space occupied by linked labels, minus the resolved active radius and minus the resolved exploded radius.

See #explodedSliceRadius.

Default Value:
'5%'

{number} explodedSliceIndex
The index of the exploded slice, or null, for all slices to be exploded.

The exploded slice or slices are shown exploded only when #explodedSliceRadius is greater than 0.

Default Value:
null

{number|string} explodedSliceRadius
Increment radius of an exploded slice, in pixel units or as a percentage.

When the value is a string, and if it is suffixed with "%", it represents a percentage of the biggest radius that can fit in the client area of the plot.

The normal radius is the biggest radius that can fit in the client area of the plot minus the space occupied by linked labels, minus the resolved active radius and minus the resolved exploded radius.

See #activeSliceRadius and #explodedSliceIndex.

Default Value:
0

{pvc.options.varia.PieValuesLabelStyle} valuesLabelStyle
The style used to place value labels.
Default Value:
'linked'

{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:

The default value depends on the label style:

The percent variable is a sub-variable of the value scene variable.


{number} linkHandleWidth
The width of the link line handle width, in em units.

The handle is the last segment of the link line, an horizontal line segment just before the label.

Default Value:
0.5

{number|string} linkInsetRadius
The length of the link line segment that is inset into a slice, in pixel units, or as a percentage.

When the value is a string, and if it is suffixed with "%", it represents a percentage of the biggest radius that can fit in the client area of the plot.

Default Value:
'5%'

{number|string} linkLabelSize
The width of the columns reserved, on each side of the pie, for laying out the linked label marks.

When the value is a string, and if it is suffixed with "%", it represents a percentage of the client width of the plot.

Default Value:
'15%'

{number} linkLabelSpacingMin
The minimum vertical space between consecutive link labels, in em units.
Default Value:
0.5

{number|string} linkMargin
The width of the space that separates the label from the end of the line segment that starts in the link elbow, in pixel units, or as a percentage.

The value of this property includes the size of the link line handle.

When the value is a string, and if it is suffixed with "%", it represents a percentage of the client width of the plot.

Default Value:
'2.5%'

{number|string} linkOutsetRadius
The length of the link line segment that extends outwards from the slice, until it reaches the link line "elbow", in pixel units, or as a percentage.

When the value is a string, and if it is suffixed with "%", it represents a percentage of the biggest radius that can fit in the client area of the plot.

Default Value:
'2.5%'

{pvc.options.ext.PiePlotExtensionPoints} 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.WedgeAnchor} valuesAnchor
The alignment of a value label relative to its corresponding visual element position.

Specifically, this property applies to non-linked labels.

Default Value:
'outer'

{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.

Only applies when #valuesLabelStyle is inside.

The current algorithm varies the text color so that it has enough contrast for the fill color of the associated pie slice.

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:
false

{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:

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.PiePlotVisualRoles} visualRoles
The plot's visual roles map.

See BasicPlot#visualRoles for more information.


Documentation generated by JsDoc Toolkit 2.4.0 on Thu Dec 20 2018 15:47:44 GMT-0000 (WET)