Skip to content
Swizec Teller - a geek with a hatswizec.com

Tiny React & D3 flamegraph tutorial

This is a Livecoding Recap – an almost-weekly post about interesting things discovered while livecoding. Usually shorter than 500 words. Often with pictures. Livecoding happens almost every Sunday at 2pm PDT on multiple channels. You should subscribe to My Youtube channel(https://www.youtube.com/user/theswizec) to catch me live.

Flamegraphs are great. They show you when you've been bad and made the CPU cry.

Here is a flamegraph built with React & D3. It shows some stack data I stole from the internet:

You can try it out here, and see the code on GitHub. Consider it a work in progress. Releasing as open source once the animation works smoothly :)

Here's how it works 👇

You have two components:

  1. <Flamegraph>, which recursively renders the data tree
  2. <FlameRect>, which renders a particular rectangle and its label

Flamegraph

The <Flamegraph> component without animation takes your data, loops it through the array of entries at this level, and calls itself on data.children.

import { scaleLinear, schemeOrRd, color as d3color } from "d3";
class Flamegraph extends React.Component {
render() {
const { x = 0, y = 0, width, level = 0, data } = this.props;
const xScale = scaleLinear()
.domain([0, data.reduce((sum, d) => sum + d.value, 0)])
.range([0, width]);
return (
<g transform="{`translate(${x}," ${y})`}="">
{data.map((d, i) => {
const start = data
.slice(0, i)
.reduce((sum, d) => sum + d.value, 0);
return (
<react class="fragment" key={`${level}-${d.name}`}>
<flamerect x={xScale(start)} y={0} width={xScale(d.value)} height={RowHeight} name={d.name}>
{d.children && (
<flamegraph data={d.children} x={xScale(start)} y={RowHeight} width={xScale(d.value)} level="{level" +="" 1}="">
)}
</flamegraph></flamerect></react>
);
})}
</g>
);
}
}

Our render method takes a bunch of params out of props, creates a linear D3 scale to make calculations easier, then renders an SVG grouping element.

Inside that element, we loop through the data, and for each entry, we create a new <React.Fragment>. The fragment contains <FlameRect> which represents the current datapoint, and a <Flamegraph> which renders all the child nodes.

We decide each element's x position based on the sum of all node values up to the current one. And we make sure the child <Flamegraph> uses the same width as the current node. This creates the neat stacking effect.

The <FlameRect> component takes care of choosing a random color on initial render, highlighting when clicked, and displaying a label if there's enough space.

It looks like this:

import { scaleLinear, schemeOrRd, color as d3color } from "d3";
class FlameRect extends React.Component {
state = {
hideLabel: false,
selected: false,
color: schemeOrRd[9][Math.floor(Math.random() * 9)]
};
labelRefCallback = element => {
if (
element &&
element.getBoundingClientRect().width > this.props.width
) {
this.setState({
hideLabel: true
});
}
};
onClick = () => this.setState({ selected: !this.state.selected });
render() {
const { x, y, width, height, name } = this.props,
{ hideLabel, selected } = this.state;
let { color } = this.state;
if (selected) {
color = d3color(color).brighter();
}
return (
<g transform="{`translate(${x}," ${y})`}="" style={{ cursor: "pointer" }} onclick={this.onClick}>
<rect x={0} y={0} width={width} height={height} style={{ stroke: "white", fill: color }}>
{!hideLabel && (
<text x={5} y={13} style={{ fontsize: "12px" }} ref={this.labelRefCallback}>
{name}
</text>
)}
</rect></g>
);
}
}

We render a grouping element that contains a <rect> and a <text>. The rect gets sizing and color information, and the label gets a ref callback and some text.

We use the ref callback to dynamically detect the size of our label and hide it if necessary. That happens in labelRefCallback.

onClick, we flip the selected state.

And well, that's it. You can think of this component as a basic toggle component. Uses all the same logic, just renders as a colorful rectangle instead of a button.

Fin

That's the basic <Flamegraph> component. Uses recursion to render a tree data structure and lets you highlight individual elements.

Where it gets tricky is adding animation that lets users explore their data. Turns out deeply nested React elements are hard to animate smoothly.

The worst part is how long it takes before React even propagates prop updates through the tree before the animation even starts. Once the animation is running, it's smooth as silk.

But getting it started, ho boy.

This warrants further research. I'll be back :)

PS: version 0.1.0 is in fact on npm if you want to play.

Did you enjoy this article?

Published on June 6th, 2018 in Front End, Livecoding, Technical

Learned something new?
Want to become a high value JavaScript expert?

Here's how it works 👇

Leave your email and I'll send you an Interactive Modern JavaScript Cheatsheet 📖right away. After that you'll get thoughtfully written emails every week about React, JavaScript, and your career. Lessons learned over my 20 years in the industry working with companies ranging from tiny startups to Fortune5 behemoths.

Start with an interactive cheatsheet 📖

Then get thoughtful letters 💌 on mindsets, tactics, and technical skills for your career.

"Man, love your simple writing! Yours is the only email I open from marketers and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. 👌"

~ Ashish Kumar

Join over 10,000 engineers just like you already improving their careers with my letters, workshops, courses, and talks. ✌️

Have a burning question that you think I can answer? I don't have all of the answers, but I have some! Hit me up on twitter or book a 30min ama for in-depth help.

Ready to Stop copy pasting D3 examples and create data visualizations of your own?  Learn how to build scalable dataviz components your whole team can understand with React for Data Visualization

Curious about Serverless and the modern backend? Check out Serverless Handbook, modern backend for the frontend engineer.

Ready to learn how it all fits together and build a modern webapp from scratch? Learn how to launch a webapp and make your first 💰 on the side with ServerlessReact.Dev

Want to brush up on your modern JavaScript syntax? Check out my interactive cheatsheet: es6cheatsheet.com

By the way, just in case no one has told you it yet today: I love and appreciate you for who you are ❤️