npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

d3-milestones

v1.4.7

Published

A d3 based timeline visualization.

Downloads

1,676

Readme

npm npm npm github ci

d3-milestones

A d3 based timeline visualization.

The Viking Timeline

  • NPM: https://www.npmjs.com/package/d3-milestones
  • Github: https://github.com/walterra/d3-milestones
  • Storybook demos: https://walterra.github.io/d3-milestones

If you're using d3-milestones out in the wild I'd love to see what you came up with, just ping me on twitter.com/walterra.

Installing

yarn add d3-milestones.

The most quick way to get going is to use unpkg.com as a CDN to include the library directly into your HTML file.

<link rel="stylesheet" href="https://unpkg.com/d3-milestones/build/d3-milestones.css">
<script src="https://unpkg.com/d3-milestones/build/d3-milestones.min.js"></script>

<div id="timeline"></div>

<script>
  milestones('#timeline')
    .mapping({
      'timestamp': 'year',
      'text': 'title'
    })
    .parseTime('%Y')
    .aggregateBy('year')
    .render([
      { year: 789, title: 'Vikings begin attacks on England.' },
      { year: 840, title: 'Vikings found Dublin in Ireland.' }
      ...
      { year: 1050, title: 'The city of Oslo is founded in Norway.' },
      { year: 1066, title: 'Battle of Hastings.' }
    ]);
</script>

Head over here to see this example in action: https://beta.observablehq.com/@walterra/vikings-timeline.

Examples

Examples are included using storybook:

API Reference

General Usage

To initialize d3-milestones, pass a DOM Id to its main factory:

  const vis = milestones('#wrapper');

The returned object exposes the following API:

# vis.aggregateBy(interval)

Sets the aggregation interval for the event data, where interval can be one of second, minute, hour, day, week, month, quarter or year.

# vis.distribution(string)

Sets the label distribution, can be top-bottom, top or bottom. Defaults to top-bottom. The options don't change for vertical layouts. top refers to labels on the left and bottom to labels on the right for that layout.

# vis.mapping(configObject)

Sets overrides for the default attributes for the expected data structure of an event. This defaults to:

  {
    category: undefined,
    entries: undefined,
    timestamp: 'timestamp',
    text: 'text',
    url: 'url'
  };

The method allows you to override single or multiple attributes to map them to fields in your original data with a single call like:

    vis.mapping({
      'timestamp': 'year',
      'text': 'title'
    })

# vis.optimize(boolean)

Enables/Disables the label optimizer. When enabled, the optimizer attempts to avoid label overlap by vertically displacing labels.

# vis.autoResize(boolean)

Enables/Disables auto resizing. Enabled by default, this adds listeners to resizing events of the browser window.

# vis.orientation(string)

Sets the orientation of the timeline, can be either horizontal or vertical. Defaults to horizontal.

# vis.parseTime(specifier)

Specifies the formatter for the timestamp field. The specifier string is expected to resemble a format described here: https://github.com/d3/d3-time-format#locale_format

# vis.labelFormat(specifier)

The labelFormat for the time label for each milestones defaults to '%Y-%m-%d %H:%M'. Using aggregateBy, labelFormat will be set automatically to a reasonable format corresponding to the aggregation level. Still, this method is available to override this behavior with a custom labelFormat.

# vis.urlTarget(string)

Customizes the target attribute when labels are provided with a URL. Can be _blank, _self, _parent or _top.

# vis.useLabels(boolean)

Enables/Disables the display of labels.

# vis.render([data])

When called without data this triggers re-rendering the existing visualization.

data is expected to be an array of event objects with fields matching either the expected defaults (timestamp and text attribute) or the provided mapping via .mapping().

# vis.onEventClick(function)

Set a callback which is executed when the text or image is clicked.

  vis.onEventClick((d) => {
    console.log('click', d);
    alert(`
      ${d.text} | ${d.timestamp}
      ${JSON.stringify(d.attributes)}
    `);
  })

# vis.onEventMouseOver(function)

Set a callback which is executed when the mouse cursor is over text or image.

  vis.onEventMouseOver((d) => {
    console.log('mouseover', d);
  })

# vis.onEventMouseLeave(function)

Set a callback which is executed when the mouse cursor is leaving text or image.

  vis.onEventMouseLeave((d) => {
    console.log('mouseleave', d);
  })

More

d3-milestones is also available as a visualization plugin for Kibana here: https://github.com/walterra/kibana-milestones-vis