Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
320 changes: 320 additions & 0 deletions plans/ChartAPIFileSplit.md

Large diffs are not rendered by default.

28 changes: 22 additions & 6 deletions plans/EncodedArraySupport.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,8 +271,10 @@ Implemented so far:
- Trace3D encoded support
- subplot trace-family support for polar, geo, mapbox, ternary, and smith traces
- carpet and domain trace-family support
- top-level `Chart` API encoded overloads for every foundational chart root (phase H1)
- top-level `Chart` API encoded overloads for derived convenience helpers (phase H2)

Committed so far:
Trace-level commits:

- `62a96500` `Bump bundled plotly.js to 2.28.0`
- `43ff9869` `Complete encoded scatter fields and error arrays`
Expand All @@ -283,20 +285,34 @@ Committed so far:
- `81bd99fd` `Add encoded subplot trace fields (part 1)`
- `8a9fcb64` `Add encoded carpet and domain trace fields`

Top-level Chart API commits:

- `37006fd9` `Add encoded Chart.Scatter root support` (H1-A prototype, superseded by reset design)
- `5edcbb17` `Add encoded scatter-derived helper support` (H1-B prototype, superseded by reset design)
- `b5767af5` `Add encoded scatter-derived chart overloads` (H1-B, reset design)
- `02df1fad` `Add encoded Waterfall width support` (H1-C support fix)
- `4913748a` `Add encoded distribution and finance chart roots` (H1-D)
- `ed86f94d` `Add encoded Dimension values and Chart.Splom root support` (H1-D-Splom)
- `62e9161c` `Add encoded matrix chart root overloads` (H1-E)
- `045a2b63` `Add encoded 3D chart root overloads` (H1-F)
- `1d8e9e54` `Add encoded subplot and domain chart roots` (H1-G part 1)
- `73965294` `Add remaining encoded chart roots` (H1-G part 2)
- `c9446e58` `Add encoded derived convenience chart overloads` (H2)

Implemented but not yet committed:

- none for the trace-level rollout
- none

Next planned action:
Current stage:

