plotly / plotly/Plotly.NET

[C#] Plotly.NET.CSharp Roadmap

Open
#379 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area: CSharp Area: Meta Area: MissingAbstraction Type: Enhancement
Dominant language
F#
Stars
860
Forks
99
Avg merge
22m
Merged PRs (30d)
1

Description

This issue tracks the roadmap for the native C# package Plotly.NET.CSharp

Plans on how to design and develop the C# API have been laid out and tracked in #285 and #322.

The general roadmap implementation-wise is the following:

  • 1. C# bindings for the high-level Chart construction API (#296), one binding per chart at first (no overloads)
  • 2. C# GenericChart Extension methods (this covers more or less all styling functions). Once these are finished, the F# extension methods for fluent interface can be removed.
  • 3. C# bindings for Object abstractions (TraceObjects, LayoutObjects, etc.) this might be a bit tricky
    Progress on this side has been made on the 'csharp-object-bindings' branch. In short, all these bindings can be auto-generated by using reflection on the F# objects. Might be worth to look into C# source generators

The way to go for the future is clearly code generation. The F# core API could in theory also created from the plotly.js JSON schema, but has many features that would be hard to automate such as type safety for enums etc.

To prevent having to namually maintain 2 code bases though, we should at least try to auto-generate the C# API based on the F# API, over which we have full control.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the roadmap items and the prior design discussions in #285 and #322. Inspect the csharp-object-bindings branch, especially src/Plotly.NET.Codegen, and evaluate the proposed code-generation approach; the roadmap is complete when the remaining C# extension and object bindings are implemented without manually maintaining a second API.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, fsharp
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.