Updates to matplotlib element references to use opts #3270

philippjfr · 2018-12-10T21:18:08Z

No description provided.

examples/reference/elements/matplotlib/Bars.ipynb

examples/reference/elements/matplotlib/Bounds.ipynb

examples/reference/elements/matplotlib/HLine.ipynb

examples/reference/elements/matplotlib/Image.ipynb

examples/reference/elements/matplotlib/QuadMesh.ipynb

examples/reference/elements/matplotlib/Spikes.ipynb

examples/reference/elements/matplotlib/Spline.ipynb

examples/reference/elements/matplotlib/Text.ipynb

examples/reference/elements/matplotlib/VLine.ipynb

examples/reference/elements/matplotlib/Arrow.ipynb

examples/reference/elements/matplotlib/HexTiles.ipynb

jlstevens · 2018-12-10T22:35:00Z

I've gone through the suggestions above and I think my own preference is fairly clear and consistent: if you have a composition and don't need to distinguish identical element types, put .opts at the end and use the opts utility.

I think this has the advantages of:

Consistency
Separating content and presentation (all options at the end)
Allowing people to try out tab-completion in these element reference notebooks.

One thing I would say is maybe opts.defaults is more appropriate for some of these. For instance:

curve = hv.Curve((xs,ys))
arrow = hv.Arrow(0, 5, 'Inflection', 'v')
(curve * arrow).opts(
   opts.Curve(color='#D3D3D3'))

This is in the Arrows notebook but we are customizing Curve? If would be better to show opts.Arrow for something and given we are just changing the color of the curve (for no particularly important reason), I would also consider using opts.defaults(opts.Curve(color='#D3D3D3')) at the top of the notebook instead.

jbednar · 2018-12-10T22:40:12Z

opts.defaults does seem more appropriate in some cases here, yes.

jlstevens · 2018-12-11T01:05:07Z

examples/reference/elements/matplotlib/QuadMesh.ipynb

-    "%%opts QuadMesh [xticks=[10, 100,1000]] QuadMesh.LogScale [logx=True]\n",
-    "hv.QuadMesh((xs, ys, zs), group='LinearScale') + hv.QuadMesh((xs, ys, zs), group='LogScale')"
+    "qmesh = hv.QuadMesh((xs, ys, zs), label='Linear Axis')\n",
+    "log_qmesh = qmesh.relabel('Log x-axis')\n",


Could use title_format here too...

jlstevens · 2018-12-11T01:07:35Z

examples/reference/elements/matplotlib/VectorField.ipynb

+    "hmap = hv.HoloMap({phase: hv.VectorField((x, y,(vector_data[2]+phase)%np.pi*2, vector_data[3]+np.abs(phase)))\n",
+    "                   for phase in np.linspace(-np.pi,np.pi,5)}, kdims='Phase')\n",
+    "\n",
+    "hmap.opts(opts.VectorField(color='Angle', magnitude=dim('Magnitude').norm()*0.2, rescale_lengths=False))"


I would format this consistently i.e start opts.VectorField indented on the next line.

jlstevens · 2018-12-11T01:14:21Z

Thanks for updating these! I think we are converging on a common style now.

Merging.

github-actions · 2024-10-24T21:25:05Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Updates to matplotlib element references to use opts

e9f1a04

philippjfr added the type: docs Related to the documentation and examples label Dec 10, 2018