.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/01-basic-plotly-examples/name-filter.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_01-basic-plotly-examples_name-filter.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_01-basic-plotly-examples_name-filter.py:


.. _ref_name_filter_plotly:

====================================
Name filtering in the Plotly backend
====================================

The ``name_filter`` parameter accepts a regular-expression string and is
available on :meth:`Plotter.plot`, :meth:`Plotter.plot_iter`, and
:meth:`Plotter.show`. Only :class:`MeshObjectPlot` objects whose ``name``
matches the pattern are added to the figure; everything else is silently
skipped.

.. GENERATED FROM PYTHON SOURCE LINES 35-50

.. code-block:: Python


    import pyvista as pv

    from ansys.tools.visualization_interface import Plotter
    from ansys.tools.visualization_interface.backends.plotly.plotly_interface import PlotlyBackend
    from ansys.tools.visualization_interface.types.mesh_object_plot import MeshObjectPlot


    class Part:
        """Minimal domain object with a name."""

        def __init__(self, name: str):
            self.name = name









.. GENERATED FROM PYTHON SOURCE LINES 51-53

Build a set of named parts
==========================

.. GENERATED FROM PYTHON SOURCE LINES 53-62

.. code-block:: Python


    parts = [
        MeshObjectPlot(Part("Wheel_FL"), pv.Sphere(center=(-1,  1, 0), radius=0.3)),
        MeshObjectPlot(Part("Wheel_FR"), pv.Sphere(center=( 1,  1, 0), radius=0.3)),
        MeshObjectPlot(Part("Wheel_RL"), pv.Sphere(center=(-1, -1, 0), radius=0.3)),
        MeshObjectPlot(Part("Wheel_RR"), pv.Sphere(center=( 1, -1, 0), radius=0.3)),
        MeshObjectPlot(Part("Chassis"),  pv.Box(bounds=(-0.8, 0.8, -1.2, 1.2, 0, 0.4))),
    ]








.. GENERATED FROM PYTHON SOURCE LINES 63-68

Show with ``name_filter`` via ``show()``
========================================
Pass ``name_filter`` directly to :meth:`Plotter.show` together with the
list of objects.  The filter is applied while plotting, so only matching
parts are added to the figure.

.. GENERATED FROM PYTHON SOURCE LINES 68-73

.. code-block:: Python


    pl = Plotter(backend=PlotlyBackend())
    pl.show(plottable_object=parts)

    pl = Plotter(backend=PlotlyBackend())
    pl.show(plottable_object=parts, name_filter="Wheel")




