README.md

Plotly.NET provides functions for generating and rendering plotly.js charts in .NET programming languages 📈🚀.

Table of contents

• Installation
  • For applications and libraries
  • For scripting
  • For dotnet interactive notebooks
• Documentation
  • Getting started
  • Full library reference
• Develop
  • build
  • docs
• Library license

Installation

Plotly.NET will be available as 2.0.0 version of its predecessor FSharp.Plotly. The feature roadmap can be seen here. Contributions are very welcome!

Old packages up until version 1.2.2 can be accessed via the old package name FSharp.Plotly here

The most recent Plotly.NET package is .

For applications and libraries

• dotnet CLI

dotnet add package Plotly.NET <version>

• paket CLI

paket add Plotly.NET --version <version>

• package manager

Install-Package Plotly.NET -Version <version>

Or add the package reference directly to your .*proj file:

<PackageReference Include="Plotly.NET" Version="<version>" />

For scripting

You can include the package via an inline package reference:

#r "nuget: Plotly.NET, <version>"

For dotnet interactive notebooks

You can use the same inline package reference as in script, but as an additional goodie, the interactive extensions for dotnet interactive have you covered for seamless chart rendering:

#r "nuget: Plotly.NET, <version>"
#r "nuget: Plotly.NET.Interactive, <version>"

Documentation

Getting started

The landing page of our docs contains everything to get you started fast, check it out 📖 here

Full library reference

The API reference is available 📚 here

The documentation for this library is automatically generated (using FSharp.Formatting) from *.fsx and *.md files in the docs folder. If you find a typo, please submit a pull request!

Development

Note: The release and prerelease build targets assume that there is a NUGET_KEY environment variable that contains a valid Nuget.org API key.

build

Check the build.fsx file to take a look at the build targets. Here are some examples:

# Windows

# Build only
./build.cmd

# Full release buildchain: build, test, pack, build the docs, push a git tag, publsih thze nuget package, release the docs
./build.cmd -t release

# The same for prerelease versions:
./build.cmd -t prerelease


# Linux/mac

# Build only
build.sh

# Full release buildchain: build, test, pack, build the docs, push a git tag, publsih thze nuget package, release the docs
build.sh -t release

# The same for prerelease versions:
build.sh -t prerelease

docs

The docs are contained in .fsx and .md files in the docs folder. To develop docs on a local server with hot reload, run the following in the root of the project:

# Windows
./build.cmd -t watchdocs

# Linux/mac
./build.sh -t watchdocs

release

Library license

The library is available under the MIT license.