Class pvc.options.plots.MetricPointPlot

Extends CartesianPlot.

Class Summary
Constructor Attributes	Constructor Name and Description
	MetricPointPlot The common options documentation class of the metric point plots.

Field Summary
Field Attributes	Field Name and Description
Axes
	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.
	trend Contains the plot's trending options.
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
	dotsVisible Indicates if the visual elements show dots/markers in each point's position.
	extensionPoints The extension points object contains style definitions for the marks of the plot.
	linesVisible Indicates if the visual elements are connected with lines.
	nullShape The shape to use when the value of the size role is `null`.
	shape Forces a given shape to be used in the dot mark.
<deprecated>	showDots Indicates if the visual elements show dots/markers in each point's position.
<deprecated>	showLines Indicates if the visual elements are connected with lines.
<deprecated>	showValues Indicates if value labels are shown next to the visual elements.
	valuesAnchor The alignment of a value label relative to its corresponding visual element position.
	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

pvc.options.plots.MetricPointPlot

The common options documentation class of the metric point plots.

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

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

{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

Default Value:: '{x},{y}'

{boolean} dotsVisible

Indicates if the visual elements show dots/markers in each point's position.

Default Value:: false

{pvc.options.ext.MetricPointPlotExtensionPoints} extensionPoints

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

{boolean} linesVisible

Indicates if the visual elements are connected with lines.

Default Value:: false

{pvc.options.varia.DotShapeType} nullShape

The shape to use when the value of the size role is null.

When the value of #nullShape is null, visual elements with null size value are not shown.

Default Value:: 'cross'

{pvc.options.varia.DotShapeType} shape

Forces a given shape to be used in the dot mark.

Default Value:: 'circle'

<deprecated> {boolean} showDots

Indicates if the visual elements show dots/markers in each point's position.

Deprecated:
Use #dotsVisible instead.

<deprecated> {boolean} showLines

Indicates if the visual elements are connected with lines.

Deprecated:
Use #linesVisible instead.

<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.MarkAnchor} valuesAnchor

The alignment of a value label relative to its corresponding visual element position.

Default Value:: 'right'

{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.MetricPointPlotVisualRoles} 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.MetricPointPlot