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

@viper-charts/viper-charts

v1.0.22

Published

A free and open-source cross market charting platform

Downloads

21

Readme

ViperCharts 🐍

Viper Charts is an open-source charting library for plotting lines, candlesticks, moving averages, and more.

NOTE: This is still an early Beta build of the package. The API is subject to changes in the future. Please use for experimental purposes.

Run Demo

npm i
npm run start

Usage

To make a new Viper instance, import viper-charts and then create a new class instance

import ViperCharts from "@vipercharts/viper-charts";

const Viper = new ViperCharts({
  element: document.getElementById("viper-container"),
});

The returned Viper instance includes the entire Viper instance. Everything from managing the layout of existing charts, adding / removing charts, and adding / removing datasets.

The constructor for ViperCharts accepts an object with multiple properties. Here's a list of some

type ViperParams = {
  element: HTMLElement; // The container element for Viper
  sources?: SourcesObject; // Dataset sources map / object
  settings?: { [key: string]: any }; // Settings
  onRequestHistoricalData?: Function; // Resolve requests for historical data
  addOrUpdateOrder?: Function; // Resolve requests for Orders belonging to a specific dataset (market)
  onSaveViperSettings?: Function; // Called when viper settings (layout, charts, indicators) udpates (same layout as settings object)
};

type SourcesObject = {
  [key: string]: [key: string]DatasetSource;
};

type DatasetSource = {
  source: string; // Dataset source (ex: COINBASE, FTX)
  name: string; // Dataset name (ex: BTC-USD, BTC-PERP)
  models: [key: string]: DataModel // All supported data models
  maxItemsPerRequest: number; // Max candles to fetch per request (rate limiting, not currently implemented)
  timeframes: [number]; // Array of timeframes in milliseconds supported by dataset (not currently implemented)
};

type DataModel = {
  id: string // Unique id for data model
  name: string // Visible name for data model
  model: string // Model type (ex: ohlc, volumeBySide, footprint) All model types located in the data_models.js file
  label: string // Label used for plotting on Y axis
}
``;

Here's an example sources map using the Binance Spot API

const sources = {
  BINANCE: {
    BTCUSDT: {
      source: "BINANCE",
      name: "BTCUSDT",
      models: {
        price: {
          id: "price",
          model: "ohlc",
          name: "Price",
          label: "Binance:BTCUSDT"
        }
      }
      maxItemsPerRequest: 500,
      timeframes: [
        60000,
        60000 * 5,
        60000 * 15,
        60000 * 60,
        60000 * 60 * 4,
        60000 * 60 * 24,
      ],
    },
  },
};

Examples

For some examples, look at the /src/index.js file.

Demo

Also, a public demo is available at https://viper-charts.netlify.app/