Donut

Basic Configuration

The minimum configuration for the Donut component looks like:

React

component.tsx

import { VisSingleContainer, VisDonut } from '@unovis/react'

function Component(props) {
  const data: number[] = props.data
  const value = (d: number) =>  d

  return (
    <VisSingleContainer data={data}>
      <VisDonut value={value}/>
    </VisSingleContainer>
  )
}

Angular

component.ts

@Component({
  templateUrl: 'template.html'
})
export class Component {
  @Input data: number[];
  value = (d: number) =>  d
}

template.html

<vis-single-container [data]="data">
  <vis-donut [value]="value"></vis-donut>
</vis-single-container>

Svelte

component.svelte

<script lang='ts'>
  import { VisSingleContainer, VisDonut } from '@unovis/svelte'

  export let data: number[]
  const value = (d: number) =>  d
</script>

<VisSingleContainer {data}>
  <VisDonut {value}/>
</VisSingleContainer>

Vue

component.vue

<script setup lang="ts">
import { VisSingleContainer, VisDonut } from '@unovis/vue'

const props = defineProps<{ data: number[] }>()
const value = (d: number) =>  d
</script>

<template>
  <VisSingleContainer :data="data">
    <VisDonut :value="value" />
  </VisSingleContainer>
</template>

Solid

component.tsx

import { VisSingleContainer, VisDonut } from '@unovis/solid'

function Component(props) {
  const data: number[] = () => props.data
  const value = (d: number) =>  d

  return (
    <VisSingleContainer data={data()}>
      <VisDonut value={value}/>
    </VisSingleContainer>
  )
}

TypeScript

component.ts

import { SingleContainer, Donut } from '@unovis/ts'
import { data } from './data'

const container = new SingleContainer<number>(node, {
  component: new Donut<number>({ value: (d: number) =>  d })
}, data)

Loading...

Labels

Donut can have a label and a smaller sub-label in the center. You can provide them by using the centralLabel and centralSubLabel config properties. The sub-label will automatically wrap onto multiple lines (unless you set the centralSubLabelWrap property to false), while the main label is supposed to be short and doesn't have wrapping implemented.

React

<VisDonut
  value={value} 
  centralLabel="Label" 
  centralSubLabel="Long sub-label wraps onto the next line"
/>

Angular

<vis-donut
  [value]="value" 
  centralLabel="Label" 
  centralSubLabel="Long sub-label wraps onto the next line"
></vis-donut>

Svelte

<VisDonut
  {value} 
  centralLabel="Label" 
  centralSubLabel="Long sub-label wraps onto the next line"
/>

Vue

<VisDonut
  :value="value" 
  centralLabel="Label" 
  centralSubLabel="Long sub-label wraps onto the next line"
 />

Solid

<VisDonut
  value={value} 
  centralLabel="Label" 
  centralSubLabel="Long sub-label wraps onto the next line"
/>

TypeScript

const donut = new Donut<number>({
  value, 
  centralLabel: "Label", 
  centralSubLabel: "Long sub-label wraps onto the next line"
})

Loading...

Angle Range

By default, a Donut will populate values in the angle range [0, 2π]. You can adjust your Donut's angleRange property to a [a,b] of type [number, number] where a[0] = the starting position and a[1] = the ending position (in radians). A common example might be when you want an incomplete/semi circle:

React

<VisDonut value={value} angleRange={[1,3.141592653589793]}/>

Angular

<vis-donut
  [value]="value" 
  [angleRange]="[1,3.141592653589793]"
></vis-donut>

Svelte

<VisDonut {value} angleRange={[1,3.141592653589793]}/>

Vue

<VisDonut :value="value" :angleRange="[1,3.141592653589793]" />

Solid

<VisDonut value={value} angleRange={[1,3.141592653589793]}/>

TypeScript

const donut = new Donut<number>({ value, angleRange: [1,3.141592653589793] })

Loading...

Sorting

By default, each segment is placed in order of appearance within your data array, from To change this, provide a sorting function to the sortFunction property. The following example displays the segments in descending order:

React

component.tsx

import { VisSingleContainer, VisDonut } from '@unovis/react'

function Component(props) {
  const data: number[] = props.data
  const value = (d: number) =>  d
  const sortFunction = (a, b) =>  a  -  b

  return (
    <VisSingleContainer data={data}>
      <VisDonut value={value} sortFunction={sortFunction}/>
    </VisSingleContainer>
  )
}

Angular

component.ts

@Component({
  templateUrl: 'template.html'
})
export class Component {
  @Input data: number[];
  value = (d: number) =>  d
  sortFunction = (a, b) =>  a  -  b
}

template.html

<vis-single-container [data]="data">
  <vis-donut [value]="value" [sortFunction]="sortFunction"></vis-donut>
</vis-single-container>

Svelte

component.svelte

<script lang='ts'>
  import { VisSingleContainer, VisDonut } from '@unovis/svelte'

  export let data: number[]
  const value = (d: number) =>  d
  const sortFunction = (a, b) =>  a  -  b
</script>

<VisSingleContainer {data}>
  <VisDonut {value} {sortFunction}/>
