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.charts.TreemapChart


Extends Chart.

Class Summary
Constructor Attributes Constructor Name and Description
 
The options documentation class of the Treemap chart.
Field Summary
Field Attributes Field Name and Description
Axes
 
The first color axis options.
 
The size axis options.
Chart
 
The extension points object contains style definitions for the marks of the plot.
 
Indicates if the layout should be preserved between renders.
Chart - Multi > Layout
 
The maximum number of small charts that should be displayed in a row.
 
The maximum number of small charts that should be displayed.
 
The strategy to follow when the resulting multi-chart layout does not fit entirely in the initial chart size.
 
Indicates that, when the layout results in a single column and the value of #smallHeight is still to be determined, it should be set to all the initially available content height, instead of determining the height from the #smallAspectRatio and the #smallWidth.
 
Indicates that, when the layout results in a single row and the value of #smallHeight is still to be determined, it should be set to all the initially available content height, instead of determining the height from the #smallAspectRatio and the #smallWidth.
 
The ratio of the width over the height of a small chart.
 
The margins of the content panel of a small chart.
 
The paddings of the content panel of a small chart.
 
Fixates the height of each small chart, in pixel units or as a percentage.
 
The margins of a small chart.
 
The paddings of a small chart.
 
Fixates the width of each small chart, in pixel units or as a percentage.
Chart > Data
 
An array of dimensions calculations.
 
A map whose keys are the dimension type group names and whose values are the default dimension type group options.
 
A map whose keys are the dimension type names and whose values are the dimension type options.
 
The chart's format provider.
 
The separator used to join the labels of the values of a multi-dimensional visual role.
 
Indicates if datums whose value in every measure dimension is null are ignored.
 
Indicates the existence of the sliding window.
<constant>  
This chart type does not support this property.
<constant>  
This chart type does not support this property.
Chart > Data Source
 
Indicates if the data source is in the crosstab format, or, when false, the relational format.
 
The number of columns of the "categories" physical group that the data source contains.
 
Indicates if the data source translation should ignore the column labels present in the data source's metadata as defaults for the labels of dimensions that are directly loaded from those columns.
 
Indicates if multiple measures "are in" columns or in rows (applies to crosstab data format).
 
The separator character used to join multiple values in the crosstab format, and to build composite keys for multiple level groupings.
 
The confirmation mode of the column types declared in a dataset's metadata.
 
Indicates if the data source contains multiple columns of the "measures" physical group.
 
The indexes of columns of the "measures" physical group (applies to relational data format).
 
The indexes of columns of the logical table that are to feed the default multiChart, multiChart2, .
 
A list of dimension names to load from corresponding logical table columns.
 
Swaps the columns of the "series" and "categories" physical groups.
Chart > General
 
The identifier of the HTML element, or the element itself, where the chart is to be created in.
 
The set of compatibility flags.
 
The CCC version that the chart should run in.
Chart > Interaction
 
Indicates if a chart should show an entry animation, every time it is fully rendered.
 
Controls if and how the selection can be cleared by the user.
 
Indicates if the chart is clickable by the user.
 
When true, indicates that a selection made by the user replaces the current selection, if any.
 
The maximum number of milliseconds, between two consecutive clicks, for them to be considered a double-click.
 
Indicates if the chart's visual elements are automatically highlighted when the user hovers over them with the mouse.
 
Indicates if chart interaction is enabled.
 
Contains options related to the way the pointing events are handled (ex: over, out).
 
The pointing mode used by the chart.
 
Indicates if the chart's visual elements can be selected by the user, by clicking on them or using the rubber-band.
<deprecated>  
Indicates if tooltips are enabled and contains additional tooltip presentation options.
<deprecated>  
Contains additional tooltip presentation options.
 
Indicates if tooltips are enabled and contains additional tooltip presentation options.
Chart > Layout
 
The margins of the root content panel, in pixel units or as a percentage.
 
