Class pvc.options.charts.Chart

Extends BasicChart.

Class Summary
Constructor Attributes	Constructor Name and Description
<abstract>	Chart The common options documentation class of (almost) all charts.

Field Summary
Field Attributes	Field Name and Description
Axes
	color The first color axis options.
Chart
	extensionPoints The extension points object contains style definitions for the marks of the chart.
	preserveLayout Indicates if the layout should be preserved between renders.
Chart > Data
	calculations An array of dimensions calculations.
	dimensionGroups A map whose keys are the dimension type group names and whose values are the default dimension type group options.
	dimensions A map whose keys are the dimension type names and whose values are the dimension type options.
	format The chart's format provider.
	groupedLabelSep The separator used to join the labels of the values of a multi-dimensional visual role.
	ignoreNulls Indicates if datums whose value in every measure dimension is null are ignored.
	slidingWindow Indicates the existence of the sliding window.
	timeSeries Indicates that dimensions whose name is "category1", "category2", etc, have a `Date` value type, by default.
	timeSeriesFormat The format string used to parse dimensions of the `Date` value type, by default.
Chart > Data Source
	crosstabMode Indicates if the data source is in the crosstab format, or, when `false`, the relational format.
	dataCategoriesCount The number of columns of the "categories" physical group that the data source contains.
	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.
	dataMeasuresInColumns Indicates if multiple measures "are in" columns or in rows (applies to crosstab data format).
	dataSeparator The separator character used to join multiple values in the crosstab format, and to build composite keys for multiple level groupings.
	dataTypeCheckingMode The confirmation mode of the column types declared in a dataset's metadata.
	isMultiValued Indicates if the data source contains multiple columns of the "measures" physical group.
	measuresIndexes The indexes of columns of the "measures" physical group (applies to relational data format).
	readers A list of dimension names to load from corresponding logical table columns.
	seriesInRows Swaps the columns of the "series" and "categories" physical groups.
Chart > General
	canvas The identifier of the HTML element, or the element itself, where the chart is to be created in.
	compatFlags The set of compatibility flags.
	compatVersion The CCC version that the chart should run in.
Chart > Interaction
	animate Indicates if a chart should show an entry animation, every time it is fully rendered.
	clearSelectionMode Controls if and how the selection can be cleared by the user.
	clickable Indicates if the chart is clickable by the user.
	ctrlSelectMode When `true`, indicates that a selection made by the user replaces the current selection, if any.
	doubleClickMaxDelay The maximum number of milliseconds, between two consecutive clicks, for them to be considered a double-click.
	hoverable Indicates if the chart's visual elements are automatically highlighted when the user hovers over them with the mouse.
	interactive Indicates if chart interaction is enabled.
	pointing Contains options related to the way the pointing events are handled (ex: over, out).
	pointingMode The pointing mode used by the chart.
	selectable Indicates if the chart's visual elements can be selected by the user, by clicking on them or using the rubber-band.
<deprecated>	showTooltips Indicates if tooltips are enabled and contains additional tooltip presentation options.
<deprecated>	tipsySettings Contains additional tooltip presentation options.
	tooltip Indicates if tooltips are enabled and contains additional tooltip presentation options.
Chart > Layout
	contentMargins The margins of the root content panel, in pixel units or as a percentage.
	contentPaddings The paddings of the root content panel, in pixel units or as a percentage.
	height The height of the root chart, in pixels.
	margins The margins of the root chart.
	orientation The chart orientation indicates if its main direction is vertical or horizontal.
	paddings The paddings of the root chart.
	width The width of the root chart, in pixels.
Chart > Visual Roles
	dataPartRole The `dataPart` visual role is a chart-level visual role that allows partitioning of the data into several datum subsets.
	visualRoles The chart's visual roles map.
Layout
	plotSizeMin The minimum size of the plot panel, in pixel units.
Panels
	legend The legend panel of the root chart.
	legendAreaVisible Indicates if the legend panel is visible.
	title The title panel of the root chart.
Plots
	plots An array of plots.

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.
	doubleClickAction(scene) A callback function that is called when the user double-clicks on a visual element.
	renderCallback(scene) A callback function that is called before the chart is rendered, but after if has been pre-rendered.
	renderedCallback(scene) 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
	percentValueFormat(value) 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

<abstract> pvc.options.charts.Chart

The common options documentation class of (almost) all charts.

For information on the supported data formats see BasicChart.

Field Detail

{pvc.options.axes.ColorAxis} 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.ext.ChartExtensionPoints} extensionPoints

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

{boolean} preserveLayout

Indicates if the layout should be preserved between renders.

Default Value:: false

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

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.

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

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

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

Relational format

Crosstab format

Relational format

Crosstab format