# node-plotly

> An un-official plot.ly API client

Latest version **1.0.0** (published 2016-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-plotly
pnpm add node-plotly
yarn add node-plotly
bun add node-plotly
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-07-26 |
| First published | 2016-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Frederic Gingras |
| Maintainers | kiasaki |
| Keywords | plotly, plotlyjs, api, client, visualization, graph, data |

## Links

- npm: https://www.npmjs.com/package/node-plotly
- Repository: https://github.com/kiasaki/node-plotly
- Homepage: https://github.com/kiasaki/node-plotly#readme
- Issues: https://github.com/kiasaki/node-plotly/issues
- npm.io page: https://npm.io/package/node-plotly

## Dependencies (2)

- [ramda](https://npm.io/package/ramda.md) 0.21.0
- [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) 2.2.1

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-07-26

## README

# Plot.ly Node API

## intro

`node-plotly` is an un-official JavaScript client library for `https://api.plot.ly/v2/`.

See below for documentation. Or visit [https://api.plot.ly/v2/](https://api.plot.ly/v2/) for
more details on specific endpoints

## documentation

### configuration / authentication

Configuring the API client with your own API credential and optionally an On-Prem host is as simple
as calling the `.config` method like so:

```js
var PlotlyAPI = require('node-plotly');

PlotlyAPI.config({
  username: 'string', // default: undefined
  apiKey: 'string', // default: undefined
  protocol: 'string', // default: https
  host: 'string', // default: api.plot.ly
});
```

### users

#### `PlotlyAPI.Users.create`

#### `PlotlyAPI.Users.update`

#### `PlotlyAPI.Users.retrieve`

### files

#### `PlotlyAPI.Files.update`

#### `PlotlyAPI.Files.retrieve`

### grids

#### `PlotlyAPI.Grids.create`

#### `PlotlyAPI.Grids.update`

#### `PlotlyAPI.Grids.content`

### plots

#### `PlotlyAPI.Plots.create`

#### `PlotlyAPI.Plots.update`

#### `PlotlyAPI.Plots.content`

### Dashboards

#### `PlotlyAPI.Dashboards.content(fileId, shareKey?)`

```js
PlotlyAPI.Dashboards.content('user:1').then(function(result) {
  console.log(result);
});
```

```js
{
  collaborators: {count: 0, results: []},
  comments: null,
  content: '...',
  creation_time: '2016-07-18T20:01:55.490291Z',
  date_modified: '2016-07-18T20:01:55.490Z',
  deleted: null,
  embed_url: 'https://local.plot.ly/~._-aA1/114.embed',
  fid: '._-aA1:114',
  filename: 'Map Dashboard',
  filetype: 'dashboard',
  image_urls: {},
  img_url: '',
  owner: '._-aA1',
  parent: -1,
  parented: true,
  preview: '',
  referencers: [],
  references: [],
  share_key: null,
  share_key_enabled: null,
  stars: null,
  subfolder_count: null,
  title: '',
  views: 0,
  web_url: 'https://local.plot.ly/~._-aA1/114/',
  world_readable: true,
  api_urls: {
    files: 'https://api-local.plot.ly/v2/files/._-aA1:114',
    dashboards: 'https://api-local.plot.ly/v2/dashboards/._-aA1:114',
    parent: 'https://api-local.plot.ly/v2/folders/home?user=._-aA1'
  }
}
```

## license

MIT. See `license` file.

---
_Source: https://npm.io/package/node-plotly · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._