The paddings of the root content panel, in pixel units or as a percentage.
 
The height of the root chart, in pixels.
 
The margins of the root chart.
 
The chart orientation indicates if its main direction is vertical or horizontal.
 
The paddings of the root chart.
 
The width of the root chart, in pixels.
Chart > Visual Roles
 
The category visual role is a plot-level visual role that allows grouping data points to form a hierarchy.
 
The color visual role is a plot-level visual role that is visually encoded by the color of visual elements.
 
The dataPart visual role is a chart-level visual role that allows partitioning of the data into several datum subsets.
 
The multiChart visual role is a chart-level visual role that allows turning a chart into a small multiples chart, http://en.wikipedia.org/wiki/Small_multiple.
 
The size visual role is a plot-level visual role that is visually encoded by the relative area amongst sibling-leaf rectangles.
 
The chart's visual roles map.
Layout
 
The minimum size of the plot panel, in pixel units.
Panels
 
The legend panel of the root chart.
 
Indicates if the legend panel is visible.
 
The title panel of the root chart.
Panels - Multi
 
The title panel of the small chart.
Plots
 
An array of plots.
 
The treemap plot is the main plot of the treemap chart, which means that its properties may be used without the "treemap" property suffix.
Method Summary
Method Attributes Method Name and Description
Chart > Actions
 
clickAction(scene)
A callback function that is called when the user clicks on a visual element.
 
A callback function that is called when the user double-clicks on a visual element.
 
A callback function that is called before the chart is rendered, but after if has been pre-rendered.
 
A callback function that is called after the chart has finished rendering, including any animations.
 
selectionChangedAction(selectedDatums, selectedChangedDatums)
A callback function that is called when, after selection has changed, the chart is updated to reflect the change.
 
userSelectionAction(selectingDatums, selectingGroup)
A callback function that is called when the user performs a selection, but before the corresponding datums' selected state is actually changed.
Chart > Data
 
A function used to format non-null numeric values as percentages.
 
valueFormat(value)
A function that formats the non-null values of numeric dimensions.
Chart > Data Source
 
dataWhere(datum)
A function that filters datums as they are being loading.
Class Detail
pvc.options.charts.TreemapChart
The options documentation class of the Treemap chart.

Treemap charts display hierarchical data using nested rectangles. They excel in revealing the location of valuable areas buried in a deep hierarchy.

The root data node is represented by the root rectangle, which occupies the whole plot area.

The area of a leaf node is proportional to the percentage of the size dimension over its sibling nodes. The area of a non-leaf node is the sum of the areas of its child nodes. If no size dimension is specified, then all sibling-leaf nodes will have identical areas.

Rectangles are usually colored so that siblings have the same color. This way, it is easy to identify sibling nodes and compare their relative sizes. In this way, the colors that are shown are the colors of leaf nodes' parents.

Default Data Format

For general information on the supported data formats see BasicChart.

The treemap chart employs a non-default logical row to dimensions mapping:

  1. All of the free discrete columns of the logical table generate and load free dimensions of the "category" dimension group: "category", "category2", "category4", ...
  2. The first free continuous column of the logical table generates and loads the "size" dimension, if free.

The following is a possible default layout and dimension assignment:

Index 0 1 2 3
Dimension category category2 category4 size
DataType string string string number

Note that the dimension "category3" was not assigned to index 3, hypothetically because it was not free (was explicitly bound to some index, using a reader).

How To Bind The Color Visual Role

The Treemap's color visual role can only be bound to discrete dimensions.

By default, the color role is bound to the dimensions of the category role — its default source role.

The color role can also be bound to other discrete dimension(s), explicitly.

Solution 1

One possibility is to switch one of the automatically fed "category" dimensions to the color visual role. For example:
categoryRole: "category", // steal one here
colorRole:    "category2" // and assign it here

Solution 2

