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

chronomap

v1.0.0

Published

provides functionality for syncing and interacting with a leaflet map and a vis-timeline

Downloads

8

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

puiutucutupuiutucutu

Keywords

Readme

chronomap

Provides functionality for syncing and interacting with a leaflet map and a vis-timeline.

screenshot

Docs

  • https://puiutucutu.github.io/chronomap/

Features

  • sync leaflet marker layers with timeline groups
  • synced layer toggling
  • pan to timeline item on marker click
  • pan map to marker on timeline item click
  • hooks for manually panning timeline and map to marker
  • does not bundle leaflet or vis-timeline dependencies making for a light build (only 36 kb)

Use

Browser

Import chronomap.umd.js and access it via the snake case chronoMap window global.

Since leaflet and vis-timeline are depenencies, they must be loaded before chronoMap so that the globals L and vis exist in the browser's namespace.

The snippet below clarifies this - see the full example at ./examples/browser/index.html.

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Chronomap - Browser UMD Example</title>
    <!-- Not Required -->
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/css/tachyons.min.css"/>
    <!-- Required -->
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/leaflet.css"/>
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/vis-timeline-graph2d.min.css"/>
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/leaflet.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/vis-timeline-graph2d.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/chronomap.umd.js"></script>
  </head>
[...]

Node

Only one export is provided via ./dist/chronomap.ejs.js.

See ./examples/node for a standalone example.

Install

npm install chronomap

Importing and Usage

Similar to the umd build, the ejs build requires leaflet and vis-timeline to be imported seperately.

After importing Chronomap, your bundling tool is responsible for bundling the leaflet and vis-timeline dependencies.

import L from "leaflet";
import { Chronomap } from "chronomap";
[...]

Inside chronomap.ejs.js, the required imports from vis-timeline will be provided by your bundler.

// inside `chronomap.ejs.js`
import { DataSet, Timeline } from 'vis-timeline';

Development

npm run start

Outputs a bundled build in the ./development/dist folder and serves the ./development/index.html file locally.

Todo

  • [ ] add tests
  • [x] reduce bundle size by making leaflet and vis-timeline external requirements
  • [ ] extract functionality to interop with other mapping libraries