Repository navigation
Releases: plotly/Plotly.NET
Release list
6.0.0
This version removes C# interop from the core F# Plotly.NET library, offloading those implementations directly to the native C# lib Plotly.NET.CSharp:
Milestone link with all the fixed/closed issues
Breaking: Plotly.NET assemblies are no longer strong-named. Maintaining a strong-named build chain has caused recurring friction (see #452, #371, and the broader discussion at StephenCleary/AsyncEx#129) and forced us to maintain a re-packaged signed fork of Giraffe.ViewEngine (giraffe-fsharp/Giraffe.ViewEngine#23). Consumers that still need strong-named binaries can use brutaldev/StrongNameSigner to sign assemblies post-build.
As a consequence, the html dsl dependency switches back from Giraffe.ViewEngine.StrongName 2.0.0-alpha1 to upstream Giraffe.ViewEngine 1.4.0. The namespace is unchanged, so user code is not affected.
-
#504: Upgrade DynamicObj to
[8.0.0, 9.0.0), raising its transitive FSharp.Core minimum to 10.1.300. No Plotly.NET source adaptations were required. The upgrade includes revised hashing and equality for custom properties containing F# option values; ordinary optional chart arguments are unwrapped before storage. -
Bump bundled plotly.js to 2.28.0
-
#459: Breaking: Rename nine
ColorKeywordcases. The old names have been removed; replace usages and pattern matches using the mapping below. RGB values are unchanged, includingLightSlateGrayandLightSlateGrey, which both map to(119, 136, 153).Removed name Replacement DarkolivegreenDarkOliveGreenHoneydewHoneyDewHotpinkHotPinkLightAalmonLightSalmonLightAeaGreenLightSeaGreenLightAkyBlueLightSkyBlueLightAlateGrayLightSlateGrayLightslateGreyLightSlateGreySkyblueSkyBlue -
#477: Fix tick-font serialization for parallel categories and parallel coordinates charts, and add
StyleParam.Shape.HSplinefor horizontal spline paths in parallel categories plots. -
#441: Encoded typed array support — plotly.js 2.28 introduced a base64 representation for numeric arrays. Plotly.NET supports it for selected trace fields and chart constructors:
-
New
EncodedTypedArraytype (inPlotly.NET) carrying a base64 payload (bdata), a dtype tag (dtype), and an optional shape for multi-dimensional data. Supported dtypes:Float64,Float32,Int32,UInt32,Int16,UInt16,Int8,UInt8,UInt8Clamped. -
Convenience constructors:
EncodedTypedArray.ofFloat64Array,ofFloat32Array,ofInt32Array,ofUInt32Array,ofInt16Array,ofUInt16Array,ofInt8Array,ofUInt8Array,ofUInt8ClampedArray— all accept a 1-D .NET array and an optionalshapeparameter for multi-dimensional layouts. -
Encoded fields added across the trace style modules (
Trace2DStyle,Trace3DStyle,TracePolarStyle,TraceGeoStyle,TraceMapboxStyle,TraceTernaryStyle,TraceCarpetStyle,TraceDomainStyle,TraceSmithStyle), covering data arrays (XEncoded,YEncoded,ZEncoded, etc.), metadata arrays (IdsEncoded,CustomDataEncoded,MultiTextEncoded,SelectedPointsEncoded), error bar arrays (ArrayEncoded,ArrayminusEncoded), and trace-specific fields (e.g.Q1Encoded/MedianEncoded/Q3Encodedon BoxPlot,OpenEncoded/HighEncoded/LowEncoded/CloseEncodedon OHLC/Candlestick,OpacityScaleEncodedon Surface/Volume/IsoSurface,IntensityEncoded/IEncoded/JEncoded/KEncodedon Mesh3D, dimensionValuesEncodedon Splom/ParallelCoord). -
Encoded overloads added to selected F#
Chartroot functions (e.g.Chart.Scatter,Chart.Bar,Chart.Waterfall,Chart.Histogram,Chart.BoxPlot,Chart.Violin,Chart.OHLC,Chart.Candlestick,Chart.Splom,Chart.Histogram2D,Chart.Heatmap,Chart.Contour,Chart.Scatter3D,Chart.Surface,Chart.Mesh3D,Chart.Cone,Chart.StreamTube,Chart.Volume,Chart.IsoSurface,Chart.ScatterPolar,Chart.BarPolar,Chart.ScatterGeo,Chart.ChoroplethMap,Chart.ScatterMapbox,Chart.ChoroplethMapbox,Chart.DensityMapbox,Chart.ScatterTernary,Chart.Carpet,Chart.ScatterCarpet,Chart.ContourCarpet,Chart.ScatterSmith,Chart.Pie,Chart.FunnelArea,Chart.Sunburst,Chart.Treemap,Chart.Icicle) and selected derived convenience helpers (e.g.Chart.Point,Chart.Line,Chart.Spline,Chart.Bubble,Chart.Area,Chart.SplineArea,Chart.StackedArea,Chart.Range,Chart.Funnel,Chart.Histogram,Chart.StackedBar,Chart.PointDensity,Chart.PointPolar,Chart.PointGeo,Chart.PointMapbox,Chart.PointTernary,Chart.PointSmith,Chart.PointCarpet,Chart.Doughnut). -
Shared Sankey node/link objects accept encoded positions, source/target/value, and supported numeric metadata. Encoded values replace corresponding plain values when both are supplied in the same init/style call. Labels remain plain strings.
-
One-dimensional samples do not need a shape; matrix inputs use an explicitly shaped flat payload. Strings, arbitrary objects, decimal, and 64-bit integer encoding are outside the supported dtype set. Image pixels and helpers that compute from plain inputs (such as Pareto, Residual, and AnnotatedHeatmap) have no direct encoded overload.
-
The C# package exposes a selected subset of direct chart conveniences, documented in its release notes and the encoded-array guide. This release does not claim all-chart parity or measured encoding performance gains.
-
-
Sankey node alignment —
StyleParam.SankeyNodeAlignsupports Left, Right, Center, and Justify throughSankeyNodesand the F# / C# chart conveniences. -
Virtual-WebGL — existing
DisplayOptions.AdditionalHeadTagscan load the optional WebGL 1 virtualization script before plotly.js; the encoded-array guide shows the script ordering. -
#500: Internal refactor — split the monolithic
Chart.fsinto per-chart-family files (Chart2D_Scatter.fs,Chart2D_Bar.fs, etc.) for better maintainability. No API changes. -
Set comparison charts — new composite charts for visualizing set membership and intersections (in
ChartComposite):Chart.Venndraws a Venn diagram comparing two or three sets (set1,set2, optionalSet3), annotating each region with its member count. Axes are locked to a 1:1 pixel ratio so the circles always render round, and colors/labels/text font are customizable.Chart.UpSetdraws an UpSet plot for an arbitrary number of sets: an intersection matrix, an intersection-size bar chart, and a set-size bar chart, with optional per-intersection attribute plots viaSetData/SetDataChartsTitle.- Both take plain
#seq<string>/#seq<#seq<string>>set inputs (treated as sets internally; duplicates ignored) and support the standardUseDefaultsparameter.
New Contributors
- @gvwilson made their first contribution in #478
- @LibraChris made their first contribution in #493
Full Changelog: 5.1.0...6.0.0
Additional extension package releases::
6.0.0-preview.1
This version removes C# interop from the core F# Plotly.NET library, offloading those implementations directly to the native C# lib Plotly.NET.CSharp:
Milestone link with all the fixed/closed issues
Full Changelog: 5.1.0...6.0.0-preview.1
Plotly.NET v5.1.0
Maintenance release to prevent Plotly.NET breaking for users that upgrade the DynamicObj dependency to >=3.0.0. DynamicObj is now pinned to the version range [2.0.0, 3.0.0) until we manage to make Plotly.NET work with the major changes in that lib.
New Contributors
- @TheKiiiing made their first contribution in #467
Additional extension package releases:
Full Changelog: 5.0.0...5.1.0
Plotly.NET v5.0.0
Major release with lots of bug fixes, improvements, and upstream feature additions from plotly.js. Many changes are backwards-incompatible with previous versions.
Milestone link with all the fixed/closed issues
-
Add Chart.Pareto. This contribution started with the fslab hackathon 2023 and was submitted by @rockfaith75 and @smoothdeveloper, thank you!
-
Make Contours setting directly accessible on all supported traces, fixes #426
-
Allow DynamicObj for the args properties of update buttons, fixes #414
-
Expand DisplayOptions to include direct fields for document title, description, charset, and favicon, fixes #374
-
Keep up with plotlyjs 2.x incremental updates. Note that v2.28+ will be on Plotly.NET 6.0, as some major changes are needed for supporting it properly (see #441)
- v2.22:
- v2.23:
- v2.24:
- v2.25:
- v2.26:
- v2.27:
Additional extension package releases::
- Plotly.NET.ImageExport (5.0.1 -> 6.0.0)
- Plotly.NET.Interactive (4.2.0 -> 5.0.0)
- Plotly.NET.CSharp (0.11.1 -> 0.12.0)
New Contributors
- @chausner made their first contribution in #410
- @integerman made their first contribution in #429
- @smoothdeveloper made their first contribution in #431
Full Changelog: 4.2.0...5.0.0
Plotly.NET v4.2.0
This release makes Plotly.NET compatible with LINQPad.
Read more about this on the respective pull request.
Thanks a lot to @Peter-B-.
Plotly.NET v4.1.0
This is a maintenance release that aims to keep up with plotlyjs 2.x incremental updates.
The only major change is the usage of Giraffe.ViewEngine.StrongName instead of Giraffe.ViewEngine as html dsl.
This could be considered as a breaking change, but it's not because the Giraffe.ViewEngine.StrongName package is a drop-in replacement for Giraffe.ViewEngine with the only difference being a signed assembly
-
Keep up with plotlyjs 2.x incremental updates:
- v2.22+ will be on Plotly.NET 5.0, because it introduces breaking changes.
- v2.21:
- v2.20:
- v2.19:
-
misc fixes and improvements:
Additional extension package releases::
Plotly.NET v4.0.0
This release of Plotly.NET focuses mainly on QOL improvements and keeping up with plotly.js changes.
Plotly.NET
Milestone link with all the fixed/closed issues
-
Add high level arg for base layer style to all mapbox charts
-
Add ShowXAxisRangeSlider argument for Chart.OHLC and Chart.Candlestick
-
Refactor DisplayOptions - An object to control the way Charts are displayed in generated HTML files:
- Add various functions to manipulate DisplayOptions, Refactor DisplayOptions as DynamicObj (again)
- Add
PlotlyJSReferencetype and logic to handle various ways of referencing plotly.js in HTML output:Full: Include the full plotly.js source code. The currently supported plotly.js version is now included as embedded resource in the package. HTML files using this option are self-contained and can be used offline.CDN: The default. uses a script tag in the head of the generated HTML to load plotly.js from a CDN.Require: Use requirejs to load plotly. This option is now used in Plotly.NET.Interactive. Unnecessary usage of require.js is now removed from all other options but this.NoReference: Don't include any plotly.js reference. Useful if you want to embed the output into another page that already references plotly.
-
Keep up with plotlyjs 2.x incremental updates:
- v2.18:
- v2.17:
- v2.16:
- v2.15:
- v2.14:
- v2.13:
- v2.12:
- v2.10:
- v2.9:
- v2.8:
Plotly.NET.Interactive
- Update .NET interactive references
- Use new DisplayOptions functions to use requirejs with the Global plotlyjs version
3.0.0-manuscript
This release triggers a new zenodo doi for the software article to include the used data and can otherwise be ignored.
3.0.0
2.0.0
Plotly.NET 2.0
Plotly.NET finally has reached all milestones for 2.0 and is ready for a stable release.
This release is the culmination of almost 2 years of work in >500 commits by 17 contributors.
Here is an attempt to visualize the history of these changes in a few seconds:
(made with gource)
All APIs have changed significantly - this release is incompatible with 1.x and many 2.x-preview/beta versions.
TL;DR
- All plotly chart/trace types!
- Unified API!
- chart rendering in notebooks!
- programmatic static image export!
- Exhaustive docs!
- We have a discord server, feel free to ask questions there!
Core library
General
- The API layer model has refined and used for every type of plotly object abstraction. In brief,
- There are 5 main categories of abstractions:
Trace(chart data and type),Layout(non-data chart styling),Config(render options),DisplayOptions(html display options),StyleParam(DSL for styling options) - Many properties used in these levels are themselves objects, which are in the respective
*Objectsnamespace (e.g.Geo, which determines map layout of geo traces is an object on theLayoutand therefore in theLaoutObjectsnamespace.) - every object is based on
DynamicObjand its properties can therefore be further customised by dynamic member assignment. Therefore, every plotly property can be set manually, even those which do not have direct abstractions.
- There are 5 main categories of abstractions:
- There are now several
Tracetypes for each kind of subplot (Trace2D,Trace3D, etc.) and eqivalentCharttypes (Chart2D,Chart3D, etc). while not visible from the top level api (everything kan be accessed via the unifiedChartAPI), this greatly improves correct multi chart layouting. - There are 3 ways of creating charts with increasing level of customization:
- The
ChartAPI as a unified API surface for chart creation and stylingChart.<ChartType>(e.g.Chart.Point) for chart creation from data and some chart specific styling optionsChart.with<Style or object>(e.g.Chart.withXAxisStyle) for styling of chart objects
- Creation of Chart objects by manually creating
Trace,LayoutandConfigobjects with many more optional customization parameters - Exclusive usage of
DynamicObj- you can translate any plotly.js javascript with this method.
- The
Chart/Trace abstractions
You can create the following Charts with Plotly.NET's API (and many more by combining them):
-
Cartesian 2D (
Chart2D):Scatter(Point, Line, Spline, Bubble, Range, Area, SplineArea, StackedArea)FunnelWaterfallBar(Bar, Column, StackedBar, StackedColumn)HistogramHistogram2DHistogram2DContourPointDensityBoxPlotViolinHeatmap(Heatmap, AnnotatedHeatmap)ImageContourOHLC(OHLC, CandleSticks)Splom
-
Cartesian 3D (
Chart3D):Scatter3D(Point3D, Line3D, Bubble3D)SurfaceMesh3DConeStreamTubeVolumeIsoSurface
-
Polar (
ChartPolar):ScatterPolar(PointPolar, LinePolar, SplinePolar, BubblePolar)BarPolar
-
Maps (
ChartMap):ChoroplethMapChoroplethMapboxScatterGeo(PointGeo, LineGeo, BubbleGeo)ScatterMapbox(PointMapbox, LineMapbox, BubbleMapbox)DensityMapbox
-
Ternary (
ChartTernary):ScatterTernary(PointTernary, LineTernary, SplineTernary, BubbleTernary)
-
Carpet (
ChartCarpet):CarpetScatterCarpet(PointCarpet, LineCarpet, SplineCarpet, BubbleCarpet)ContourCarpet
-
Domain (
ChartDomain)Pie(Pie, Doughnut)FunnelAreaSunburstTreemapParallelCoordParallelCategoriesSankeyTableIndicatorIcicle
-
Smith (
ChartSmith)ScatterSmith(PointSmith, LineSmith, BubbleSmith)
Plotly.NET.Interactive
You can directly render charts as html cell output with the dotnet interactive kernel:
Plotly.NET.ImageExport
This library provides an interface for image rendering engines to consume plots and create static image files (PNG, JPG, SVG), as well as a reference implementation using PuppeteerSharp to render charts with headless chromium.

