Class pvc.options.plots.CategoricalNumericPlot

Extends CategoricalPlot.

Class Summary
Constructor Attributes	Constructor Name and Description
<abstract>	CategoricalNumericPlot The common options documentation class of categorical plot types with a continuous-numeric orthogonal axis.

Field Summary
Field Attributes	Field Name and Description
Axes
	colorAxis The index of the color axis to use for the plot.
	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
	valuesMask The values mask used to build the text of value labels.
Style
<deprecated>	showValues Indicates if value labels are shown next to the visual elements.
	stacked Indicates that visual elements having identical category, but different series, are displayed on top of each other, along the plot's orthogonal direction, instead of side-by-side, along the base direction.
	valuesAnchor The point of a visual element onto which the associated value label is anchored to.
	valuesFont The font of a value label.
	valuesVisible Indicates if value labels are shown next to the visual elements.
Visual Roles
	visualRoles The plot's visual roles map.

Class Detail

<abstract> pvc.options.plots.CategoricalNumericPlot

The common options documentation class of categorical plot types with a continuous-numeric orthogonal axis.

Field Detail

{number} colorAxis

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

The possible values are 1, 2 and 3.

The default value depends on the plot. The main plot of a chart always uses the axis 1. The plot2 plot uses the axis 2, by default. The trend plot uses the axis 3, by default.

Borrowed from:: Plot

{number} orthoAxis

The index of the orthogonal cartesian axis to use for the plot.

The possible values are 1, 2 and 3.

The main plot of a chart always uses the axis 1.

Default Value:: 1

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

{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

<deprecated> {boolean} showValues

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

Deprecated:
Use #valuesVisible instead.

Default Value:: false

Borrowed from:: Plot

{boolean} stacked

Indicates that visual elements having identical category, but different series, are displayed on top of each other, along the plot's orthogonal direction, instead of side-by-side, along the base direction.

Default Value:: false

{pvc.options.varia.MarkAnchor|pvc.options.varia.WedgeAnchor} valuesAnchor

The point of a visual element onto which the associated value label is anchored to.

The possible values and the default value actually depend on the chart type so be sure to access this property's documentation through the concrete class' documentation.

Borrowed from:: Plot

{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} valuesVisible

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

Most charts have some form of showing labels with the main value next to the visual element.

The default value really varies with the chart type, so be sure to confirm it in the most specific plot class.

Default Value:: false

Borrowed from:: Plot

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

The plot's visual roles map.

See BasicPlot#visualRoles for more information.

Borrowed from:: CategoricalPlot

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