bingroup

mahdis-z · mahdis-z · commit f39d0caf978d · 2019-12-03T12:33:56.000-05:00
diff --git a/doc/python/2D-Histogram.md b/doc/python/2D-Histogram.md
@@ -70,6 +70,33 @@ fig = go.Figure(go.Histogram2d(x=x, y=y, histnorm='probability',
     ))
 fig.show()
 ```
+### Sharing bin settings between 2D Histograms
+This example shows how to use [bingroup](https://plot.ly/python/reference/#histogram-bingroup) attribute to have a compatible bin settings for both histograms. To define `start`, `end` and `size` value of x-axis and y-axis seperatly, set [ybins](https://plot.ly/python/reference/#histogram2dcontour-ybins) and `xbins`.
+
+```python
+import plotly.graph_objects as go
+from plotly.subplots import make_subplots
+fig = make_subplots(2,2)
+fig.add_trace(go.Histogram2d(
+    x = [ 1, 2, 2, 3, 4 ],
+    y = [ 1, 2, 2, 3, 4 ],
+    xbins = {'start':1, 'size':1}), 1,1)
+fig.add_trace(go.Histogram2d(
+    x = [ 4, 5, 5, 5, 6 ],
+    y = [ 4, 5, 5, 5, 6 ],
+    ybins = {'start': 3, 'size': 1}),1,2)
+fig.add_trace(go.Histogram2d(
+    x = [ 1, 2, 2, 3, 4 ],
+    y = [ 1, 2, 2, 3, 4 ],
+    bingroup = 1,
+    xbins = {'start':1, 'size':1}), 2,1)
+fig.add_trace(go.Histogram2d(
+    x = [ 4, 5, 5, 5, 6 ],
+    y = [ 4, 5, 5, 5, 6 ],
+    bingroup = 1,
+    ybins = {'start': 3, 'size': 1}),2,2)
+fig.show()
+```
 
 ### 2D Histogram Overlaid with a Scatter Chart ###
 
diff --git a/doc/python/histograms.md b/doc/python/histograms.md
@@ -350,6 +350,28 @@ fig1.show()
 fig2.show()
 ```
 
+### Share bins between histograms
+In this example both histograms have a compatible bin settings using [bingroup](https://plot.ly/python/reference/#histogram-bingroup) attribute. Note that traces on the same subplot, and with the same `barmode` ("stack", "relative", "group") are forced into the same `bingroup`, however traces with `barmode = "overlay"` and on different axes (of the same axis type) can have compatible bin settings. Histogram and [histogram2d](https://plot.ly/python/2D-Histogram/) trace can share the same `bingroup`.
+
+```python
+import plotly.graph_objects as go
+import numpy as np
+
+fig = go.Figure(go.Histogram(
+    x=np.random.randint(7, size=100),
+    bingroup=1))
+
+fig.add_trace(go.Histogram(
+    x=np.random.randint(7, size=20),
+    bingroup=1))
+
+fig.update_layout(
+    barmode="overlay",
+    bargap=0.1)
+
+fig.show()
+```
+
 ### Dash Example
 
 
