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


Extends BarPlotCommon.

Class Summary
Constructor Attributes Constructor Name and Description
 
The options documentation class of the Bar plot.
Field Summary
Field Attributes Field Name and Description
Axes
<constant>  
The index of the color axis to use for the plot.
<constant>  
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
 
The minimum height of a non-null valued bar, in pixel units.
 
The maximum width of a bar, in pixel units.
 
The percentage of the grouped bar width versus the space between grouped bars (does not apply to stacked bars).
 
The space between bars of a given stack, in pixel units (applies to stacked bars).
 
The extension points object contains style definitions for the marks of the plot.
<deprecated>  
The maximum width of a bar, in pixel units.
 
Indicates if overflow and underflow markers are shown when the bars are drawn off the plot area.
<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.
 
Normalize the domain of bars' values by category.
 
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 bar.
 
Indicates if value labels are shown next to the visual elements.
Visual Roles
 
The plot's visual roles map.
Class Detail
pvc.options.plots.BarPlot
The options documentation class of the Bar plot.
Field Detail
<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

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

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

{number} barOrthoSizeMin
The minimum height of a non-null valued bar, in pixel units.

If you want that null-valued bars also show up, as zero bars do, consider using a pvc.options.varia.NullInterpolationMode#Zero #nullInterpolationMode.

If you do not want to show zero-valued bars, then set this option to zero.

A finite number, not less than 0.

Default Value:
1.5
Borrowed from:
BarPlotCommon

{number} barSizeMax
The maximum width of a bar, in pixel units.

A number not less than 1, possibly infinity.

Default Value:
2000
Borrowed from:
BarPlotCommon

{number} barSizeRatio
The percentage of the grouped bar width versus the space between grouped bars (does not apply to stacked bars).

A number between 0.05 and 1.

Default Value:
0.9
Borrowed from:
BarPlotCommon

{number} barStackedMargin
The space between bars of a given stack, in pixel units (applies to stacked bars).

A non-negative number.

Default Value:
0
Borrowed from:
BarPlotCommon

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

<deprecated> {number} maxBarSize
The maximum width of a bar, in pixel units.
Deprecated:
Use #barSizeMax instead.
Default Value:
2000
Borrowed from:
BarPlotCommon

{boolean} overflowMarkersVisible
Indicates if overflow and underflow markers are shown when the bars are drawn off the plot area.

Bars can be drawn off the plot area by use of the continuous axis properties fixedMin and fixedMax.

Default Value:
true
Borrowed from:
BarPlotCommon

<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.
Default Value:
'center'
Borrowed from:
BarPlotCommon

{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} valuesNormalized
Normalize the domain of bars' values by category.
Default Value:
false
Borrowed from:
BarPlotCommon

{boolean} valuesOptimizeLegibility
Indicates if legibility of value labels should be optimized.

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

It is applied only when a value label is considered to be inside its associated bar. Presently, it is considered to be inside, if the center point of the label is within the bounds of the bar.

Default Value:
false
Borrowed from:
BarPlotCommon

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

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

It is also included as a required margin at the side opposite to the label's anchor. For example, if a label is anchored with a bottom textBaseline, the text margin must also be available on the top side of the label.

Also, the same margin is respected on the horizontal sides of the label (left and right), whether or not they are anchor sides.

Default Value:
'hide'
Borrowed from:
BarPlotCommon

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

See BasicPlot#visualRoles for more information.

Borrowed from:
BarPlotCommon

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