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.ext.WaterfallPlotExtensionPoints


Extends BarPlotCommonExtensionPoints.

Class Summary
Constructor Attributes Constructor Name and Description
 
The extension points of the waterfall plot type.
Field Summary
Field Attributes Field Name and Description
 
_
The extension point of the bar mark.
 
The extension point of the group panel mark.
 
The extension point of the value label mark.
 
The extension point of the top water line mark.
 
The extension point of the category total label mark, that is placed near the water line.
 
The extension point of the overflow marker.
 
The extension point of the series panel of the bar plot.
 
The extension point of the underflow marker.
Class Detail
pvc.options.ext.WaterfallPlotExtensionPoints
The extension points of the waterfall plot type.

Plot extension points can be specified:

  • at the plot level, in the extensionPoints property, without need to prefix the extension point with the plot id or name.
  • at the plot options level, directly, without need to prefix the extension point with the plot id or name.
  • if it is an internal plot ( main, plot2 or trend), at the chart options level, directly.

To use an extension point you must find its full name, by joining:

  1. plot property name (ex: water)
  2. extension property (ex: line)
  3. the "_" character
  4. extension sub-property (ex: strokeStyle)
and obtaining, for the examples, the camel-cased name: waterLine_strokeStyle (see http://en.wikipedia.org/wiki/CamelCase).

The extension points of the main plot of a chart may be used without the plot property name prefix. In the example, when the water plot is the main plot, the extension point can be written as line_strokeStyle.

Field Detail
{pvc.options.marks.BarExtensionPoint} _
The extension point of the bar mark.

This extension point can only be used by prefixing it with the property name of the plot.

So, supposing this plot is under a property named bar, and it is desired to access the strokeStyle property of the bar mark, the full name of the extension property would be bar_strokeStyle.

Borrowed from:
BarPlotCommonExtensionPoints

{pvc.options.marks.PanelExtensionPoint} group
The extension point of the group panel mark.

The group panel visually contains all bars that belong to the same group.


{pvc.options.marks.LabelExtensionPoint} label
The extension point of the value label mark.
Borrowed from:
BarPlotCommonExtensionPoints

{pvc.options.marks.LineExtensionPoint} line
The extension point of the top water line mark.

{pvc.options.marks.LabelExtensionPoint} lineLabel
The extension point of the category total label mark, that is placed near the water line.

{pvc.options.marks.DotExtensionPoint} overflowMarker
The extension point of the overflow marker.
Borrowed from:
BarPlotCommonExtensionPoints

{pvc.options.marks.PanelExtensionPoint} panel
The extension point of the series panel of the bar plot.
Borrowed from:
BarPlotCommonExtensionPoints

{pvc.options.marks.DotExtensionPoint} underflowMarker
The extension point of the underflow marker.
Borrowed from:
BarPlotCommonExtensionPoints

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