Skip to content

Commit 9590940

Browse files
kMutagenekMutagene
committed
Rename and refactor Selection object to TraceSelection object, as Selection is actually a layout layer.
1 parent a6b99af commit 9590940

File tree

12 files changed

+104
-141
lines changed

12 files changed

+104
-141
lines changed

‎src/Plotly.NET/Plotly.NET.fsproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
<Compile Include="Traces\ObjectAbstractions\Caps.fs" />
9999
<Compile Include="Traces\ObjectAbstractions\StreamTubeStarts.fs" />
100100
<Compile Include="Traces\ObjectAbstractions\Lighting.fs" />
101-
<Compile Include="Traces\ObjectAbstractions\Selection.fs" />
101+
<Compile Include="Traces\ObjectAbstractions\TraceSelection.fs" />
102102
<Compile Include="Traces\ObjectAbstractions\StockData.fs" />
103103
<Compile Include="Traces\ObjectAbstractions\Pathbar.fs" />
104104
<Compile Include="Traces\ObjectAbstractions\Treemap.fs" />

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

-67
This file was deleted.

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

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
namespace Plotly.NET.TraceObjects
2+
3+
open Plotly.NET
4+
open Plotly.NET.LayoutObjects
5+
open DynamicObj
6+
open System
7+
open System.Runtime.InteropServices
8+
9+
/// <summary>
10+
/// Used to control selected/unselected trace item styles in supported traces.
11+
/// </summary>
12+
type TraceSelection() =
13+
inherit DynamicObj()
14+
15+
/// <summary>
16+
/// Returns a new TraceSelection object with the given styles
17+
/// </summary>
18+
/// <param name="MarkerOpacity">Sets the opacity of the selected/unselected trace items</param>
19+
/// <param name="MarkerColor">Sets the color of the selected/unselected trace items</param>
20+
/// <param name="MarkerSize">Sets the size of the selected/unselected trace items</param>
21+
/// <param name="FontColor">Sets the opfont of the selected/unselected trace items</param>
22+
static member init
23+
(
24+
[<Optional; DefaultParameterValue(null)>] ?MarkerOpacity: float,
25+
[<Optional; DefaultParameterValue(null)>] ?MarkerColor: Color,
26+
[<Optional; DefaultParameterValue(null)>] ?MarkerSize: int,
27+
[<Optional; DefaultParameterValue(null)>] ?FontColor: Color
28+
) =
29+
TraceSelection()
30+
|> TraceSelection.style(
31+
?MarkerOpacity = MarkerOpacity,
32+
?MarkerColor = MarkerColor,
33+
?MarkerSize = MarkerSize,
34+
?FontColor = FontColor
35+
)
36+
37+
/// <summary>
38+
/// Returns a function that applies the given styles to a TraceSelection object
39+
/// </summary>
40+
/// <param name="MarkerOpacity">Sets the opacity of the selected/unselected trace items</param>
41+
/// <param name="MarkerColor">Sets the color of the selected/unselected trace items</param>
42+
/// <param name="MarkerSize">Sets the size of the selected/unselected trace items</param>
43+
/// <param name="FontColor">Sets the opfont of the selected/unselected trace items</param>
44+
static member style
45+
(
46+
[<Optional; DefaultParameterValue(null)>] ?MarkerOpacity: float,
47+
[<Optional; DefaultParameterValue(null)>] ?MarkerColor: Color,
48+
[<Optional; DefaultParameterValue(null)>] ?MarkerSize: int,
49+
[<Optional; DefaultParameterValue(null)>] ?FontColor: Color
50+
) =
51+
(fun (traceSelection: TraceSelection) ->
52+
53+
let markerSelectionStyle =
54+
Marker.init(
55+
?Opacity = MarkerOpacity,
56+
?Color = MarkerColor,
57+
?Size = MarkerSize
58+
)
59+
60+
let fontSelectionStyle = Font.init(?Color = FontColor)
61+
62+
markerSelectionStyle |> DynObj.setValue traceSelection "marker"
63+
fontSelectionStyle |> DynObj.setValue traceSelection "textfont"
64+
65+
traceSelection)

‎src/Plotly.NET/Traces/Trace.fs

