Sunburst Charts

Sunburst Chart Type

To specify the chart type, add a type attribute to the chart object. Our standard sunburst chart is specified by the sunburst value. Without further modification, here is how the default sunburst chart appears:

{
  type: 'sunburst',
}

Data

Provide your chart data in the series array. In the array, create an object and assign a value to id, text, parent, and the optional value attribute.

id is the section where the series data object will be placed; text is the text that will be displayed in that section; parent is the parent section of the section you are adding data to; and value is the numerical value of the data object being added.

{
  series: [
    {id: 'flare', text: 'flare', parent: ''},
    {id: 'analytics', text: 'analytics', parent: 'flare'},
    {id: 'cluster', text: 'cluster', parent: 'analytics'},
    {id: 'agglomerativecluster', text: 'AgglomerativeCluster', parent: 'cluster', value: 3938},
    ...,
    {id: 'someId', text: 'someText', parent: 'someParent', values: [someValue]}
  ]
}

Chart-Specific Properties

Once you've provided your chart type and data, you can configure the chart's elements such as offset, donut ring size, how pie slices are detached and/or clicked, and more.

Offset Slices

Use the offset-r attribute to pull out one or more slices from the rest of the sunburst. Often referred to as an exploded sunburst chart, the attribute can be applied globally in the plot object or locally in the applicable series object. Provide the sunburst slice offset as a percentage or pixel value.

{
  plot: {
    'offset-r': "10%"
  }
}

Further Customization

Scale Configuration

Use the scale-r object to set the sunburst chart's aperture and reference angle. Use the scale object to set the size factor.

Aperture

The sunburst chart is sized to 360 degrees (i.e., a circle) by default. You can change this by adding an aperture attribute to the scale-r object. Provide the desired aperture value (e.g., 180 is a half circle, 90 is a quarter circle, and so on).

{
  'scale-r': {
    aperture:300
  },
}

Reference Angle

The reference angle (or starting point) of our sunburst charts is set to 90 degrees (or 3 o'clock) by default. Add a ref-angle attribute to the scale-r object to change this. Provide the desired value, keeping in mind that the value is relative to the default starting angle. For example, providing a value of 270 would make the first sunburst slice appear at the 12 o'clock position. See the following chart:

{
  'scale-r': {
    'ref-angle':270 //relative to the starting 90 degree position.
  },
}

Alternatively, you can have the reference angle automatically set to zero and have the sunburst slices automatically sorted by size, from largest to smallest, by adding a 'layout': "auto" attribute to the plot object. See the following chart:

{
  plot: {
    layout: "auto" //to order pie slices by size and have reference angle start at zero.
  },
}

Plot/Series Styling

Style the borders of the sunburst slices by adding border-width, border-color, line-style, alpha, and other styling attributes to your plot object.

{
  plot: {
    'border-width': 1,
    'border-color': "#cccccc",
    'line-style': "dotted"
  },
}

Tokens

Tokens (or string interpolation) are highly useful when customizing sunburst chart tooltips and value boxes. Commonly used sunburst chart tokens include:

Tooltips

Tooltips appear when you hover over the sunburst slices. Create a tooltip object in the plot object to customize the text and styling. Customize the tooltip's text with a text attribute and then provide your desired combination of text and tokens inside a string.

{
  plot: {
    tooltip: {
      text: "%t: %v (%npv%)",
      'font-color': "black",
      'font-family': "Georgia",
      'text-alpha':1,
      'background-color': "white",
      alpha:0.7,
      'border-width': 1,
      'border-color': "#cccccc",
      'line-style': "dotted",
      'border-radius': "10px",
      padding: "10%",
      placement: "node:out" //"node:out" or "node:center"
    },
  },
}

Value Boxes

Value boxes are fixed labels that appear adjacent to the sunburst slices. Create a value-box object in the plot object to customize the text, placement (in, out, center), and styling. You can also incorporate rules.

In the following chart, rules were used to place value boxes in or out of the chart based on their value.

{
  plot: {
    'value-box': {
      text: "%v",
      'font-size':12,
      'font-family': "Georgia",
      'font-weight': "normal",
      rules: [
        {
          rule: "%v > 6000",
          placement: "in",
          'offset-r': "50%",
          'font-color': "white",
        },
        {
          rule: "%v <= 6000",
          placement: "out",
          'font-color': "gray",
        }
      ]
    },
  }
}