Another possibility is to configure the BasicChart#readers with the actual layout, using the default dimension names of the desired visual roles. For example:
readers: "color, category, category2, size"

Solution 3

Of course, you can (and probably should) use actual business names for the names of dimensions. To that end, both the readers and the visual roles' mappings need to be specified:
readers:      "orderType, productFamily, productType, sales"
categoryRole: "productFamily, productType",
colorRole:    "orderType",
sizeRole:     "sales"

Field Detail
{pvc.options.axes.DiscreteColorAxis} color
The first color axis options.

This axis can also be accessed by the property name color.

See pvc.options.axes.ColorAxis for more information on the way that the color axes' properties may be accessed.


{pvc.options.axes.SizeAxis} sizeAxis
The size axis options.

{pvc.options.ext.TreemapChartExtensionPoints} extensionPoints
The extension points object contains style definitions for the marks of the plot.

{boolean} preserveLayout
Indicates if the layout should be preserved between renders.
Default Value:
false
Borrowed from:
Chart

{number} multiChartColumnsMax
The maximum number of small charts that should be displayed in a row.

This property can receive a value of Infinity to indicate that all charts should be laid out in a single row.

Default Value:
3

{number} multiChartMax
The maximum number of small charts that should be displayed.

The first small charts are chosen.

Default Value:
Infinity

{pvc.options.varia.MultiChartOverflow} multiChartOverflow
The strategy to follow when the resulting multi-chart layout does not fit entirely in the initial chart size.
Default Value:
'grow'

{boolean} multiChartSingleColFillsHeight
Indicates that, when the layout results in a single column and the value of #smallHeight is still to be determined, it should be set to all the initially available content height, instead of determining the height from the #smallAspectRatio and the #smallWidth.
Default Value:
true

{boolean} multiChartSingleRowFillsHeight
Indicates that, when the layout results in a single row and the value of #smallHeight is still to be determined, it should be set to all the initially available content height, instead of determining the height from the #smallAspectRatio and the #smallWidth.
Default Value:
true

{number} smallAspectRatio
The ratio of the width over the height of a small chart.

It is used when the set of properties #smallWidth, #smallHeight, #multiChartColumnsMax, #multiChartSingleRowFillsHeight and #multiChartSingleColFillsHeight, is under-specified and is not enough to determine the value of both #smallWidth and #smallHeight.

The default value of the aspect ratio depends on the chart type, but is something around 4/3.


{number|string|pvc.options.varia.Sides} smallContentMargins
The margins of the content panel of a small chart.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:
0

{number|string|pvc.options.varia.Sides} smallContentPaddings
The paddings of the content panel of a small chart.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:
0

{number|string} smallHeight
Fixates the height of each small chart, in pixel units or as a percentage.

A value of type number, or of type string, but with numeric content, is interpreted as being in pixel units.

A value of type string, with numeric content that is suffixed by a "%" character, is interpreted as a percentage of the initially available content height.

This property may cause the small multiples chart to take up a greater width than the one specified in #height.

When this property is unspecified, its value depends on the evaluation of the #smallWidth property, which may impose it a value. If after the evaluation of #smallWidth this property remains unspecified, it is determined as follows.

If the layout will have a single column and the property #multiChartSingleColFillsHeight is true (it is by default) then the height will be the initially available content height.

If the layout will have a single row and the property #multiChartSingleRowFillsHeight is true (it is by default) then the height will be the initially available content height.

Otherwise, the property #smallAspectRatio is used to determine the height of the small chart from its determined width.

The aspect ratio is defaulted to a value that depends on the chart type, but is something around 4/3.


{number|string|pvc.options.varia.Sides} smallMargins
The margins of a small chart.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:
'2%'

{number|string|pvc.options.varia.Sides} smallPaddings
The paddings of a small chart.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:
0

{number|string} smallWidth
Fixates the width of each small chart, in pixel units or as a percentage.