</VisSingleContainer>

Vue

component.vue

<script setup lang="ts">
import { VisSingleContainer, VisDonut } from '@unovis/vue'

const props = defineProps<{ data: number[] }>()
const value = (d: number) =>  d
const sortFunction = (a, b) =>  a  -  b
</script>

<template>
  <VisSingleContainer :data="data">
    <VisDonut :value="value" :sortFunction="sortFunction" />
  </VisSingleContainer>
</template>

Solid

component.tsx

import { VisSingleContainer, VisDonut } from '@unovis/solid'

function Component(props) {
  const data: number[] = () => props.data
  const value = (d: number) =>  d
  const sortFunction = (a, b) =>  a  -  b

  return (
    <VisSingleContainer data={data()}>
      <VisDonut value={value} sortFunction={sortFunction}/>
    </VisSingleContainer>
  )
}

TypeScript

component.ts

import { SingleContainer, Donut } from '@unovis/ts'
import { data } from './data'

const container = new SingleContainer<number>(node, {
  component: new Donut<number>({
    value: (d: number) =>  d, 
    sortFunction: (a, b) =>  a  -  b
  })
}, data)

Loading...

Size

You can change the size of your Donut with the following properties:

Radius

radius defines the outer/overall radius:

radius:

React

<VisDonut radius={50} value={value}/>

Angular

<vis-donut [radius]="50" [value]="value"></vis-donut>

Svelte

<VisDonut radius={50} {value}/>

Vue

<VisDonut :radius="50" :value="value" />

Solid

<VisDonut radius={50} value={value}/>

TypeScript

const donut = new Donut<number>({ radius: 50, value })

Loading...

Arc Width

arcWidth defines the width of the circle's outer ring in pixels.

arcWidth:

React

<VisDonut arcWidth={50} value={value}/>

Angular

<vis-donut [arcWidth]="50" [value]="value"></vis-donut>

Svelte

<VisDonut arcWidth={50} {value}/>

Vue

<VisDonut :arcWidth="50" :value="value" />

Solid

<VisDonut arcWidth={50} value={value}/>

TypeScript

const donut = new Donut<number>({ arcWidth: 50, value })

Loading...

note

For the appearance of a traditional pie chart, set Donut's arcWidth to 0.

Segment Appearance

Custom Color

Customize the colors for each segment with a colorAccessor function:

React

component.tsx

function Component(props) {
  const data: number[] = props.data
  const value = (d: number) =>  d
  const color = (d: number, i: number) =>  ['red', 'orange', 'blue', 'green'][i]

  return (
    <VisDonut value={value} color={color}/>
  )
}

Angular

component.ts

@Component({
  template: '<vis-donut [value]="value" [color]="color"></vis-donut>'
})
export class Component {
  @Input data: number[];
  value = (d: number) =>  d
  color = (d: number, i: number) =>  ['red', 'orange', 'blue', 'green'][i]
}

Svelte

component.svelte

<script lang='ts'>
  import { VisSingleContainer, VisDonut } from '@unovis/svelte'

  export let data: number[]
  const value = (d: number) =>  d
  const color = (d: number, i: number) =>  ['red', 'orange', 'blue', 'green'][i]
</script>

<VisDonut {value} {color}/>

Vue

component.vue

<script setup lang="ts">
import { VisSingleContainer, VisDonut } from '@unovis/vue'

const props = defineProps<{ data: number[] }>()
const value = (d: number) =>  d
const color = (d: number, i: number) =>  ['red', 'orange', 'blue', 'green'][i]
</script>

<template>
  <VisDonut :value="value" :color="color" />
</template>

Solid

component.tsx

function Component(props) {
  const data: number[] = () => props.data
  const value = (d: number) =>  d
  const color = (d: number, i: number) =>  ['red', 'orange', 'blue', 'green'][i]

  return (
    <VisDonut value={value} color={color}/>
  )
}

TypeScript

component.ts

const donut = new Donut<number>({
  value: (d: number) =>  d, 
  color: (d: number, i: number) =>  ['red', 'orange', 'blue', 'green'][i]
})

Loading...

Corner Radius

Providing a value to the cornerRadius property adds rounded corners to your Donut's segments proportional to the Donut's arcWidth.

cornerRadius:

React

<VisDonut cornerRadius={5} value={value}/>

Angular

<vis-donut [cornerRadius]="5" [value]="value"></vis-donut>

Svelte

<VisDonut cornerRadius={5} {value}/>

Vue

<VisDonut :cornerRadius="5" :value="value" />

Solid

<VisDonut cornerRadius={5} value={value}/>

TypeScript

const donut = new Donut<number>({ cornerRadius: 5, value })

Loading...

Pad angle

Pad each segment with the padAngle property.

React

<VisDonut value={value} padAngle={0.1}/>

Angular

<vis-donut [value]="value" [padAngle]="0.1"></vis-donut>

Svelte

<VisDonut {value} padAngle={0.1}/>

Vue

<VisDonut :value="value" :padAngle="0.1" />

Solid

<VisDonut value={value} padAngle={0.1}/>

TypeScript