.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>            <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_SVG"></script><script>if (window.MathJax && window.MathJax.Hub && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: "STIX-Web"}});}</script>                <script>window.PlotlyConfig = {MathJaxConfig: 'local'};</script>
            <script charset="utf-8" src="https://cdn.plot.ly/plotly-3.4.0.min.js" integrity="sha256-KEmPoupLpFyGMyGAiOsiNDbKDKAvxXAn/W+oQa0ZAfk=" crossorigin="anonymous"></script>                <div id="f3144ba9-7545-4481-b5ca-652ff2c0142c" class="plotly-graph-div" style="height:525px; width:100%;"></div>            <script>                window.PLOTLYENV=window.PLOTLYENV || {};                                if (document.getElementById("f3144ba9-7545-4481-b5ca-652ff2c0142c")) {                    Plotly.newPlot(                        "f3144ba9-7545-4481-b5ca-652ff2c0142c",                        [],                        {"template":{"data":{"histogram2dcontour":[{"type":"histogram2dcontour","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"choropleth":[{"type":"choropleth","colorbar":{"outlinewidth":0,"ticks":""}}],"histogram2d":[{"type":"histogram2d","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"heatmap":[{"type":"heatmap","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"contourcarpet":[{"type":"contourcarpet","colorbar":{"outlinewidth":0,"ticks":""}}],"contour":[{"type":"contour","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"surface":[{"type":"surface","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"mesh3d":[{"type":"mesh3d","colorbar":{"outlinewidth":0,"ticks":""}}],"scatter":[{"fillpattern":{"fillmode":"overlay","size":10,"solidity":0.2},"type":"scatter"}],"parcoords":[{"type":"parcoords","line":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatterpolargl":[{"type":"scatterpolargl","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"bar":[{"error_x":{"color":"#2a3f5f"},"error_y":{"color":"#2a3f5f"},"marker":{"line":{"color":"#E5ECF6","width":0.5},"pattern":{"fillmode":"overlay","size":10,"solidity":0.2}},"type":"bar"}],"scattergeo":[{"type":"scattergeo","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatterpolar":[{"type":"scatterpolar","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"histogram":[{"marker":{"pattern":{"fillmode":"overlay","size":10,"solidity":0.2}},"type":"histogram"}],"scattergl":[{"type":"scattergl","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatter3d":[{"type":"scatter3d","line":{"colorbar":{"outlinewidth":0,"ticks":""}},"marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scattermap":[{"type":"scattermap","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scattermapbox":[{"type":"scattermapbox","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatterternary":[{"type":"scatterternary","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scattercarpet":[{"type":"scattercarpet","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"carpet":[{"aaxis":{"endlinecolor":"#2a3f5f","gridcolor":"white","linecolor":"white","minorgridcolor":"white","startlinecolor":"#2a3f5f"},"baxis":{"endlinecolor":"#2a3f5f","gridcolor":"white","linecolor":"white","minorgridcolor":"white","startlinecolor":"#2a3f5f"},"type":"carpet"}],"table":[{"cells":{"fill":{"color":"#EBF0F8"},"line":{"color":"white"}},"header":{"fill":{"color":"#C8D4E3"},"line":{"color":"white"}},"type":"table"}],"barpolar":[{"marker":{"line":{"color":"#E5ECF6","width":0.5},"pattern":{"fillmode":"overlay","size":10,"solidity":0.2}},"type":"barpolar"}],"pie":[{"automargin":true,"type":"pie"}]},"layout":{"autotypenumbers":"strict","colorway":["#636efa","#EF553B","#00cc96","#ab63fa","#FFA15A","#19d3f3","#FF6692","#B6E880","#FF97FF","#FECB52"],"font":{"color":"#2a3f5f"},"hovermode":"closest","hoverlabel":{"align":"left"},"paper_bgcolor":"white","plot_bgcolor":"#E5ECF6","polar":{"bgcolor":"#E5ECF6","angularaxis":{"gridcolor":"white","linecolor":"white","ticks":""},"radialaxis":{"gridcolor":"white","linecolor":"white","ticks":""}},"ternary":{"bgcolor":"#E5ECF6","aaxis":{"gridcolor":"white","linecolor":"white","ticks":""},"baxis":{"gridcolor":"white","linecolor":"white","ticks":""},"caxis":{"gridcolor":"white","linecolor":"white","ticks":""}},"coloraxis":{"colorbar":{"outlinewidth":0,"ticks":""}},"colorscale":{"sequential":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]],"sequentialminus":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]],"diverging":[[0,"#8e0152"],[0.1,"#c51b7d"],[0.2,"#de77ae"],[0.3,"#f1b6da"],[0.4,"#fde0ef"],[0.5,"#f7f7f7"],[0.6,"#e6f5d0"],[0.7,"#b8e186"],[0.8,"#7fbc41"],[0.9,"#4d9221"],[1,"#276419"]]},"xaxis":{"gridcolor":"white","linecolor":"white","ticks":"","title":{"standoff":15},"zerolinecolor":"white","automargin":true,"zerolinewidth":2},"yaxis":{"gridcolor":"white","linecolor":"white","ticks":"","title":{"standoff":15},"zerolinecolor":"white","automargin":true,"zerolinewidth":2},"scene":{"xaxis":{"backgroundcolor":"#E5ECF6","gridcolor":"white","linecolor":"white","showbackground":true,"ticks":"","zerolinecolor":"white","gridwidth":2},"yaxis":{"backgroundcolor":"#E5ECF6","gridcolor":"white","linecolor":"white","showbackground":true,"ticks":"","zerolinecolor":"white","gridwidth":2},"zaxis":{"backgroundcolor":"#E5ECF6","gridcolor":"white","linecolor":"white","showbackground":true,"ticks":"","zerolinecolor":"white","gridwidth":2}},"shapedefaults":{"line":{"color":"#2a3f5f"}},"annotationdefaults":{"arrowcolor":"#2a3f5f","arrowhead":0,"arrowwidth":1},"geo":{"bgcolor":"white","landcolor":"#E5ECF6","subunitcolor":"white","showland":true,"showlakes":true,"lakecolor":"white"},"title":{"x":0.05},"mapbox":{"style":"light"}}},"updatemenus":[{"bgcolor":"rgba(255,255,255,0.95)","bordercolor":"rgba(0,0,0,0.3)","borderwidth":1,"buttons":[{"args":[{"scene.camera.eye":{"x":0,"y":0,"z":2.5},"scene.camera.center":{"x":0,"y":0,"z":0},"scene.camera.up":{"x":0,"y":1,"z":0}}],"label":"XY View","method":"relayout"},{"args":[{"scene.camera.eye":{"x":0,"y":-2.5,"z":0},"scene.camera.center":{"x":0,"y":0,"z":0},"scene.camera.up":{"x":0,"y":0,"z":1}}],"label":"XZ View","method":"relayout"},{"args":[{"scene.camera.eye":{"x":2.5,"y":0,"z":0},"scene.camera.center":{"x":0,"y":0,"z":0},"scene.camera.up":{"x":0,"y":0,"z":1}}],"label":"YZ View","method":"relayout"},{"args":[{"scene.camera.eye":{"x":1.25,"y":1.25,"z":1.25},"scene.camera.center":{"x":0,"y":0,"z":0},"scene.camera.up":{"x":0,"y":0,"z":1}}],"label":"ISO View","method":"relayout"},{"args":[{"scene.camera.projection.type":"orthographic"}],"args2":[{"scene.camera.projection.type":"perspective"}],"label":"Toggle Projection","method":"relayout"},{"args":[{"paper_bgcolor":"rgb(17,17,17)","plot_bgcolor":"rgb(17,17,17)","font.color":"#f2f5fa","scene.xaxis.backgroundcolor":"rgb(17,17,17)","scene.xaxis.gridcolor":"#506784","scene.xaxis.linecolor":"#506784","scene.xaxis.zerolinecolor":"#C8D4E3","scene.yaxis.backgroundcolor":"rgb(17,17,17)","scene.yaxis.gridcolor":"#506784","scene.yaxis.linecolor":"#506784","scene.yaxis.zerolinecolor":"#C8D4E3","scene.zaxis.backgroundcolor":"rgb(17,17,17)","scene.zaxis.gridcolor":"#506784","scene.zaxis.linecolor":"#506784","scene.zaxis.zerolinecolor":"#C8D4E3","updatemenus[0].bgcolor":"rgba(50,50,50,0.95)","updatemenus[0].bordercolor":"rgba(255,255,255,0.3)","updatemenus[0].font.color":"grey"}],"args2":[{"paper_bgcolor":"white","plot_bgcolor":"#E5ECF6","font.color":"rgb(42, 63, 95)","scene.xaxis.backgroundcolor":"#E5ECF6","scene.xaxis.gridcolor":"white","scene.xaxis.linecolor":"white","scene.xaxis.zerolinecolor":"white","scene.yaxis.backgroundcolor":"#E5ECF6","scene.yaxis.gridcolor":"white","scene.yaxis.linecolor":"white","scene.yaxis.zerolinecolor":"white","scene.zaxis.backgroundcolor":"#E5ECF6","scene.zaxis.gridcolor":"white","scene.zaxis.linecolor":"white","scene.zaxis.zerolinecolor":"white","updatemenus[0].bgcolor":"rgba(255,255,255,0.95)","updatemenus[0].bordercolor":"rgba(0,0,0,0.3)","updatemenus[0].font.color":"black"}],"label":"Toggle Theme","method":"relayout"},{"args":[{"scene.xaxis.showgrid":false,"scene.xaxis.showline":false,"scene.xaxis.zeroline":false,"scene.xaxis.showticklabels":false,"scene.xaxis.title":"","scene.xaxis.visible":false,"scene.xaxis.showbackground":false,"scene.yaxis.showgrid":false,"scene.yaxis.showline":false,"scene.yaxis.zeroline":false,"scene.yaxis.showticklabels":false,"scene.yaxis.title":"","scene.yaxis.visible":false,"scene.yaxis.showbackground":false,"scene.zaxis.showgrid":false,"scene.zaxis.showline":false,"scene.zaxis.zeroline":false,"scene.zaxis.showticklabels":false,"scene.zaxis.title":"","scene.zaxis.visible":false,"scene.zaxis.showbackground":false}],"args2":[{"scene.xaxis.showgrid":true,"scene.xaxis.showline":true,"scene.xaxis.zeroline":true,"scene.xaxis.showticklabels":true,"scene.xaxis.title":"X","scene.xaxis.visible":true,"scene.xaxis.showbackground":true,"scene.yaxis.showgrid":true,"scene.yaxis.showline":true,"scene.yaxis.zeroline":true,"scene.yaxis.showticklabels":true,"scene.yaxis.title":"Y","scene.yaxis.visible":true,"scene.yaxis.showbackground":true,"scene.zaxis.showgrid":true,"scene.zaxis.showline":true,"scene.zaxis.zeroline":true,"scene.zaxis.showticklabels":true,"scene.zaxis.title":"Z","scene.zaxis.visible":true,"scene.zaxis.showbackground":true}],"label":"Toggle Axes","method":"relayout"}],"direction":"left","font":{"size":12},"pad":{"b":5,"l":10,"r":10,"t":5},"showactive":false,"type":"buttons","x":0.02,"xanchor":"left","y":1.02,"yanchor":"bottom"}]},                        {"responsive": true}                    )                };            </script>        </div>
    </div>
    <br />
    <br />


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.036 seconds)


.. _sphx_glr_download_examples_01-basic-plotly-examples_name-filter.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: name-filter.ipynb <name-filter.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: name-filter.py <name-filter.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: name-filter.zip <name-filter.zip>`