A value of type number, or of type string, but with numeric content, is interpreted as being in pixel units.

A value of type string, with numeric content that is suffixed by a "%" character, is interpreted as a percentage of the initially available content width.

This property may cause the small multiples chart to take up a greater width than the one specified in #width.

When this property is unspecified, a specified finite value, or a defaulted value, of the property #multiChartColumnsMax is used to determine it: by dividing the initially available content width by the maximum number of charts in a row that actually occur (so that if there are less small charts than the maximum that can be placed in a row, these, nevertheless, take up the whole width).

When an infinite value is specified for #multiChartColumnsMax, the small charts are laid out in a single row, and so the width is calculated from the height #smallHeight, using the aspect ratio #smallAspectRatio. The height is defaulted to the initially available content height. The aspect ratio is defaulted to a value that depends on the chart type, but is something around 4/3. The width is then calculated.


{list(pvc.options.DimensionsCalculation)} calculations
An array of dimensions calculations.

Can be specified to calculate the values of certain dimensions.

Borrowed from:
BasicChart

{map(string : pvc.options.DimensionType)} dimensionGroups
A map whose keys are the dimension type group names and whose values are the default dimension type group options.

A dimension type group is a group of dimension types that have a common non-numeric prefix in its name.

This property does not define any dimension types, per si, but allows specifying default values for dimension types of a group, that apply in case they are effectively used.

Borrowed from:
BasicChart

{map(string : pvc.options.DimensionType)} dimensions
A map whose keys are the dimension type names and whose values are the dimension type options.

You don't need to define dimensions unless you want to change their name or properties. Charts automatically define default dimensions to satisfy their visual roles' requirements.

Dimension options can be partial, so that it is possible to override only certain options.

Borrowed from:
BasicChart

{pvc.options.format.FormatProvider} format
The chart's format provider.
Borrowed from:
BasicChart

{string} groupedLabelSep
The separator used to join the labels of the values of a multi-dimensional visual role.

For example, if a visual role, has the dimensions "Territory" and "ProductType", a compound value could be shown as "EMEA ~ Classic Cars".

See also #dataSeparator.

Default Value:
' ~ '
Borrowed from:
BasicChart

{boolean} ignoreNulls
Indicates if datums whose value in every measure dimension is null are ignored.

A dimension is considered a measure dimension if there is at least one measure visual role currently bound to it.

Default Value:
true
Borrowed from:
BasicChart

{boolean|pvc.options.SlidingWindow} slidingWindow
Indicates the existence of the sliding window.
Default Value:
false
Borrowed from:
Chart

<constant> {boolean} timeSeries
This chart type does not support this property.

<constant> {string} timeSeriesFormat
This chart type does not support this property.

{boolean} crosstabMode
Indicates if the data source is in the crosstab format, or, when false, the relational format.
Default Value:
true
Borrowed from:
BasicChart

{number} dataCategoriesCount
The number of columns of the "categories" physical group that the data source contains.

Relational format

Allows splitting the discrete columns between the "series" and "category" physical groups, in a custom way.

By default, if only a single discrete column exists, it is a "category". Otherwise, the first column is a "series" column and all the remaining are "category" columns.

Crosstab format

This is taken to be the number of consecutive discrete columns, from the first, or 1, if there are none.
Borrowed from:
BasicChart

{boolean} dataIgnoreMetadataLabels
Indicates if the data source translation should ignore the column labels present in the data source's metadata as defaults for the labels of dimensions that are directly loaded from those columns.

The capability to use the data source's provided metadata labels is most useful in the relational format, i.e., when #crosstabMode is false. The crosstab format does not provide metadata information for the series/columns data. Also, only when both #isMultiValued and #dataMeasuresInColumns are true, is there label information for the measures metadata.

Default Value:
false
Borrowed from:
BasicChart

{boolean} dataMeasuresInColumns
Indicates if multiple measures "are in" columns or in rows (applies to crosstab data format).

