Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

fancy-axis

0.1.0 • Public • Published

FancyAxis

This is a package to draw fancier axes in D3 for your graphs, based on the visual style of Edward Tufte, and on this previous work done in R:

Usage

Node

Install via npm:

npm install fancy-axis

and import:

import { rugPlot } from "fancy-axis";

Script

You can also load the script directly on the page, and it will be stored globally:

<script src="https://unpkg.com/fancy-axis@0.0.2"></script>
<script>
    const { rugPlot } = fancyAxis;
</script> 

Features

Rug Plot

rug plot example

Usage

Use in place of d3.axisBottom and d3.axisLeft. The function signatures are the same, except that rugPlot takes in an optional options object to customize the look of your axes (see below).

All methods that are available on the result of d3.axisBottom and d3.axisLeft are available on the rug plot as well. So:

rugPlot.axisLeft(yScale).scale(); // returns yScale again

There are two methods available on the rugPlot axis specific to this library.

Name type required Notes
x or y func false x is available on axisBottom only, and y on axisLeft only. It will be passed each data point and the index as arguments: (data: any, index: number) => any
datum iterable false the data for your graph. If not passed, then the axis still render.

Here is a simple example of how you could use rugPlot to render your axis.

import { rugPlot } from "fancy-axis";
 
// dataset is like [{y: ... }, ...]
const leftAxis = rugPlot.axisLeft(yScale).datum(dataset).y(d => d.y);
 
svg.append("g")
    .attr("class", "y axis")
    .call(leftAxis);

You will need to do both axes for it to display correctly. If you do not want the rug plot on the other axis, you can omit the datum from it:

let bottomAxis = rugPlot.axisBottom(xScale);

And it will not render the data, but the padding will be correct.

Options

Passing these options can help customize the rug plot.

Name type Notes
width number width of the rug 'tassels'
color string css color of the rug 'tassels'
strokeWidth number thickness of the rug 'tassels'

These options help create the graph seen earlier in this doc:

const bottomAxis = rugPlot
    .axisBottom(xScale, {
        width: 10,
        color: "rgba(0, 0, 0, 0.1)",
        strokeWidth: 2,
    })
    .datum(dataset)
    .x((d) => d[0]);

Keywords

Install

npm i fancy-axis

DownloadsWeekly Downloads

11

Version

0.1.0

License

GPL-3.0-or-later

Unpacked Size

129 kB

Total Files

15

Last publish

Collaborators

  • avatar