Skip to content

Commit 10ded4e

Browse files
kMutagenekMutagene
committed
Add all params for Histogram traces, improve Chart functions
1 parent e304bc7 commit 10ded4e

File tree

4 files changed

+239
-85
lines changed

4 files changed

+239
-85
lines changed

‎src/Plotly.NET/ChartAPI/Chart2D.fs‎

Lines changed: 113 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1395,43 +1395,128 @@ module Chart2D =
13951395
?Marker = Marker
13961396
)
13971397

1398-
/// Computes a histogram with auto-determined the bin size.
1398+
1399+
/// Visualizes the distribution of the input data as a histogram.
13991400
[<Extension>]
14001401
static member Histogram
1401-
(
1402-
data,
1403-
[<Optional;DefaultParameterValue(null)>] ?Orientation,
1404-
[<Optional;DefaultParameterValue(null)>] ?Name,
1405-
[<Optional;DefaultParameterValue(null)>] ?ShowLegend,
1406-
[<Optional;DefaultParameterValue(null)>] ?Opacity,
1407-
[<Optional;DefaultParameterValue(null)>] ?Color,
1408-
[<Optional;DefaultParameterValue(null)>] ?HistNorm,
1409-
[<Optional;DefaultParameterValue(null)>] ?HistFunc,
1410-
[<Optional;DefaultParameterValue(null)>] ?nBinsx,
1411-
[<Optional;DefaultParameterValue(null)>] ?nBinsy,
1412-
[<Optional;DefaultParameterValue(null)>] ?Xbins,
1413-
[<Optional;DefaultParameterValue(null)>] ?Ybins,
1414-
// TODO
1415-
[<Optional;DefaultParameterValue(null)>] ?xError,
1416-
[<Optional;DefaultParameterValue(null)>] ?yError
1402+
(
1403+
[<Optional;DefaultParameterValue(null)>] ?X : seq<#IConvertible>,
1404+
[<Optional;DefaultParameterValue(null)>] ?Y : seq<#IConvertible>,
1405+
[<Optional;DefaultParameterValue(null)>] ?Orientation : StyleParam.Orientation,
1406+
[<Optional;DefaultParameterValue(null)>] ?Name : string,
1407+
[<Optional;DefaultParameterValue(null)>] ?ShowLegend : bool,
1408+
[<Optional;DefaultParameterValue(null)>] ?Opacity : float,
1409+
[<Optional;DefaultParameterValue(null)>] ?Text : #IConvertible,
1410+
[<Optional;DefaultParameterValue(null)>] ?MultiText : seq<#IConvertible>,
1411+
[<Optional;DefaultParameterValue(null)>] ?HistFunc : StyleParam.HistFunc,
1412+
[<Optional;DefaultParameterValue(null)>] ?HistNorm : StyleParam.HistNorm,
1413+
[<Optional;DefaultParameterValue(null)>] ?AlignmentGroup : string,
1414+
[<Optional;DefaultParameterValue(null)>] ?OffsetGroup : string,
1415+
[<Optional;DefaultParameterValue(null)>] ?NBinsX : int,
1416+
[<Optional;DefaultParameterValue(null)>] ?NBinsY : int,
1417+
[<Optional;DefaultParameterValue(null)>] ?BinGroup : string,
1418+
[<Optional;DefaultParameterValue(null)>] ?XBins : Bins,
1419+
[<Optional;DefaultParameterValue(null)>] ?YBins : Bins,
1420+
[<Optional;DefaultParameterValue(null)>] ?MarkerColor : Color,
1421+
[<Optional;DefaultParameterValue(null)>] ?Marker : Marker,
1422+
[<Optional;DefaultParameterValue(null)>] ?Line : Line,
1423+
[<Optional;DefaultParameterValue(null)>] ?ErrorX : Error,
1424+
[<Optional;DefaultParameterValue(null)>] ?ErrorY : Error,
1425+
[<Optional;DefaultParameterValue(null)>] ?Cumulative : Cumulative,
1426+
[<Optional;DefaultParameterValue(null)>] ?HoverLabel : Hoverlabel
14171427
) =
1418-
14191428
Trace2D.initHistogram (
14201429
Trace2DStyle.Histogram (
1421-
X=data,
1422-
?Orientation=Orientation,
1423-
?HistNorm=HistNorm,
1424-
?HistFunc=HistFunc,
1425-
?nBinsx=nBinsx,
1426-
?nBinsy=nBinsy,
1427-
?xBins=Xbins,
1428-
?yBins=Ybins
1430+
?X = X,
1431+
?Y = Y,
1432+
?Text = Text ,
1433+
?MultiText = MultiText ,
1434+
?Orientation = Orientation ,
1435+
?HistFunc = HistFunc ,
1436+
?HistNorm = HistNorm ,
1437+
?AlignmentGroup = AlignmentGroup ,
1438+
?OffsetGroup = OffsetGroup ,
1439+
?NBinsX = NBinsX ,
1440+
?NBinsY = NBinsY ,
1441+
?BinGroup = BinGroup ,
1442+
?XBins = XBins ,
1443+
?YBins = YBins ,
1444+
?Marker = Marker ,
1445+
?Line = Line ,
1446+
?ErrorX = ErrorX ,
1447+
?ErrorY = ErrorY ,
1448+
?Cumulative = Cumulative ,
1449+
?HoverLabel = HoverLabel
14291450
)
14301451
)
1431-
|> TraceStyle.Marker(?Color=Color)
1452+
|> TraceStyle.Marker(?Color=MarkerColor)
14321453
|> TraceStyle.TraceInfo(?Name=Name,?ShowLegend=ShowLegend,?Opacity=Opacity)
1433-
14341454
|> GenericChart.ofTraceObject
1455+
1456+
/// Visualizes the distribution of the input data as a histogram, automatically determining if the data is to be used for the x or y dimension based on the `orientation` parameter.
1457+
[<Extension>]
1458+
static member Histogram
1459+
(
1460+
data: seq<#IConvertible>,
1461+
orientation : StyleParam.Orientation,
1462+
[<Optional;DefaultParameterValue(null)>] ?Name : string,
1463+
[<Optional;DefaultParameterValue(null)>] ?ShowLegend : bool,
1464+
[<Optional;DefaultParameterValue(null)>] ?Opacity : float,
1465+
[<Optional;DefaultParameterValue(null)>] ?Text : #IConvertible,
1466+
[<Optional;DefaultParameterValue(null)>] ?MultiText : seq<#IConvertible>,
1467+
[<Optional;DefaultParameterValue(null)>] ?HistFunc : StyleParam.HistFunc,
1468+
[<Optional;DefaultParameterValue(null)>] ?HistNorm : StyleParam.HistNorm,
1469+
[<Optional;DefaultParameterValue(null)>] ?AlignmentGroup : string,
1470+
[<Optional;DefaultParameterValue(null)>] ?OffsetGroup : string,
1471+
[<Optional;DefaultParameterValue(null)>] ?NBinsX : int,
1472+
[<Optional;DefaultParameterValue(null)>] ?NBinsY : int,
1473+
[<Optional;DefaultParameterValue(null)>] ?BinGroup : string,
1474+
[<Optional;DefaultParameterValue(null)>] ?XBins : Bins,
1475+
[<Optional;DefaultParameterValue(null)>] ?YBins : Bins,
1476+
[<Optional;DefaultParameterValue(null)>] ?MarkerColor : Color,
1477+
[<Optional;DefaultParameterValue(null)>] ?Marker : Marker,
1478+
[<Optional;DefaultParameterValue(null)>] ?Line : Line,
1479+
[<Optional;DefaultParameterValue(null)>] ?ErrorX : Error,
1480+
[<Optional;DefaultParameterValue(null)>] ?ErrorY : Error,
1481+
[<Optional;DefaultParameterValue(null)>] ?Cumulative : Cumulative,
1482+
[<Optional;DefaultParameterValue(null)>] ?HoverLabel : Hoverlabel
1483+
) =
1484+
1485+
let histChart =
1486+
Trace2D.initHistogram (
1487+
Trace2DStyle.Histogram (
1488+
?Text = Text ,
1489+
?MultiText = MultiText ,
1490+
Orientation = orientation ,
1491+
?HistFunc = HistFunc ,
1492+
?HistNorm = HistNorm ,
1493+
?AlignmentGroup = AlignmentGroup ,
1494+
?OffsetGroup = OffsetGroup ,
1495+
?NBinsX = NBinsX ,
1496+
?NBinsY = NBinsY ,
1497+
?BinGroup = BinGroup ,
1498+
?XBins = XBins ,
1499+
?YBins = YBins ,
1500+
?Marker = Marker ,
1501+
?Line = Line ,
1502+
?ErrorX = ErrorX ,
1503+
?ErrorY = ErrorY ,
1504+
?Cumulative = Cumulative ,
1505+
?HoverLabel = HoverLabel
1506+
)
1507+
)
1508+
|> TraceStyle.Marker(?Color=MarkerColor)
1509+
|> TraceStyle.TraceInfo(?Name=Name,?ShowLegend=ShowLegend,?Opacity=Opacity)
1510+
|> GenericChart.ofTraceObject
1511+
1512+
match orientation with
1513+
| StyleParam.Orientation.Horizontal ->
1514+
histChart
1515+
|> GenericChart.mapTrace (Trace2DStyle.Histogram(Y=data))
1516+
| StyleParam.Orientation.Vertical ->
1517+
histChart
1518+
|> GenericChart.mapTrace (Trace2DStyle.Histogram(X=data))
1519+
14351520

14361521
/// Computes the bi-dimensional histogram of two data samples and auto-determines the bin size.
14371522
[<Extension>]

‎src/Plotly.NET/Playground.fsx‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,31 @@ open FSharpAux
160160

161161
open System
162162
open System.IO
163-
163+
[
164+
Chart.Histogram(
165+
[for i in 0 .. 10000 do yield System.Random().NextDouble() * 10.],
166+
StyleParam.Orientation.Vertical,
167+
HistFunc = StyleParam.HistFunc.Avg,
168+
HistNorm = StyleParam.HistNorm.ProbabilityDensity,
169+
BinGroup = "myHist",
170+
Opacity = 0.6
171+
)
172+
Chart.Histogram(
173+
[for i in 0 .. 1000 do yield System.Random().NextDouble() * 10.],
174+
StyleParam.Orientation.Vertical,
175+
HistFunc = StyleParam.HistFunc.Avg,
176+
HistNorm = StyleParam.HistNorm.ProbabilityDensity,
177+
BinGroup = "myHist",
178+
Opacity = 0.6
179+
)
180+
]
181+
|> Chart.combine
182+
|> Chart.withLayout(
183+
Layout.init(
184+
BarMode = StyleParam.BarMode.Overlay
185+
)
186+
)
187+
|> Chart.show
164188

165189
let violin1Chart =
166190
let y = [2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1.]

‎src/Plotly.NET/Traces/ObjectAbstractions/Bins.fs‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,31 +13,31 @@ type Bins () =
1313
// Init Bins()
1414
static member init
1515
(
16-
[<Optional;DefaultParameterValue(null)>] ?StartBins: float,
17-
[<Optional;DefaultParameterValue(null)>] ?EndBins: float,
16+
[<Optional;DefaultParameterValue(null)>] ?Start: float,
17+
[<Optional;DefaultParameterValue(null)>] ?End: float,
1818
[<Optional;DefaultParameterValue(null)>] ?Size: float
1919
) =
2020
Bins ()
2121
|> Bins.style
2222
(
23-
?StartBins = StartBins,
24-
?EndBins = EndBins ,
25-
?Size = Size
23+
?Start = Start,
24+
?End = End ,
25+
?Size = Size
2626
)
2727

2828

2929
// Applies the styles to Bins()
3030
static member style
3131
(
32-
[<Optional;DefaultParameterValue(null)>] ?StartBins: float,
33-
[<Optional;DefaultParameterValue(null)>] ?EndBins: float,
32+
[<Optional;DefaultParameterValue(null)>] ?Start: float,
33+
[<Optional;DefaultParameterValue(null)>] ?End: float,
3434
[<Optional;DefaultParameterValue(null)>] ?Size: float
3535
) =
3636

3737
(fun (bins:Bins) ->
38-
StartBins |> DynObj.setValueOpt bins "start"
39-
EndBins |> DynObj.setValueOpt bins "end"
40-
Size |> DynObj.setValueOpt bins "size"
38+
Start |> DynObj.setValueOpt bins "start"
39+
End |> DynObj.setValueOpt bins "end"
40+
Size |> DynObj.setValueOpt bins "size"
4141

4242
bins
4343
)

0 commit comments

Comments
 (0)