Class pvc.options.axes.SunburstColorAxis
Extends
ColorAxis.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
The options documentation class of the
Sunburst discrete color axis.
|
| Field Attributes | Field Name and Description |
|---|---|
| Discrete > Scale | |
|
Allows reserving colors to certain color scale keys.
|
|
|
How much a last sibling slice will be brighter than a first sibling slice.
|
|
|
The minimum color alpha channel value.
|
|
|
How much the color alpha channel is decremented per slice level, relative to the alpha of the base color.
|
|
| Scale | |
|
The colors of a color axis.
|
|
|
The color to use when an optional color role is unbound.
|
|
| Method Attributes | Method Name and Description |
|---|---|
| Scale | |
|
transform(color)
The color transform function.
|
|
See ColorAxis for additional information.
- Default Value:
- false
Color scale keys are the values of the color role. By default, the color role is bound to the dimensions of the series role. Color scale keys that are not mapped, receive colors taken from #colors. Colors in #colors that are also present in the color map are ignored.
Assuming the color role is bound to the grouping "territory, country", the following map would reserve the colors red and green to Canada and Portugal, respectively:
chartOptions.colorMap = {
"NA~Canada": "red",
"EMEA~Portugal": "green"
};
Assumes that the default pvc.options.charts.BasicChart#dataSeparator is used.
Only applies when pvc.options.plots.SunburstPlot#colorMode is pvc.options.varia.SunburstColorMode#Fan.
A non-negative number.
Specify 0 for siblings to have the same color.
- Default Value:
- 1
Only applies when pvc.options.plots.SunburstPlot#colorMode is pvc.options.varia.SunburstColorMode#Level.
A number between 0 and 1.
- Default Value:
- 0.1
Only applies when pvc.options.plots.SunburstPlot#colorMode is pvc.options.varia.SunburstColorMode#Level.
A number between 0 and 1.
The resulting alpha value is still restricted to be greater than the value of SunburstColorAxis#sliceLevelAlphaMin.
Specify 0 for levels to have the same color.
- Default Value:
- 0.15
It can be a single color as documented in pvc.options.varia.ColorString or a single protovis color object (like: pv.color('red') or pv.Color.names.blueviolet).
Additionally, an array of color strings or protovis colors can be specified.
If a function is specified, it can be:
- a protovis scale, like the one obtained by: pv.colors('red', 'blueviolet')
- a scale factory - a function that given the domain values as arguments return a protovis color scale
The default color scheme depends on the axis domain being discrete or numeric.
For discrete domains, the default value is the protovis category10 color scheme:
- value
- value
- value
- value
- value
- value
- value
- value
- value
- value
For numeric domains, the default value is the color scheme:
- value
- value
- value
- Borrowed from:
- ColorAxis
When a color role is optional and was not specified, but color is still required to show visual elements, this property allows specifying the color with which all visual elements' color attributes will be based on.
The default value is the first color in #colors.
Contrast this option with AnyColorAxis#missing and HeatGridColorAxis#missing.
- Borrowed from:
- ColorAxis
Allows applying an effect to the colors that an axis outputs.
The default value is null except for color axes that are used only by one of the trend or plot2 plots, and whose colors property was not specified. In these cases, the default value is pvc.brighterColorTransform.
- Context:
- {null}
- Arguments:
- {pv.Color} color
- The color to transform.
- Returns:
- {pv.Color} The transformed color.
- Borrowed from:
- ColorAxis