const donut = new Donut<number>({ value, padAngle: 0.1 })

Loading...

Empty Segments

When segments are empty (i.e. when their values are 0), you may still want them displayed in your Donut as thin slices. To do this, set showEmptySegments to true:

showEmptySegments:

React

<VisDonut showEmptySegments={true} value={value} padAngle={0.03}/>

Angular

<vis-donut
  [showEmptySegments]="true" 
  [value]="value" 
  [padAngle]="0.03"
></vis-donut>

Svelte

<VisDonut showEmptySegments={true} {value} padAngle={0.03}/>

Vue

<VisDonut :showEmptySegments="true" :value="value" :padAngle="0.03" />

Solid

<VisDonut showEmptySegments={true} value={value} padAngle={0.03}/>

TypeScript

const donut = new Donut<number>({ showEmptySegments: true, value, padAngle: 0.03 })

Loading...

Customizing empty segment size

When showEmptySegments is enabled, the default size for empty segments is 0.5 * π / 180 radians. You can tweak this to your liking with the emptySegmentAngle property which accepts a number in radians. For example, setting emptySegmentAngle to Math.PI / 12 looks like:

Loading...

Note that this property will have no effect if showEmptySegments is false.

Background

By default, Donut has a background underneath the segments, which is useful when your chart is empty. You can turn it off by setting showBackground to false.

showBackground:

React

<VisDonut
  showBackground={true} 
  value={value} 
  angleRange={[-1.5707963267948966,1.5707963267948966]}
/>

Angular

<vis-donut
  [showBackground]="true" 
  [value]="value" 
  [angleRange]="[-1.5707963267948966,1.5707963267948966]"
></vis-donut>

Svelte

<VisDonut
  showBackground={true} 
  {value} 
  angleRange={[-1.5707963267948966,1.5707963267948966]}
/>

Vue

<VisDonut
  :showBackground="true" 
  :value="value" 
  :angleRange="[-1.5707963267948966,1.5707963267948966]"
 />

Solid

<VisDonut
  showBackground={true} 
  value={value} 
  angleRange={[-1.5707963267948966,1.5707963267948966]}
/>

TypeScript

const donut = new Donut<number>({
  showBackground: true, 
  value, 
  angleRange: [-1.5707963267948966,1.5707963267948966]
})

Loading...

Also, you can change the angular range of the background by providing a [number, number] value (in radians) to backgroundAngleRange. By default, the background angular range will be the same as angleRange.

React

<VisDonut
  value={value} 
  showBackground={true} 
  angleRange={[0,1.0471975511965976]} 
  backgroundAngleRange={[0,6.283185307179586]}
/>

Angular

<vis-donut
  [value]="value" 
  [showBackground]="true" 
  [angleRange]="[0,1.0471975511965976]" 
  [backgroundAngleRange]="[0,6.283185307179586]"
></vis-donut>

Svelte

<VisDonut
  {value} 
  showBackground={true} 
  angleRange={[0,1.0471975511965976]} 
  backgroundAngleRange={[0,6.283185307179586]}
/>

Vue

<VisDonut
  :value="value" 
  :showBackground="true" 
  :angleRange="[0,1.0471975511965976]" 
  :backgroundAngleRange="[0,6.283185307179586]"
 />

Solid

<VisDonut
  value={value} 
  showBackground={true} 
  angleRange={[0,1.0471975511965976]} 
  backgroundAngleRange={[0,6.283185307179586]}
/>

TypeScript

const donut = new Donut<number>({
  value, 
  showBackground: true, 
  angleRange: [0,1.0471975511965976], 
  backgroundAngleRange: [0,6.283185307179586]
})

Loading...

The color of the background can be changed via the --vis-donut-background-color and --vis-dark-donut-background-color CSS variables.

Events

The following selectors are available for events:

import { Donut } from '@unovis/ts'
...
events = {
    [Donut.selectors.segment]: { },
    [Donut.selectors.background]: { },
    [Donut.selectors.centralLabel]: { },
    [Donut.selectors.centralSubLabel]: { },
}

React

<VisDonut value={value} events={events}/>

Angular

<vis-donut [value]="value" [events]="events"></vis-donut>

Svelte

<VisDonut {value} {events}/>

Vue

<VisDonut :value="value" :events="events" />

Solid

<VisDonut value={value} events={events}/>

TypeScript

const donut = new Donut<number>({ value, events })

CSS Variables

All supported CSS variables and their default values

--vis-donut-central-label-font-size: 16px;
--vis-donut-central-label-text-color: #5b5f6d;
--vis-donut-central-label-font-family
--vis-donut-central-label-font-weight: 600;

--vis-donut-central-sub-label-font-size: 12px;
--vis-donut-central-sub-label-text-color: #5b5f6d;
--vis-donut-central-sub-label-font-family
--vis-donut-central-sub-label-font-weight: 500;

--vis-donut-background-color: #E7E9F3;

--vis-dark-donut-central-label-text-color: #C2BECE;
--vis-dark-donut-central-sub-label-text-color: #C2BECE;
--vis-dark-donut-background-color: #18160C;

Component Props

Name	Type	Description
* required property