This option only applies when #isMultiValued is true.

When true, the data source contains columns for each combination of "series" columns' values and measure dimension.

When false, the data source contains rows for each combination of "categories" columns' values and measure dimension.

Borrowed from:
BasicChart

{string} dataSeparator
The separator character used to join multiple values in the crosstab format, and to build composite keys for multiple level groupings.

See also #groupedLabelSep.

Default Value:
'~'
Borrowed from:
BasicChart

{pvc.options.varia.DataTypeCheckingMode} dataTypeCheckingMode
The confirmation mode of the column types declared in a dataset's metadata.

The default value depends on the chart type. The bullet chart type has a default of pvc.options.varia.DataTypeCheckingMode#Extended. All other chart types have a default of pvc.options.varia.DataTypeCheckingMode#Minimum.

Data type checking can be disabled by specifying the value pvc.options.varia.DataTypeCheckingMode#None.

Borrowed from:
BasicChart

{boolean} isMultiValued
Indicates if the data source contains multiple columns of the "measures" physical group.

Relational format

Controls whether the option #measuresIndexes applies.

Crosstab format

Depending on the value of #dataMeasuresInColumns, measures are either in columns or in rows.
Default Value:
false
Borrowed from:
BasicChart

{number|string|list(number|string)} measuresIndexes
The indexes of columns of the "measures" physical group (applies to relational data format).

This option only applies when #isMultiValued is true.

By default, these are the indexes of continuous columns.

Borrowed from:
BasicChart

{number|string|list(number|string)} multiChartIndexes
The indexes of columns of the logical table that are to feed the default multiChart, multiChart2, ... dimensions.

See BasicChart#readers for related information.


{string|list(pvc.options.DimensionsReader)} readers
A list of dimension names to load from corresponding logical table columns.

Can be a string containing a comma separated list of dimension names.

More generally, this option accepts an array of dimensions readers.

Borrowed from:
BasicChart

{boolean} seriesInRows
Swaps the columns of the "series" and "categories" physical groups.

The name of this option is inspired in the crosstab/ matrix format, where the "series" values are placed in the first row, and "category" values are placed in the first column (corner cell is empty).

Default Value:
false
Borrowed from:
BasicChart

{string|object} canvas
The identifier of the HTML element, or the element itself, where the chart is to be created in.

The chart element will be a child of the canvas element.

When unspecified, the chart element will be added as the last child of the HTML document body.

Borrowed from:
BasicChart

{pvc.options.varia.CompatibilityFlags} compatFlags
The set of compatibility flags.

See also BasicChart#compatVersion.

Borrowed from:
BasicChart

{number} compatVersion
The CCC version that the chart should run in.

The value 1 emulates version 1 of CCC.

See also BasicChart#compatFlags.

Default Value:
Infinity
Borrowed from:
BasicChart

{boolean} animate
Indicates if a chart should show an entry animation, every time it is fully rendered. Most charts perform some sort of entry animation of its main visual elements.

When a chart is rendered explicitly, through its render method, it is possible to control whether the entry animation is performed or not.

This option is only taken into account when #interactive is true.

Default Value:
true
Borrowed from:
Chart

{pvc.options.varia.ChartClearSelectionMode} clearSelectionMode
Controls if and how the selection can be cleared by the user.

This option applies even if #selectable is false. This supports scenarios where a custom selection implementation controls what can get selected, but in which clearing selection is decided by the user, in the default way.

This option is only taken into account when #interactive is true.

Default Value:
'emptySpaceClick'
Borrowed from:
Chart

{boolean} clickable
Indicates if the chart is clickable by the user.

