Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 06bf2d2

Browse files
committed
Updated readme and exports.
1 parent 03e1acc commit 06bf2d2

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,12 @@ Please join the conversation on [Gitter](https://gitter.im/data-forge)
1515

1616
## Breaking changes
1717

18-
As of version 0.4.0 the Nightmare/Electron depenency has been removed along with the `renderImage` function. The `renderImage` function will soon be made available in a separately installable plugin. 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.
18+
As of version 0.4.0 the Nightmare/Electron depenency has been removed along with the `renderImage` function.
19+
20+
The `renderImage` function has been moved to the separate library [@data-forge-plot/render](todo). 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.
21+
22+
Please note that the sample code below to see how the new library is installed and *required* to access the `renderImage` function.
23+
1924

2025
## Project Goals
2126

@@ -32,14 +37,15 @@ Some instructions for using Data-Forge Plot. These instructions are for JavaScri
3237

3338
### Install
3439

35-
npm install --save data-forge data-forge-plot
40+
npm install --save data-forge data-forge-plot data-forge-plot-render
3641

3742
### Setup
3843

3944
```javascript
4045
const dataForge = require('data-forge');
4146
require('data-forge-fs'); // Extends Data-Forge with 'readFile' function.
4247
require('data-forge-plot'); // Extends Data-Forge with the 'plot' function.
48+
require('@data-forge-plot/render'); // Extends Data-Forge Plot with the 'renderImage' function.
4349
```
4450

4551
### Rendering a chart from a CSV file to an image file

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "data-forge-plot",
3-
"version": "0.4.1",
3+
"version": "0.4.3",
44
"description": "Plotting API for use with Data-Forge.",
55
"main": "build/index.js",
66
"types": "build/index.d.ts",

src/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import { IDataFrame, DataFrame } from "data-forge";
33
import { IPlotAPI, PlotAPI, /*todo: globalChartRenderer,*/ startPlot, endPlot } from "./plot-api";
44
import { IPlotConfig, IAxisMap } from "./chart-def";
55
export * from "./chart-def";
6+
export { IPlotAPI } from "./plot-api";
67
export { ChartType, AxisType, HorizontalLabelPosition, VerticalLabelPosition } from "@data-forge-plot/chart-def";
78

89
//

0 commit comments

Comments
 (0)