Class pvc.options.plots.HeatGridPlot

Extends CategoricalPlot.

Class Summary
Constructor Attributes	Constructor Name and Description
	HeatGridPlot The options documentation class of the Heat grid plot.

Field Summary
Field Attributes	Field Name and Description
Axes
<constant>	colorAxis The index of the color axis to use for the plot.
<constant>	orthoAxis The index of the orthogonal cartesian axis to use for the plot.
Data
	dataPart The data part value of the subset of data that the plot consumes.
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
	extensionPoints The extension points object contains style definitions for the marks of the plot.
	nullShape The shape to use when the value of the size role is `null`.
	shape The shape to use in the dot mark (applies when using shapes).
<deprecated>	showValues Indicates if value labels are shown next to the visual elements.
	useShapes Indicates if the heat-grid uses as visual elements dot-shapes, within each grid cell.
	valuesAnchor The point of a visual element onto which the associated value label is anchored to.
	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.HeatGridPlot

The options documentation class of the Heat grid 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

{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

The default of this property varies depending on whether the size and color visual roles are bound.

if the color visual role is bound, the default mask is '{color}'
else, if the size visual role is bound, the default mask is '{size}'
else, no default value exists; the value label is not shown

{pvc.options.ext.HeatGridPlotExtensionPoints} extensionPoints

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

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

See #useShapes.

Default Value:: 'cross'

{pvc.options.varia.DotShapeType} shape

The shape to use in the dot mark (applies when using shapes).

See #useShapes.

Default Value:: 'square'

<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} useShapes

Indicates if the heat-grid uses as visual elements dot-shapes, within each grid cell.

When false the visual elements are the grid cells themselves.

When shapes are used the pvc.options.visualRoles.HeatGridPlotVisualRoles#size visual role can be used.

Default Value:: false

{pvc.options.varia.MarkAnchor|pvc.options.varia.WedgeAnchor} valuesAnchor

The point of a visual element onto which the associated value label is anchored to.

The possible values and the default value actually depend on the chart type so be sure to access this property's documentation through the concrete class' documentation.

Borrowed from:: Plot

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

The heat-grid shows as values the color role value, if bound, or, otherwise, the size role value, if bound.

By default, values are visible when #useShapes is false and not visible otherwise.

{map(string : pvc.options.VisualRole)|pvc.options.visualRoles.HeatGridPlotVisualRoles} 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.HeatGridPlot