Merge pull request #433 from LayTec-AG/feature/event-for-3d-plots

Use object instead of int for point index (Breaking Change)
LayTec-AG · Jun 17, 2024 · d04403f · d04403f
2 parents ca01195 + a87001b
commit d04403f
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 6 deletions.
diff --git a/Plotly.Blazor.Generator/src/Interop/EventDataPoint.cs b/Plotly.Blazor.Generator/src/Interop/EventDataPoint.cs
@@ -11,9 +11,9 @@ public class EventDataPoint
         public int TraceIndex { get; set; }
 
         /// <summary>
-        ///     The zero based index of the point.
+        ///     The zero based index as an object to be compatible to multiple data types.
         /// </summary>
-        public int PointIndex { get; set; }
+        public object PointIndex { get; set; }
 
         /// <summary>
         ///     The zero-based point number. Can be used to identify the point in combination with CurveNumber.

diff --git a/Plotly.Blazor.Generator/src/Interop/RelayoutEventData.cs b/Plotly.Blazor.Generator/src/Interop/RelayoutEventData.cs
@@ -21,5 +21,13 @@ public class RelayoutEventData
         ///      In some cases this may be not be set.
         /// </remarks>
         public object[] YRange { get; set; }
+
+        /// <summary>
+        ///     The z-axis of the layout. [z0, z1].
+        /// </summary>
+        /// <remarks>
+        ///      In some cases this may be not be set.
+        /// </remarks>
+        public object[] ZRange { get; set; }
     }
 }
diff --git a/Plotly.Blazor/Interop/EventDataPoint.cs b/Plotly.Blazor/Interop/EventDataPoint.cs
@@ -11,9 +11,9 @@ public class EventDataPoint
         public int TraceIndex { get; set; }
 
         /// <summary>
-        ///     The zero based index of the point.
+        ///     The zero based index as an object to be compatible to multiple data types.
         /// </summary>
-        public int PointIndex { get; set; }
+        public object PointIndex { get; set; }
 
         /// <summary>
         ///     The zero-based point number. Can be used to identify the point in combination with CurveNumber.

diff --git a/Plotly.Blazor/Interop/RelayoutEventData.cs b/Plotly.Blazor/Interop/RelayoutEventData.cs
@@ -21,5 +21,13 @@ public class RelayoutEventData
         ///      In some cases this may be not be set.
         /// </remarks>
         public object[] YRange { get; set; }
+
+        /// <summary>
+        ///     The z-axis of the layout. [z0, z1].
+        /// </summary>
+        /// <remarks>
+        ///      In some cases this may be not be set.
+        /// </remarks>
+        public object[] ZRange { get; set; }
     }
-}
+}
diff --git a/Plotly.Blazor/Plotly.Blazor.xml b/Plotly.Blazor/Plotly.Blazor.xml
@@ -805,7 +805,7 @@
         </member>
         <member name="P:Plotly.Blazor.Interop.EventDataPoint.PointIndex">
             <summary>
-                The zero based index of the point.
+                The zero based index as an object to be compatible to multiple data types.
             </summary>
         </member>
         <member name="P:Plotly.Blazor.Interop.EventDataPoint.PointNumber">

diff --git a/Plotly.Blazor/wwwroot/plotly-interop-2.33.0.js b/Plotly.Blazor/wwwroot/plotly-interop-2.33.0.js
@@ -221,6 +221,9 @@ export function subscribeRelayoutEvent(dotNetObj, id) {
         var y1 = data["yaxis.range[0]"]
         var y2 = data["yaxis.range[1]"]
 
+        var z1 = data["zaxis.range[0]"]
+        var z2 = data["zaxis.range[1]"]
+
         var result = {};
 
         if (x1 && x2) {
@@ -230,6 +233,11 @@ export function subscribeRelayoutEvent(dotNetObj, id) {
         if (y1 && y2) {
             result.YRange = [y1, y2];
         }
+
+        if (z1 && z2) {
+            result.ZRange = [z1, z2];
+        }
+
         dotNetObj.invokeMethodAsync('RelayoutEvent', result);
     });
 }