Vue.D3.Sunburst


!demo gif

Live example:

https://david-desmaisons.github.io/Vue.D3.sunburst/

About

Vue.D3.Sunburst provides a reusable vue sunburst charts component relying on D3.js.

Sunburst is the main component of this library and display sunburst chart based on data props using children property for hierarchy, name property for naming and size property for arcs size.

Sunburst component provides four optional slots:

* legend and top slots are intended to be used to display additional information such as legend
* pop-up to create a pop-up for an arc
* default slot is intended to receive renderless component providing behavior: for example, highlighting on mouse over or zoom on click

Components providing standard and reusable features are provided.

Features

* Reactive to data changes
* Responsive to size changes
* Customizable with slot or exposed methods and events
* Zoomable

Install

``
npm i vue-d3-sunburst
`

Usage

`HTML















`

`javascript
import {
breadcrumbTrail,
highlightOnHover,
nodeInfoDisplayer,
popUpOnHover,
sunburst,
zoomOnClick
} from 'vue-d3-sunburst';
import "vue-d3-sunburst/dist/vue-d3-sunburst.css";

export default {
components: {
breadcrumbTrail,
highlightOnHover,
nodeInfoDisplayer,
sunburst,
zoomOnClick
},
data() {
return {
tree: {
"name": "flare",
"children": [
{
"name": "analytics",
"children": [
{
"name": "cluster",
"children": [
{ "name": "AgglomerativeCluster", "size": 3938 },
{ "name": "CommunityStructure", "size": 3812 },
{ "name": "HierarchicalCluster", "size": 6714 },
{ "name": "MergeEdge", "size": 743 }
]
},
{
"name": "graph",
"children": [
{ "name": "BetweennessCentrality", "size": 3534 },
{ "name": "LinkDistance", "size": 5731 },
{ "name": "MaxFlowMinCut", "size": 7840 },
{ "name": "ShortestPaths", "size": 5914 },
{ "name": "SpanningTree", "size": 3416 }
]
},
{
"name": "optimization",
"children": [
{ "name": "AspectRatioBanker", "size": 7074 }
]
}
]
}
]
}
}
}
}
`

Gotchas

This component is responsive and will adjust to resizing. In order for this to work properly, you must define for this component or its parent wether:

* a height or a max-height
* or a width or a max-width.

Failing to do so may result in a component whose size that will keep increasing.

API

$3

#### slots

- legend Use this slot to add information on top or bottom of the graph

- top Use this slot to add information on top of the graph

- pop-up Use this slot to create a pop-up for arc: it receives as scope data, node and actions objects

- default Use this slot to add behaviors to the sunburst

#### props

- data Object (optional)

Sunburst data where children property is a array containing children.

- color-scheme String (optional) default: provided by injected defaultSchemeColor with a fall back to schemeAccent

D3 color scheme to be used.

- color-scale Function (optional) default: undefined

D3 scale of colors (d3-scale). If specified, it overwrites the color-scheme props

- get-category-for-color Function (optional) default: 'useNameForColor'

Function used to map an item and its color. (nodeD3: Object) => category: Number | String By default use the node name

- highlightOpacity Number (optional) default: '0.3'

Opacity to be applied to none highlighted nodes

- min-angle-displayed Number (optional) default: 0.005

Minimal arc angle to be displayed (in radian).

- arc-identification Function (optional) default: 'recursiveName'

Function used to identify an arc, will be used during graph updates. (nodeD3: Object) => id: String

- in-animation-duration Number (optional) default: 100

Duration for in animation in milliseconds

- out-animation-duration Number (optional) default: 1000

Duration for out animation in milliseconds

- show-labels Boolean or Function (optional) default: false

- If true displays the name attributes as arc labels
- If the value is a function, it must return the text that will be display for each arc. The function is called with an object similar to the D3.js node with the addition of a context property: { context: {angle: 45, relativeDepth: 1} } where angle is the arc angle in degree and relativeDepth is the arc depth in the current display (taking into account zoom). To display nothing returns null.

- max-label-text Number (optional) default: 45

Useful to truncate labels: the maximum size of a label is the corresponding arc size + the value of max-label-text in pixel. If max-label-text is null, the labels will not be truncated.

- central-circle-relative-size Number (optional) default: 0

Size in percentage of the total graph, of a central circle

#### events

- mouseLeave

Fired when mouse leaves the sunburst node.

- rootChanged

Fired when root changed.

arguments:

- value Object - {node, sunburst} The corresponding node and sunburst component

- mouseOverNode

Fired when mouse is over a sunburst node.

arguments:

- value Object - {node, sunburst} The corresponding node and sunburst component

- clickNode

Fired when sunburst node is clicked.

arguments:

- value Object - {node, sunburst} The corresponding node and sunburst component

- zoomedChanged

Fired when the zoomed node changed.

arguments:

- value Object - {node, sunburst} The corresponding zoomed node and sunburst component

- highlightedChanged

Fired when mouse is over a sunburst node.

arguments:

- value Object - {node, sunburst} The corresponding node and sunburst component

- resize

Fired when component is resizing.

arguments:

- value Object - {radius, height, width} Size information in pixel

#### methods

- highlightPath(node, opacity)

Highlight the arc path leading to a given node.

parameters:

- node Object - the D3 node to highlight
- opacity Number - opacity of the none highlighted nodes, default to highlightOpacity

- zoomToNode(node)

Zoom to a given node.

parameters:

- node Object - the D3 node to zoom to.

- resetHighlight()

Reset the highlighted path

Other optional components provided as slot implementation

Besides sunburst component, Vue.D3.Sunburst provides additional optional components that can be used out of the box as slot implementations.
There are two kinds of additional components:

* the "renderfull" components provide visual additional visual information on the nodes. They can be used as legend or top slots.
* the renderless components provide predefined behaviors for the sunburst components. They can be used as default slots. It is possible to combine behavior using a root template slot element as in the example.

$3

#### breadcrumbTrail

Breadcrumb trail component displaying path between root node and current node. Can be used as a legend slot of sunburst component.

##### props

- root Object (optional)

Root node

- current Object (optional)

Current node

- from Object (optional)

Reference node, parents nodes of the current will have an opacity below 1

- color-getter Function (required)

ColorGetter exposed by sunburst

- width Number (optional)

Sunburst width

- order Number (optional) default: 1

Css Order. If 1 the slot is displayed below the sunburst, if 0 the slot is displayed on top the sunburst

- item-width Number (optional) default: 80

Bread crumb item width

- item-height Number (optional) default: 30

Bread crumb item height

- spacing Number (optional) default: 3

Spacing between breadcrumb items

- tail-width Number (optional) default: 10

With of tailing element

#### nodeInfoDisplayer

Component that display the percentage value of the current node relative to root. Can be used as a "top" slot of sunburst component.

##### props

- root Object (optional)

Root node

- current Object (optional)

Current node

- clicked Object (optional)

Clicked node

- description String (required)

Text to be displayed

- show-all-number Boolean (optional) default: true

Show fraction format of size if true

##### computed properties

- percentage

dependencies: current, root, current, base

- displayPercentage

dependencies: percentage

- show

dependencies: percentage

$3

These components can be used as a default slot of the sunburst component which received as attributes:

* on which is the $on method of the sunburst component:

* actions which is an object containing the attributes:
* highlightPath: function that takes a node and highlight the path going from the root to the given node
* zoomToNode: function that takes a node and zoom to the corresponding node
* resetHighlight: function that resets the highlighting
* setContextMenu: function that takes a node and display the corresponding pop-up
* closeContextMenu: function that remove the current pop-up if any

Typical usage:

`javascript
this.on("clickNode", ({node}) =>{
this.actions.zoomToNode(node);
});
`

#### zoomOnClick

Renderless component providing the zoom on click behavior.
Can be used as a default slot of sunburst component.

##### props

- on Function (required)

Sunburst event listener. Same as component $on method.

- actions Object (required)

Sunburst actions. Typically provided by sunburst default slot.

#### highlightOnHover

Renderless component providing path highlighting on mouse over behavior.
Can be used as a default slot of sunburst component.

##### props

- on Function (required)

Sunburst event listener. Same as component $on method.

- actions Object (required)

Sunburst nodes. Typically provided by sunburst default slot.

#### popUpOnHover

Renderless component displaying arc pop-up on mouse over.
Can be used as a default slot of sunburst component.

##### props

- on Function (required)

Sunburst event listener. Same as component $on method.

- actions Object (required)

Sunburst nodes. Typically provided by sunburst default slot.

Installation

`
npm install vue-d3-sunburst
`

Project setup

`
npm install
`

$3

`
npm run serve
`

$3

`
npm run build
`

$3

`
npm run lint
`

$3

`
npm run test:unit
`

$3

`
npm run doc:build
``