+2-2
Original file line numberDiff line numberDiff line change
@@ -656,8 +656,8 @@ type TraceStyle() =
656656
static member Selection
657657
(
658658
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
659-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
660-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection
659+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
660+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection
661661
) =
662662
(fun (trace: ('T :> Trace)) ->
663663

‎src/Plotly.NET/Traces/Trace2D.fs

+12-12
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,8 @@ type Trace2DStyle() =
222222
[<Optional; DefaultParameterValue(null)>] ?XError: Error,
223223
[<Optional; DefaultParameterValue(null)>] ?YError: Error,
224224
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
225-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
226-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
225+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
226+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
227227
[<Optional; DefaultParameterValue(null)>] ?ClipOnAxis: bool,
228228
[<Optional; DefaultParameterValue(null)>] ?ConnectGaps: bool,
229229
[<Optional; DefaultParameterValue(null)>] ?Fill: StyleParam.Fill,
@@ -417,8 +417,8 @@ type Trace2DStyle() =
417417
[<Optional; DefaultParameterValue(null)>] ?XError: Error,
418418
[<Optional; DefaultParameterValue(null)>] ?YError: Error,
419419
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
420-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
421-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
420+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
421+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
422422
[<Optional; DefaultParameterValue(null)>] ?ClipOnAxis: bool,
423423
[<Optional; DefaultParameterValue(null)>] ?Constraintext: StyleParam.ConstrainText,
424424
[<Optional; DefaultParameterValue(null)>] ?HoverLabel: Hoverlabel,
@@ -968,8 +968,8 @@ type Trace2DStyle() =
968968
[<Optional; DefaultParameterValue(null)>] ?XError: Error,
969969
[<Optional; DefaultParameterValue(null)>] ?YError: Error,
970970
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
971-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
972-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
971+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
972+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
973973
[<Optional; DefaultParameterValue(null)>] ?ClipOnAxis: bool,
974974
[<Optional; DefaultParameterValue(null)>] ?Constraintext: StyleParam.ConstrainText,
975975
[<Optional; DefaultParameterValue(null)>] ?Cumulative: Cumulative,
@@ -1162,8 +1162,8 @@ type Trace2DStyle() =
11621162
[<Optional; DefaultParameterValue(null)>] ?SD: seq<IConvertible>,
11631163
[<Optional; DefaultParameterValue(null)>] ?QuartileMethod: StyleParam.QuartileMethod,
11641164
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
1165-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
1166-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
1165+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
1166+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
11671167
[<Optional; DefaultParameterValue(null)>] ?FillColor: Color,
11681168
[<Optional; DefaultParameterValue(null)>] ?HoverLabel: Hoverlabel,
11691169
[<Optional; DefaultParameterValue(null)>] ?HoverOn: StyleParam.HoverOn,
@@ -1332,8 +1332,8 @@ type Trace2DStyle() =
13321332
[<Optional; DefaultParameterValue(null)>] ?Line: Line,
13331333
[<Optional; DefaultParameterValue(null)>] ?Box: Box,
13341334
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
1335-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
1336-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
1335+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
1336+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
13371337
[<Optional; DefaultParameterValue(null)>] ?BandWidth: float,
13381338
[<Optional; DefaultParameterValue(null)>] ?FillColor: Color,
13391339
[<Optional; DefaultParameterValue(null)>] ?HoverLabel: Hoverlabel,
@@ -2528,8 +2528,8 @@ type Trace2DStyle() =
25282528
[<Optional; DefaultParameterValue(null)>] ?ShowLowerHalf: bool,
25292529
[<Optional; DefaultParameterValue(null)>] ?ShowUpperHalf: bool,
25302530
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
2531-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
2532-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
2531+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
2532+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
25332533
[<Optional; DefaultParameterValue(null)>] ?HoverLabel: Hoverlabel,
25342534
[<Optional; DefaultParameterValue(null)>] ?UIRevision: string
25352535
) =

‎src/Plotly.NET/Traces/TraceCarpet.fs

+2-2
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ type TraceCarpetStyle() =
214214
[<Optional; DefaultParameterValue(null)>] ?Line: Line,
215215
[<Optional; DefaultParameterValue(null)>] ?TextFont: Font,
216216
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
217-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
218-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
217+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
218+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
219219
[<Optional; DefaultParameterValue(null)>] ?Carpet: StyleParam.SubPlotId,
220220
[<Optional; DefaultParameterValue(null)>] ?ConnectGaps: bool,
221221
[<Optional; DefaultParameterValue(null)>] ?Fill: StyleParam.Fill,

‎src/Plotly.NET/Traces/TraceGeo.fs

+4-4
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ type TraceGeoStyle() =
121121
[<Optional; DefaultParameterValue(null)>] ?Zmid: float,
122122
[<Optional; DefaultParameterValue(null)>] ?Zmax: float,
123123
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
124-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
125-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
124+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
125+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
126126
[<Optional; DefaultParameterValue(null)>] ?HoverLabel: Hoverlabel,
127127
[<Optional; DefaultParameterValue(null)>] ?LocationMode: StyleParam.LocationFormat,
128128
[<Optional; DefaultParameterValue(null)>] ?UIRevision: string
@@ -244,8 +244,8 @@ type TraceGeoStyle() =
244244
[<Optional; DefaultParameterValue(null)>] ?Line: Line,
245245
[<Optional; DefaultParameterValue(null)>] ?TextFont: Font,
246246
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
247-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
248-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
247+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
248+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
249249
[<Optional; DefaultParameterValue(null)>] ?ConnectGaps: bool,
250250
[<Optional; DefaultParameterValue(null)>] ?Fill: StyleParam.Fill,
251251
[<Optional; DefaultParameterValue(null)>] ?FillColor: Color,

‎src/Plotly.NET/Traces/TraceMapbox.fs

+4-4
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ type TraceMapboxStyle() =
122122
[<Optional; DefaultParameterValue(null)>] ?Line: Line,
123123
[<Optional; DefaultParameterValue(null)>] ?TextFont: Font,
124124
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
125-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
126-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
125+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
126+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
127127
[<Optional; DefaultParameterValue(null)>] ?Below: string,
128128
[<Optional; DefaultParameterValue(null)>] ?ConnectGaps: bool,
129129
[<Optional; DefaultParameterValue(null)>] ?Fill: StyleParam.Fill,
@@ -247,8 +247,8 @@ type TraceMapboxStyle() =
247247
[<Optional; DefaultParameterValue(null)>] ?Zmid: float,
248248
[<Optional; DefaultParameterValue(null)>] ?Zmin: float,
249249
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
250-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
251-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
250+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
251+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
252252
[<Optional; DefaultParameterValue(null)>] ?Below: string,
253253
[<Optional; DefaultParameterValue(null)>] ?HoverLabel: Hoverlabel,
254254
[<Optional; DefaultParameterValue(null)>] ?UIRevision: string

‎src/Plotly.NET/Traces/TracePolar.fs

+4-4
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ type TracePolarStyle() =
122122
[<Optional; DefaultParameterValue(null)>] ?Line: Line,
123123
[<Optional; DefaultParameterValue(null)>] ?TextFont: Font,
124124
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
125-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
126-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
125+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
126+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
127127
[<Optional; DefaultParameterValue(null)>] ?ClipOnAxis: bool,
128128
[<Optional; DefaultParameterValue(null)>] ?ConnectGaps: bool,
129129
[<Optional; DefaultParameterValue(null)>] ?Fill: StyleParam.Fill,
@@ -251,8 +251,8 @@ type TracePolarStyle() =
251251
[<Optional; DefaultParameterValue(null)>] ?Subplot: StyleParam.SubPlotId,
252252
[<Optional; DefaultParameterValue(null)>] ?Marker: Marker,
253253
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
254-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
255-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
254+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
255+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
256256
[<Optional; DefaultParameterValue(null)>] ?HoverLabel: Hoverlabel,
257257
[<Optional; DefaultParameterValue(null)>] ?UIRevision: seq<#IConvertible>
258258
) =

‎src/Plotly.NET/Traces/TraceSmith.fs

+2-2
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ type TraceSmithStyle() =
9595
[<Optional; DefaultParameterValue(null)>] ?Line: Line,
9696
[<Optional; DefaultParameterValue(null)>] ?TextFont: Font,
9797
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
98-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
99-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
98+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
99+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
100100
[<Optional; DefaultParameterValue(null)>] ?ClipOnAxis: bool,
101101
[<Optional; DefaultParameterValue(null)>] ?ConnectGaps: bool,
102102
[<Optional; DefaultParameterValue(null)>] ?Fill: StyleParam.Fill,

‎src/Plotly.NET/Traces/TraceTernary.fs

+2-2
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ type TraceTernaryStyle() =
9898
[<Optional; DefaultParameterValue(null)>] ?Line: Line,
9999
[<Optional; DefaultParameterValue(null)>] ?TextFont: Font,
100100
[<Optional; DefaultParameterValue(null)>] ?SelectedPoints: seq<#IConvertible>,
101-
[<Optional; DefaultParameterValue(null)>] ?Selected: Selection,
102-
[<Optional; DefaultParameterValue(null)>] ?Unselected: Selection,
101+
[<Optional; DefaultParameterValue(null)>] ?Selected: TraceSelection,
102+
[<Optional; DefaultParameterValue(null)>] ?Unselected: TraceSelection,
103103
[<Optional; DefaultParameterValue(null)>] ?ClipOnAxis: bool,
104104
[<Optional; DefaultParameterValue(null)>] ?ConnectGaps: bool,
105105
[<Optional; DefaultParameterValue(null)>] ?Fill: StyleParam.Fill,

0 commit comments

Comments
 (0)