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


Extends PointPlot.

Class Summary
Constructor Attributes Constructor Name and Description
 
The options documentation class of the point plot used for the second plot of categorical charts.
Field Summary
Field Attributes Field Name and Description
Axes
 
The index of the color axis to use for the plot.
 
The index of the orthogonal cartesian axis to use for the plot.
Data
 
The data part value of the subset of data that the plot consumes.
 
The interpolation mode used to fill-in null or missing values.
 
Contains the plot's trending options.
General
 
The name of the plot being defined or configured.
 
The type of the plot being defined or configured.
Layout
 
The values mask used to build the text of value labels.
Style
 
A value that is multiplied by the opacity value of the area's base color.
 
Indicates if shaded areas are shown in the plot.
 
Indicates if the visual elements show dots/markers in each point's position.
 
The extension points object contains style definitions for the marks of the plot.
 
Indicates if the visual elements are connected with lines.
<deprecated>  
Indicates if the visual elements are connected with shaded areas extending from the visual elements to the zero line.
<deprecated>  
Indicates if the visual elements show dots/markers in each point's position.
<deprecated>  
Indicates if the visual elements are connected with lines.
<deprecated>  
Indicates if value labels are shown next to the visual elements.
 
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.
 
The alignment of a value label relative to its corresponding visual element position.
 
The font of a value label.
 
Indicates if value labels are shown next to the visual elements.
Visual Roles
 
The plot's visual roles map.
Class Detail
pvc.options.plots.Plot2PointPlot
The options documentation class of the point plot used for the second plot of categorical charts.
Field Detail
{number} colorAxis
The index of the color axis to use for the plot.
Default Value:
2

{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
Borrowed from:
CategoricalNumericPlot

{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

{pvc.options.varia.PlotTrending} trend
Contains the plot's trending options.

Besides the property concatenation way of specifying this property and its sub-properties, this option may also be specified as a plain JSON object.

Borrowed from:
PointPlot

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

Default Value:
'{value}'
Borrowed from:
PointPlot

{number} areasFillOpacity
A value that is multiplied by the opacity value of the area's base color.

A non-negative number, possibly Infinity.

This option is ignored unless #areasVisible is true and the plot is not stacked.

Default Value:
0.5
Borrowed from:
PointPlot

{boolean} areasVisible
Indicates if shaded areas are shown in the plot.

Specifically, indicates if the visual elements are connected with shaded areas extending from the visual elements to the zero line.

Default Value:
false
Borrowed from:
PointPlot

{boolean} dotsVisible
Indicates if the visual elements show dots/markers in each point's position.
Default Value:
true

{pvc.options.ext.PointPlotExtensionPoints} extensionPoints
The extension points object contains style definitions for the marks of the plot.
Borrowed from:
PointPlot

{boolean} linesVisible
Indicates if the visual elements are connected with lines.
Default Value:
true

<deprecated> {boolean} showAreas
Indicates if the visual elements are connected with shaded areas extending from the visual elements to the zero line.
Deprecated:
Use #areasVisible instead.
Borrowed from:
PointPlot

<deprecated> {boolean} showDots
Indicates if the visual elements show dots/markers in each point's position.
Deprecated:
Use #dotsVisible instead.
Borrowed from:
PointPlot

<deprecated> {boolean} showLines
Indicates if the visual elements are connected with lines.
Deprecated:
Use #linesVisible instead.
Borrowed from:
PointPlot

<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
Borrowed from:
CategoricalNumericPlot

{pvc.options.varia.MarkAnchor} valuesAnchor
The alignment of a value label relative to its corresponding visual element position.

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

See BasicPlot#visualRoles for more information.

Borrowed from:
PointPlot

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