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


Extends Plot.

Class Summary
Constructor Attributes Constructor Name and Description
 
The options documentation class of the Treemap plot.
Field Summary
Field Attributes Field Name and Description
Axes
<constant>  
The index of the color axis to use for the plot.
Data
 
The data part value of the subset of data that the plot consumes.
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
 
Controls how colors are drawn from the color scale to paint visual elements.
 
The extension points object contains style definitions for various visual elements of the chart.
 
The rectangle layout algorithm.
 
The label that is used for the root node.
<deprecated>  
Indicates if value labels are shown next to the visual elements.
<constant>  
The treemap's value label is always anchored to the center of the associated rectangle.
 
The font of a value label.
 
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 rectangle.
 
Indicates if value labels are shown next to the visual elements.
Visual Roles
 
The plot's visual roles map.
Class Detail
pvc.options.plots.TreemapPlot
The options documentation class of the Treemap plot.
Field Detail
<constant> {number} colorAxis
The index of the color 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:

The default value depends on the plot type.

Borrowed from:
Plot

{pvc.options.varia.TreemapColorMode} colorMode
Controls how colors are drawn from the color scale to paint visual elements. Indicates if the color is assigned to parent nodes or to leaf nodes.
Default Value:
'byParent'

{pvc.options.ext.TreemapPlotExtensionPoints} extensionPoints
The extension points object contains style definitions for various visual elements of the chart.

{pvc.options.varia.TreemapLayoutMode} layoutMode
The rectangle layout algorithm.
Default Value:
'squarify'

{string} rootCategoryLabel
The label that is used for the root node. The root node's label not always shows up to the user. It depends on the used #colorMode and of the existence of a first-level leaf node.
Default Value:
'All'

<deprecated> {boolean} showValues
Indicates if value labels are shown next to the visual elements.
Deprecated:
Use #valuesVisible instead.
Default Value:
false
Borrowed from:
Plot

<constant> {pvc.options.varia.MarkAnchor} valuesAnchor
The treemap's value label is always anchored to the center of the associated rectangle.

{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} 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 known background color.

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

Default Value:
true

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

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

It is included as a required margin in all of the sides of the label.

Default Value:
'hide'

{boolean} valuesVisible
Indicates if value labels are shown next to the visual elements.
Default Value:
true

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

See BasicPlot#visualRoles for more information.


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