Class pvc.options.charts.SunburstChart
Extends
Chart.
Constructor Attributes | Constructor Name and Description |
---|---|
The options documentation class of the
Sunburst chart.
|
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 angle span amongst sibling slices.
|
|
The chart's visual roles map.
|
|
Layout | |
The minimum size of the plot panel, in pixel units.
|
|
Panels | |
<constant> |
The legend is not supported by this chart type 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 sunburst plot is the
main plot of the sunburst chart,
which means that
its properties may be used
without the "sunburst" property suffix.
|
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.
|
Sunburst charts display hierarchical data using series of rings. They are great to quickly drill down trough a deep hierarchy, while still maintaining the notion of its dimension.
Each ring represents the children of the ring it encloses and the area of each slice corresponds to its value.
Default Data Format
For general information on the supported data formats see BasicChart.The sunburst chart employs a non-default logical row to dimensions mapping:
- All of the free discrete columns of the logical table generate and load free dimensions of the "category" dimension group: "category", "category2", "category4", ...
- 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 Sunburst'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"
See pvc.options.axes.ColorAxis for more information on the way that the color axes' properties may be accessed.
- Default Value:
- false
- Borrowed from:
- Chart
This property can receive a value of Infinity to indicate that all charts should be laid out in a single row.
- Default Value:
- 3
The first small charts are chosen.
- Default Value:
- Infinity
- Default Value:
- 'grow'
- Default Value:
- true
- Default Value:
- true
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.
See pvc.options.varia.Sides for information about the different supported data types.
- Default Value:
- 0
See pvc.options.varia.Sides for information about the different supported data types.
- Default Value:
- 0
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.
See pvc.options.varia.Sides for information about the different supported data types.
- Default Value:
- '2%'
See pvc.options.varia.Sides for information about the different supported data types.
- Default Value:
- 0
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.
Can be specified to calculate the values of certain dimensions.
- Borrowed from:
- BasicChart
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
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
- Borrowed from:
- BasicChart
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
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
- Default Value:
- false
- Borrowed from:
- Chart
- Default Value:
- true
- Borrowed from:
- BasicChart
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
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
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
See also #groupedLabelSep.
- Default Value:
- '~'
- Borrowed from:
- BasicChart
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
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
This option only applies when #isMultiValued is true.
By default, these are the indexes of continuous columns.
- Borrowed from:
- BasicChart
See BasicChart#readers for related information.
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
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
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
See also BasicChart#compatVersion.
- Borrowed from:
- BasicChart
The value 1 emulates version 1 of CCC.
See also BasicChart#compatFlags.
- Default Value:
- Infinity
- Borrowed from:
- BasicChart
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
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
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
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
- Default Value:
- 300
- Borrowed from:
- Chart
This option is only taken into account when #interactive is true.
- Default Value:
- false
- Borrowed from:
- Chart
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
- Borrowed from:
- Chart
- Default Value:
- 'near'
- Borrowed from:
- Chart
This option is only taken into account when #interactive is true.
- Default Value:
- false
- Borrowed from:
- Chart
- Deprecated:
- Use #tooltip instead.
- Borrowed from:
- BasicChart
- Deprecated:
- Use #tooltip instead.
- Borrowed from:
- BasicChart
- Borrowed from:
- BasicChart
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
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
- Default Value:
- 300
- Borrowed from:
- BasicChart
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
This property is supported by most chart types.
- Default Value:
- 'vertical'
- Borrowed from:
- BasicChart
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
- Default Value:
- 400
- Borrowed from:
- BasicChart
This is a shortcut property for the main plot's pvc.options.visualRoles.SunburstPlotVisualRoles#category.
This is a shortcut property for the main plot's pvc.options.visualRoles.SunburstPlotVisualRoles#color.
This is a shortcut property for pvc.options.visualRoles.BasicChartVisualRoles#dataPart.
- Borrowed from:
- BasicChart
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.
This is a shortcut property for the main plot's pvc.options.visualRoles.SunburstPlotVisualRoles#size.
See BasicChart#visualRoles for more information.
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
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
When a value of type string is specified, it is the title text.
- Borrowed from:
- BasicChart
The text of the title of small charts is the compound label of the data bound to the multiChart visual role.
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:
- each plot's chart base class requirement, and
- further axes compatibility requirements; the visual roles being encoded by an axis must be compatible: they must have the same value type (number, date, or discrete) and, for discrete visual roles, they must also be bound to the same dimension list.
For additional information, specific of each chart type, see its documentation for property plots.
- Borrowed from:
- BasicChart
- Context:
- {pvc.visual.Context}
- Arguments:
- {pvc.visual.Scene} scene
- The scene associated with the visual item.
- Returns:
- {undefined}
- Borrowed from:
- BasicChart
- Context:
- {pvc.visual.Context}
- Arguments:
- {pvc.visual.Scene} scene
- The scene associated with the visual item.
- Returns:
- {undefined}
- Borrowed from:
- Chart
You can use this action to:
- use the mark events API on time-series categorical charts
- extend in special ways the already created protovis marks.
- Context:
- {pvc.visual.Context}
- Arguments:
- {pvc.visual.Scene} scene
- The scene associated with the visual item.
- Returns:
- {undefined}
- Borrowed from:
- BasicChart
- Context:
- {pvc.visual.Context}
- Arguments:
- {pvc.visual.Scene} scene
- The scene associated with the visual item.
- Returns:
- {undefined}
- Borrowed from:
- BasicChart
- 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
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
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
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
- 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