- plan and implement top-level `Chart` API support for encoded arrays
- phase H1 (foundational chart roots) and phase H2 (derived convenience helpers) are complete and committed
- next planned phase is H3 (C# surface projection in `Plotly.NET.CSharp`)

Latest verification result:

- `.\build.cmd runTestsCore`
- `802` tests passed
- `933` tests passed
- `Plotly.NET` builds successfully
- current committed `Commit G1` work introduces temporary F# XML-doc warnings for newly added encoded parameters

## Next Phase: Top-Level Chart API Support

Expand Down
62 changes: 31 additions & 31 deletions src/Plotly.NET.CSharp/ChartAPI/Chart2D.cs
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public static GenericChart Scatter<XType,YType,TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Scatter(
Plotly.NET.Chart2D_Scatter.Chart.Scatter(
x: x,
y: y,
mode: mode,
Expand Down Expand Up @@ -178,7 +178,7 @@ public static GenericChart Point<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Point(
Plotly.NET.Chart2D_Scatter.Chart.Point(
x: x,
y: y,
Name: Name.ToOption(),
Expand Down Expand Up @@ -275,7 +275,7 @@ public static GenericChart Line<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Line(
Plotly.NET.Chart2D_Scatter.Chart.Line(
x: x,
y: y,
ShowMarkers: ShowMarkers.ToOption(),
Expand Down Expand Up @@ -384,7 +384,7 @@ public static GenericChart Spline<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Spline(
Plotly.NET.Chart2D_Scatter.Chart.Spline(
x: x,
y: y,
ShowMarkers: ShowMarkers.ToOption(),
Expand Down Expand Up @@ -485,7 +485,7 @@ public static GenericChart Bubble<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Bubble<XType, YType, TextType>(
Plotly.NET.Chart2D_Scatter.Chart.Bubble<XType, YType, TextType>(
x: x,
y: y,
sizes: sizes,
Expand Down Expand Up @@ -604,7 +604,7 @@ public static GenericChart Range<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Range<XType, YType, YType, YType, TextType, TextType, TextType>(
Plotly.NET.Chart2D_Scatter.Chart.Range<XType, YType, YType, YType, TextType, TextType, TextType>(
x: x,
y: y,
upper: upper,
Expand Down Expand Up @@ -658,7 +658,7 @@ public static GenericChart Pareto<TLabel>(
)
where TLabel : IConvertible
=>
Chart2D.Chart.Pareto(
Chart2D_Statistical.Chart.Pareto(
keysValues.Select(t => t.ToTuple())
, Name: Name.ToOption()
, Label: Label.ToOption()
Expand All @@ -679,7 +679,7 @@ IEnumerable<TLabel> labels
)
where TLabel : IConvertible
=>
Chart2D.Chart.Pareto(
Chart2D_Statistical.Chart.Pareto(
labels
, values
, Name: Name.ToOption()
Expand Down Expand Up @@ -758,7 +758,7 @@ public static GenericChart Area<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Area<XType, YType, TextType>(
Plotly.NET.Chart2D_Area.Chart.Area<XType, YType, TextType>(
x: x,
y: y,
ShowMarkers: ShowMarkers.ToOption(),
Expand Down Expand Up @@ -866,7 +866,7 @@ public static GenericChart SplineArea<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.SplineArea<XType, YType, TextType>(
Plotly.NET.Chart2D_Area.Chart.SplineArea<XType, YType, TextType>(
x: x,
y: y,
ShowMarkers: ShowMarkers.ToOption(),
Expand Down Expand Up @@ -967,7 +967,7 @@ public static GenericChart StackedArea<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.StackedArea<XType, YType, TextType>(
Plotly.NET.Chart2D_Area.Chart.StackedArea<XType, YType, TextType>(
x: x,
y: y,
ShowMarkers: ShowMarkers.ToOption(),
Expand Down Expand Up @@ -1062,7 +1062,7 @@ public static GenericChart Funnel<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Funnel<XType, YType, TextType>(
Plotly.NET.Chart2D_Funnel.Chart.Funnel<XType, YType, TextType>(
x: x,
y: y,
Name: Name.ToOption(),
Expand Down Expand Up @@ -1155,7 +1155,7 @@ public static GenericChart StackedFunnel<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.StackedFunnel<XType, YType, TextType>(
Plotly.NET.Chart2D_Funnel.Chart.StackedFunnel<XType, YType, TextType>(
x: x,
y: y,
Name: Name.ToOption(),
Expand Down Expand Up @@ -1245,7 +1245,7 @@ public static GenericChart Waterfall<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Waterfall<XType, YType, TextType>(
Plotly.NET.Chart2D_Funnel.Chart.Waterfall<XType, YType, TextType>(
x: x,
y: y,
Name: Name.ToOption(),
Expand Down Expand Up @@ -1328,7 +1328,7 @@ public static GenericChart Bar<ValuesType, KeysType, TextType>(
where KeysType : IConvertible
where TextType: IConvertible
=>
Plotly.NET.Chart2D.Chart.Bar<ValuesType, KeysType, TextType, ValuesType, ValuesType>(
Plotly.NET.Chart2D_Bar.Chart.Bar<ValuesType, KeysType, TextType, ValuesType, ValuesType>(
values: values,
Keys: Keys.ToOption(),
MultiKeys: MultiKeys.ToOption(),
Expand Down Expand Up @@ -1409,7 +1409,7 @@ public static GenericChart StackedBar<ValuesType, KeysType, TextType>(
where KeysType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.StackedBar<ValuesType, KeysType, TextType, ValuesType, ValuesType>(
Plotly.NET.Chart2D_Bar.Chart.StackedBar<ValuesType, KeysType, TextType, ValuesType, ValuesType>(
values: values,
Keys: Keys.ToOption(),
MultiKeys: MultiKeys.ToOption(),
Expand Down Expand Up @@ -1489,7 +1489,7 @@ public static GenericChart Column<ValuesType, KeysType, TextType>(
where KeysType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Column<ValuesType, KeysType, TextType, ValuesType, ValuesType>(
Plotly.NET.Chart2D_Bar.Chart.Column<ValuesType, KeysType, TextType, ValuesType, ValuesType>(
values: values,
Keys: Keys.ToOption(),
MultiKeys: MultiKeys.ToOption(),
Expand Down Expand Up @@ -1570,7 +1570,7 @@ public static GenericChart StackedColumn<ValuesType, KeysType, TextType>(
where KeysType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.StackedColumn<ValuesType, KeysType, TextType, ValuesType, ValuesType>(
Plotly.NET.Chart2D_Bar.Chart.StackedColumn<ValuesType, KeysType, TextType, ValuesType, ValuesType>(
values: values,
Keys: Keys.ToOption(),
MultiKeys: MultiKeys.ToOption(),
Expand Down Expand Up @@ -1675,7 +1675,7 @@ public static GenericChart Histogram<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Histogram<XType, YType, TextType>(
Plotly.NET.Chart2D_Histogram.Chart.Histogram<XType, YType, TextType>(
X: X.ToOption(),
MultiX: MultiX.ToOption(),
Y: Y.ToOption(),
Expand Down Expand Up @@ -1762,7 +1762,7 @@ public static GenericChart Histogram2D<XType, YType, ZType>(
where YType : IConvertible
where ZType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Histogram2D<XType, YType, IEnumerable<ZType>, ZType>(
Plotly.NET.Chart2D_Histogram.Chart.Histogram2D<XType, YType, IEnumerable<ZType>, ZType>(
x: x,
y: y,
Z: Z.ToOption(),
Expand Down Expand Up @@ -1854,7 +1854,7 @@ public static GenericChart BoxPlot<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.BoxPlot<XType, YType, TextType>(
Plotly.NET.Chart2D_Distribution.Chart.BoxPlot<XType, YType, TextType>(
X: X.ToOption(),
MultiX: MultiX.ToOption(),
Y: Y.ToOption(),
Expand Down Expand Up @@ -1966,7 +1966,7 @@ public static GenericChart Violin<XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Violin<XType, YType, TextType>(
Plotly.NET.Chart2D_Distribution.Chart.Violin<XType, YType, TextType>(
X: X.ToOption(),
MultiX: MultiX.ToOption(),
Y: Y.ToOption(),
Expand Down Expand Up @@ -2090,7 +2090,7 @@ public static GenericChart Histogram2DContour<XType, YType, ZType>(
where YType : IConvertible
where ZType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Histogram2DContour<XType, YType, IEnumerable<ZType>, ZType>(
Plotly.NET.Chart2D_Histogram.Chart.Histogram2DContour<XType, YType, IEnumerable<ZType>, ZType>(
X: X.ToOption(),
MultiX: MultiX.ToOption(),
Y: Y.ToOption(),
Expand Down Expand Up @@ -2185,7 +2185,7 @@ public static GenericChart Heatmap<ZType, XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Heatmap<IEnumerable<ZType>, ZType, XType, YType, TextType>(
Plotly.NET.Chart2D_Heatmap.Chart.Heatmap<IEnumerable<ZType>, ZType, XType, YType, TextType>(
zData: zData,
X: X.ToOption(),
MultiX: MultiX.ToOption(),
Expand Down Expand Up @@ -2267,7 +2267,7 @@ public static GenericChart AnnotatedHeatmap<ZType, XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.AnnotatedHeatmap<IEnumerable<ZType>, ZType, IEnumerable<string>, XType, YType, TextType>(
Plotly.NET.Chart2D_Heatmap.Chart.AnnotatedHeatmap<IEnumerable<ZType>, ZType, IEnumerable<string>, XType, YType, TextType>(
zData: zData,
annotationText: annotationText,
Name: Name.ToOption(),
Expand Down Expand Up @@ -2321,7 +2321,7 @@ public static GenericChart Image<IdType>(
)
where IdType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Image<IEnumerable<IEnumerable<int>>, IEnumerable<int>, IdType>(
Plotly.NET.Chart2D_Heatmap.Chart.Image<IEnumerable<IEnumerable<int>>, IEnumerable<int>, IdType>(
Z: Z.ToOption(),
Source: Source.ToOption(),
Name: Name.ToOption(),
Expand Down Expand Up @@ -2413,7 +2413,7 @@ public static GenericChart Contour<ZType, XType, YType, TextType>(
where YType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Contour<IEnumerable<ZType>, ZType, XType, YType, TextType>(
Plotly.NET.Chart2D_Heatmap.Chart.Contour<IEnumerable<ZType>, ZType, XType, YType, TextType>(
zData: zData,
Name: Name.ToOption(),
ShowLegend: ShowLegend.ToOption(),
Expand Down Expand Up @@ -2498,7 +2498,7 @@ public static GenericChart OHLC<OHLCType, XType, TextType>(
where XType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.OHLC<OHLCType, OHLCType, OHLCType, OHLCType, XType, TextType>(
Plotly.NET.Chart2D_Finance.Chart.OHLC<OHLCType, OHLCType, OHLCType, OHLCType, XType, TextType>(
open: open,
high: high,
low: low,
Expand Down Expand Up @@ -2569,7 +2569,7 @@ public static GenericChart Candlestick<OHLCType, XType, TextType>(
where XType : IConvertible
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Candlestick<OHLCType, OHLCType, OHLCType, OHLCType, XType, TextType>(
Plotly.NET.Chart2D_Finance.Chart.Candlestick<OHLCType, OHLCType, OHLCType, OHLCType, XType, TextType>(
open: open,
high: high,
low: low,
Expand Down Expand Up @@ -2634,7 +2634,7 @@ public static GenericChart Splom<TextType>(
)
where TextType : IConvertible
=>
Plotly.NET.Chart2D.Chart.Splom<TextType>(
Plotly.NET.Chart2D_Splom.Chart.Splom<TextType>(
dimensions: dimensions,
Name: Name.ToOption(),
ShowLegend: ShowLegend.ToOption(),
Expand Down Expand Up @@ -2720,7 +2720,7 @@ public static GenericChart PointDensity<XType, YType>(
where XType : IConvertible
where YType : IConvertible
=>
Plotly.NET.Chart2D.Chart.PointDensity<XType, YType>(
Plotly.NET.Chart2D_Splom.Chart.PointDensity<XType, YType>(
x: x,
y: y,
PointOpacity: PointOpacity.ToOption(),
Expand Down
Loading
Loading