Class pvc.options.plots.BoxplotPlot

Extends CategoricalNumericPlot.

Class Summary
Constructor Attributes	Constructor Name and Description
	BoxplotPlot The options documentation class of the Box plot.

Field Summary
Field Attributes	Field Name and Description
	layoutMode The placement of boxes within the same category band.
<constant>	stacked The box plot only shows a single series of data and, as such, this property is meaningless.
Axes
<constant>	colorAxis The index of the color axis to use for the plot.
<constant>	orthoAxis The index of the orthogonal cartesian axis to use for the plot.
Data
	dataPart The data part value of the subset of data that the plot consumes.
	nullInterpolationMode The interpolation mode used to fill-in null or missing values.
General
	name The name of the plot being defined or configured.
	type The type of the plot being defined or configured.
Layout
<constant>	valuesMask This plot type does not have value labels.
Style
	boxSizeMax The maximum width of a box plot bar, in pixel units.
	boxSizeRatio The percentage of box space over total space in a category band and with a grouped layout.
	extensionPoints The extension points object contains style definitions for the marks of the plot.
<deprecated>	maxBoxSize The maximum width of a box plot bar, in pixel units.
<deprecated>	showValues Indicates if value labels are shown next to the visual elements.
<constant>	valuesAnchor This plot type does not have value labels.
<constant>	valuesFont This plot type does not have value labels.
<constant>	valuesVisible This plot type does not have value labels.
Visual Roles
	visualRoles The plot's visual roles map.

Class Detail

pvc.options.plots.BoxplotPlot

The options documentation class of the Box plot.

Field Detail

{pvc.options.varia.BoxLayoutMode} layoutMode

The placement of boxes within the same category band.

Default Value:: 'grouped'

<constant> {boolean} stacked

The box plot only shows a single series of data and, as such, this property is meaningless.

<constant> {number} colorAxis

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

<constant> {number} orthoAxis

The index of the orthogonal cartesian 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

{pvc.options.varia.NullInterpolationMode} nullInterpolationMode

The interpolation mode used to fill-in null or missing values.

The interpolation is applied to the measure roles of the plot that are represented in the orthogonal cartesian axis.

With the exception of the box plot, this role is the value role. All of the box plot measure roles: median, lowerQuartil, upperQuartil, minimum, and maximum, are interpolated using the specified mode.

Default Value:: 'none'

Borrowed from:: CategoricalNumericPlot

{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

<constant> {string} valuesMask

This plot type does not have value labels.

{number} boxSizeMax

The maximum width of a box plot bar, in pixel units.

A number not less than 1, possibly infinity.

Default Value:: Infinity

{number} boxSizeRatio

The percentage of box space over total space in a category band and with a grouped layout.

Only relevant when there are multiple series and BoxplotPlot#layoutMode is grouped.

The empty space is uniformly distributed between boxes.

Bands may have space between them, depending on the base axis' pvc.options.axes.DiscreteCartesianAxis#bandSizeRatio.

A number between 0.05 and 1.

The default value is 0.9.

Default Value:: 0.333

{pvc.options.ext.BoxplotPlotExtensionPoints} extensionPoints

The extension points object contains style definitions for the marks of the plot.

<deprecated> {number} maxBoxSize

The maximum width of a box plot bar, in pixel units.

Deprecated:
Use #boxSizeMax instead.

Default Value:: Infinity

<deprecated> {boolean} showValues

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

Deprecated:
Use #valuesVisible instead.

Default Value:: false

Borrowed from:: Plot

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

This plot type does not have value labels.

<constant> {string} valuesFont

This plot type does not have value labels.

<constant> {boolean} valuesVisible

This plot type does not have value labels.

{map(string : pvc.options.VisualRole)|pvc.options.visualRoles.BoxplotPlotVisualRoles} 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.BoxplotPlot