data-forge-plot
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.2 • Public • Published

    data-forge-plot

    The forgiving plotting API designed for use with Data-Forge.

    Data-Forge Plot is now a simple wrapper for the Plot library.

    Use Data-Forge Plot to quickly and conveniently render charts from your data in JavaScript or TypeScript. It is an abstraction layer that connects Data-Forge with JavaScript visualization libraries so that it's easy to plot charts from your data.

    Why not do your data wrangling, analysis and visualization entirely in JavaScript? To support my effort please buy or help promote my book Data Wrangling with JavaScript.

    Or check out my blog: The Data Wrangler.

    Do your prototyping and exploratory data analysis in JavaScript with Data-Forge Notebook.

    Please join the conversation on Gitter

    Breaking changes

    As of version 1.0.0 Data-Forge Plot has been gutted and reimplimented in terms of the Plot library (which is very similar). DFP is now just a wrapper for Plot to ease my maintence burden.

    The function exportWeb has been removed because it is to difficult to maintain.

    If you want to use this in the browser please use the Plot library instead, e.g.:

    const dataframe = ...
    const plotConfig = { ... };
    const axisMap = { ... };
    import { plot } from "plot";
    import "@plotex/render-dom";
    plot(dataframe.toArray(), plotConfig, axisMap)
        .renderDOM(document.getElementByID("a-chart");

    --

    As of version 0.4.0 the Nightmare/Electron depenency has been removed along with the renderImage function.

    The renderImage function has been moved to the separate library @data-forge-plot/render. This has been removed due to the size that the Electron dependency adds to this package. In the future you you will have to install the separate package to render a plot to an image.

    Please note that the sample code below to see how the new library is installed and required to access the renderImage function.

    Project Goals

    • To simply and conveniently from a series or dataframe to chart.
    • To create charts and visualizations in Node.js and the browser.
    • To be able to serialize a chart to JSON and then reinstantiate it from the JSON in a web-app.
    • To separate configuration and data definition to make it easy to reuse charts.
    • To configure charts in JSON or fluent API.

    Usage

    Some instructions for using Data-Forge Plot. These instructions are for JavaScript, but this library also works in TypeScript.

    Install

    npm install --save data-forge data-forge-plot @plotex/render-image
    

    Setup

        const dataForge = require('data-forge');
        require('data-forge-fs'); // Extends Data-Forge with 'readFile' function.
        require('data-forge-plot'); // Extends Data-Forge with the 'plot' function.
        require('@plotex/render-image'); // Extends Data-Forge Plot with the 'renderImage' function.
        require('@plotex/render-dom'); // Extends Data-Forge Plot with the 'renderDOM' function.

    Rendering a chart from a CSV file to an image file

        const dataFrame = await dataForge.readFile("my-data-file.csv").parseCSV();
        await dataFrame.plot().renderImage("my-chart.png");

    Rendering a chart to a web page.

        const dataArray = // ... acquire data, e.g. from a REST API ...
        const dataFrame = new DataFrame(dataArray);
        const chartElement = document.getElementById("chart");
        await dataFrame.plot().renderDOM(chartElement);

    Keywords

    none

    Install

    npm i data-forge-plot

    DownloadsWeekly Downloads

    58

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    12.5 kB

    Total Files

    12

    Last publish

    Collaborators

    • ashleydavis