Skip to content

Commit 423ca23

Browse files
committed
Add XML docs for all Chart3D APIs, convenience overloads and some more params
1 parent e9e279a commit 423ca23

5 files changed

Lines changed: 717 additions & 23 deletions

File tree

docs/00_0_basics.fsx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,13 @@ These are mirrored in Plotly.NET's central type, `GenericChart`:
5656
5757
The central type that gets created by all Chart constructors is `GenericChart`, which itself represents either a single chart or a multi chart (as a Discriminate Union type). It looks like this:
5858
59-
*)
60-
61-
(***do-not-eval***)
59+
```fsharp
6260
type GenericChart =
6361
| Chart of Trace * Layout * Config * DisplayOptions
6462
| MultiChart of Trace list * Layout * Config * DisplayOptions
6563
66-
(**
64+
```
65+
6766
As you can see, a `GenericChart` consists of four top level objects - `Trace` (multiple of those in the case of a MultiChart) , `Layout`, `Config`, and `DisplayOptions`.
6867
6968
- `Trace` is in principle the representation of a dataset on a chart, including for example the data itself, color and shape of the visualization, etc.

src/Plotly.NET/ChartAPI/Chart2D.fs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ module Chart2D =
3232

3333

3434
/// <summary>
35-
/// Creates a Scatter chart. Scatter charts are the basis of Point, Line, and Bubble Charts in Plotly, and can be customized as such. We also provide abstractions for those: Chart.Line, Chart.Point, Chart.Bubble
35+
/// Creates a Scatter plot.
36+
///
37+
/// Scatter charts are the basis of Point, Line, and Bubble Charts, and can be customized as such. We also provide abstractions for those: Chart.Line, Chart.Point, Chart.Bubble
3638
/// </summary>
3739
/// <param name="x">Sets the x coordinates of the plotted data.</param>
3840
/// <param name="y">Sets the y coordinates of the plotted data.</param>

0 commit comments

Comments
 (0)