If this option is false, any click-related actions will not be executed (ex: #clickAction, Chart#doubleClickAction, or pvc.options.axes.DiscreteCartesianAxis#clickAction).

Default Value:
false
Borrowed from:
BasicChart

{boolean} ctrlSelectMode
When true, indicates that a selection made by the user replaces the current selection, if any.

For the selection to be additive, the ctrl key (or cmd in Mac) must be pressed, by the end of the operation.

When false, indicates that any selection made by the user is additive. The ctrl or cmd keys have no effect.

Default Value:
true
Borrowed from:
Chart

{number} doubleClickMaxDelay
The maximum number of milliseconds, between two consecutive clicks, for them to be considered a double-click.
Default Value:
300
Borrowed from:
Chart

{boolean} hoverable
Indicates if the chart's visual elements are automatically highlighted when the user hovers over them with the mouse.

This option is only taken into account when #interactive is true.

Default Value:
false
Borrowed from:
Chart

{boolean} interactive
Indicates if chart interaction is enabled.

Chart interaction is any of the following kinds of interaction: animation, on-hover highlighting, tooltips, selection, clicking and double-clicking.

When false, all kinds of interaction are disabled. The options controlling specific interaction types are ignored: #animate, #hoverable, pvc.options.Tooltip#enabled, #selectable, Chart#clearSelectionMode and #clickable.

When true all kinds of interaction may be enabled, that being controlled by its own control option.

When printing, with CGG, #interactive is always false, independently of the specified value.

When not printing, the default value of this option is true.

Borrowed from:
Chart

{pvc.options.Pointing} pointing
Contains options related to the way the pointing events are handled (ex: over, out).
Borrowed from:
Chart

{pvc.options.varia.PointingMode} pointingMode
The pointing mode used by the chart.
Default Value:
'near'
Borrowed from:
Chart

{boolean} selectable
Indicates if the chart's visual elements can be selected by the user, by clicking on them or using the rubber-band.

This option is only taken into account when #interactive is true.

Default Value:
false
Borrowed from:
Chart

<deprecated> {boolean} showTooltips
Indicates if tooltips are enabled and contains additional tooltip presentation options.
Deprecated:
Use #tooltip instead.
Borrowed from:
BasicChart

<deprecated> {pvc.options.Tooltip} tipsySettings
Contains additional tooltip presentation options.
Deprecated:
Use #tooltip instead.
Borrowed from:
BasicChart

{pvc.options.Tooltip} tooltip
Indicates if tooltips are enabled and contains additional tooltip presentation options.
Borrowed from:
BasicChart

{number|string|pvc.options.varia.Sides} contentMargins
The margins of the root content panel, in pixel units or as a percentage.

In a small multiples chart, the margins of the content panel of a small chart can be set with the property smallContentMargins.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:
0
Borrowed from:
BasicChart

{number|string|pvc.options.varia.Sides} contentPaddings
The paddings of the root content panel, in pixel units or as a percentage.

In a small multiples chart, the paddings of the content panel of a small chart can be set with the property smallContentPaddings.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:
0
Borrowed from:
BasicChart

{number} height
The height of the root chart, in pixels.
Default Value:
300
Borrowed from:
BasicChart

{number|string|pvc.options.varia.Sides} margins
The margins of the root chart.

In a small multiples chart, the margins of the small charts can be set with the property smallMargins.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:
3
Borrowed from:
BasicChart

{pvc.options.varia.ChartOrientation} orientation
The chart orientation indicates if its main direction is vertical or horizontal.

This property is supported by most chart types.

Default Value:
'vertical'
Borrowed from:
BasicChart

{number|string|pvc.options.varia.Sides} paddings
The paddings of the root chart.

In a small multiples chart, the paddings of a small chart can be set with the property smallPaddings.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:
0
Borrowed from:
BasicChart

{number} width
The width of the root chart, in pixels.
Default Value:
400
Borrowed from:
BasicChart

{string|pvc.options.VisualRole} categoryRole
The category visual role is a plot-level visual role that allows grouping data points to form a hierarchy.

This is a shortcut property for the main plot's pvc.options.visualRoles.TreemapPlotVisualRoles#category.


{string|pvc.options.VisualRole} colorRole
The color visual role is a plot-level visual role that is visually encoded by the color of visual elements.

This is a shortcut property for the main plot's pvc.options.visualRoles.TreemapPlotVisualRoles#color.


{string|pvc.options.VisualRole} dataPartRole
The dataPart visual role is a chart-level visual role that allows partitioning of the data into several datum subsets.

This is a shortcut property for pvc.options.visualRoles.BasicChartVisualRoles#dataPart.

Borrowed from:
BasicChart

{string|pvc.options.VisualRole} multiChartRole
The multiChart visual role is a chart-level visual role that allows turning a chart into a small multiples chart, http://en.wikipedia.org/wiki/Small_multiple.

Almost all main chart types support being shown as a small multiples chart. Currently, the exceptions are the charts: Heat Grid, Bullet, Data Tree and Parallel Coordinates.

The multiChart visual role can be bound to any number of dimensions, that are, or will be turned into, discrete.

The multiChart visual role automatically binds to every dimension whose name has the multiChart prefix.

One small chart is generated per unique combination of the values of the bound dimensions that is present in the source data. Each small chart then receives as its data the partition of the source data that shares its unique combination of values.

See pvc.options.VisualRole for more information on supported data types.


{string|pvc.options.VisualRole} sizeRole
The size visual role is a plot-level visual role that is visually encoded by the relative area amongst sibling-leaf rectangles.

This is a shortcut property for the main plot's pvc.options.visualRoles.TreemapPlotVisualRoles#size.


{map(string : pvc.options.VisualRole)|pvc.options.visualRoles.TreemapChartVisualRoles} visualRoles
The chart's visual roles map.

See BasicChart#visualRoles for more information.


{number|string|pvc.options.varia.Size} plotSizeMin
The minimum size of the plot panel, in pixel units. If a percentage is specified, this option is ignored.

To determine the actual minimum size of the plot panel, the chart takes into account other restrictions imposed by options such as: pvc.options.axes.DiscreteCartesianAxis#bandSize, pvc.options.axes.DiscreteCartesianAxis#bandSizeMin, pvc.options.axes.DiscreteCartesianAxis#bandSpacing and pvc.options.axes.DiscreteCartesianAxis#bandSpacingMin.

In a small multiples chart, this option is ignored.

See pvc.options.varia.Size for information about the different supported data types.

Borrowed from:
BasicChart

{boolean|pvc.options.panels.LegendPanel} legend
The legend panel of the root chart.

When a value of type boolean is specified, it indicates the visibility of the legend.

Default Value:
false
Borrowed from:
Chart

{boolean} legendAreaVisible
Indicates if the legend panel is visible.

It is equivalent to specifying a value of type boolean in #legend, but if both specified this property value takes precedence.

Allows setting the panel's visibility when specifing a value of type pvc.options.panels.LegendPanel in #legend.

Default Value:
false
Borrowed from:
Chart

{string|pvc.options.panels.ChartTitlePanel} title
The title panel of the root chart.

When a value of type string is specified, it is the title text.

Borrowed from:
BasicChart

{pvc.options.panels.ChartTitlePanel} smallTitle
The title panel of the small chart.

The text of the title of small charts is the compound label of the data bound to the multiChart visual role.


{list(pvc.options.plots.Plot)} plots
An array of plots.

Can be specified to configure the options of the chart's internal plots (like main and plot2 and trend, when supported by the chart type), or to define and configure extra plots, of compatible types.

The types of plots that can be used together in a chart depend on:

For additional information, specific of each chart type, see its documentation for property plots.

Borrowed from:
BasicChart

{pvc.options.plots.TreemapPlot} treemap
The treemap plot is the main plot of the treemap chart, which means that its properties may be used without the "treemap" property suffix.
Method Detail
{undefined} clickAction(scene)
A callback function that is called when the user clicks on a visual element.
Context:
{pvc.visual.Context}
Arguments:
{pvc.visual.Scene} scene
The scene associated with the visual item.
Returns:
{undefined}
Borrowed from:
BasicChart

{undefined} doubleClickAction(scene)
A callback function that is called when the user double-clicks on a visual element.
Context:
{pvc.visual.Context}
Arguments:
{pvc.visual.Scene} scene
The scene associated with the visual item.
Returns:
{undefined}
Borrowed from:
Chart

{undefined} renderCallback(scene)
A callback function that is called before the chart is rendered, but after if has been pre-rendered.

You can use this action to:

Context:
{pvc.visual.Context}
Arguments:
{pvc.visual.Scene} scene
The scene associated with the visual item.
Returns:
{undefined}
Borrowed from:
BasicChart

{undefined} renderedCallback(scene)
A callback function that is called after the chart has finished rendering, including any animations.
Context:
{pvc.visual.Context}
Arguments:
{pvc.visual.Scene} scene
The scene associated with the visual item.
Returns:
{undefined}
Borrowed from:
BasicChart

{undefined} selectionChangedAction(selectedDatums, selectedChangedDatums)
A callback function that is called when, after selection has changed, the chart is updated to reflect the change.
Context:
{pvc.visual.Context}
Arguments:
{list(pvc.data.Datum)} selectedDatums
An array with the resulting selected datums.
{list(pvc.data.Datum)} selectedChangedDatums
An array with the datums whose selected state has changed since the last time that the action was handled.
Returns:
{undefined}
Borrowed from:
Chart

{list(pvc.data.Datum)} userSelectionAction(selectingDatums, selectingGroup)
A callback function that is called when the user performs a selection, but before the corresponding datums' selected state is actually changed.

This function is usefull to restrict, amplify, or normalize the selection.

Context:
{pvc.visual.Context}
Arguments:
{list(pvc.data.Datum)} selectingDatums
An array with the datums that will be selected by the current operation.
{pvc.data.Data} selectingGroup Optional
A data group, if the current operation will only select a single group, otherwise no value.
Returns:
{list(pvc.data.Datum)} The datums that should be actually selected.
Borrowed from:
Chart

{string!} percentValueFormat(value)
A function used to format non-null numeric values as percentages.

When this property is specified, it sets also the pvc.options.format.FormatProvider#percent format of the chart's format provider, BasicChart#format. Consequently, its value is inherited by the numeric dimension types' pvc.options.DimensionType#format.

Conversely, if the chart's format provider pvc.options.format.FormatProvider#percent format is specified, its value sets this property, Chart#percentValueFormat.

When both are specified, the one in the chart's format provider has precedence.

Context:
{null}
Arguments:
{number!} value
The non-null number to format.
Returns:
{string!} The number formatted as a non-empty string.
Borrowed from:
Chart

{string!} valueFormat(value)
A function that formats the non-null values of numeric dimensions.

When this property is specified, it sets also the pvc.options.format.FormatProvider#number format of the chart's format provider, BasicChart#format. Consequently, its value is inherited by the number dimension types' pvc.options.DimensionType#format.

Conversely, if the chart's format provider pvc.options.format.FormatProvider#number format is specified, its value sets this property, BasicChart#valueFormat.

When both are specified, the one in the chart's format provider has precedence.

Note: in a previous CCC version this property applied only to dimensions named value, value2, etc. It now applies to any numeric dimensions.

Context:
{null}
Arguments:
{number!} value
The non-null number to format.
Returns:
{string!} The number formatted as a non-empty string.
Borrowed from:
BasicChart

{boolean} dataWhere(datum)
A function that filters datums as they are being loading.
Context:
{null}
Arguments:
{pvc.data.Datum} datum
The datum being loaded.
Returns:
{boolean} true if the datum should be included, false if it should be excluded.
Borrowed from:
BasicChart

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