dash_bio_molecule3dviewer Examples and Reference

see Molecule3dViewer in action.

Molecule3dViewer

An example of a default Molecule3dViewer component without any extra properties.

Selection data 
using Dash, DashBio
using StringEncodings, HTTP, JSON

external_stylesheets = ["https://codepen.io/chriddyp/pen/bWLwgP.css"]

app = dash(external_stylesheets=external_stylesheets)

model_data = HTTP.request("GET", "https://git.io/mol3d-model_data.js")
styles_data  = HTTP.request("GET", "https://git.io/mol3d-styles_data.js")

model_data = JSON.parse(decode(model_data.body, "UTF-8"))
styles_data = JSON.parse(decode(styles_data.body, "UTF-8"))

app.layout = html_div([
    dashbio_molecule3dviewer(
        id="dashbio-default-molecule3d",
        styles=styles_data,
        modelData=model_data
    ),
    "Selection data",
    html_hr(),
    html_div(id="default-molecule3d-output")
])

callback!(app,
    Output("default-molecule3d-output", "children"),
    [Input("dashbio-default-molecule3d", "selectedAtomIds")]
) do atom_ids
    if atom_ids isa Nothing || length(atom_ids) == 0
        return "No atom has been selected. Click somewhere on the molecular or structure to select an atom."
    end
    return [html_div([
        html_div("Element: $(model_data["atoms"][atm]["element"])"),
        html_div("Chain: $(model_data["atoms"][atm]["chain"])"),
        html_div("Residue name: $(model_data["atoms"][atm]["residue_name"])"),
        html_br()
    ]) for atm in atom_ids]
end

run_server(app, "0.0.0.0", debug=true)

Customization

Zoom Factor

The current stage of the molecule viewer can be zoomed by a constant factor with the zoom prop. This maintains the rotation and orientation of the stage while zooming, as well as any selections or property changes from other callbacks.

It is important to note that the zoom animation can conflict with the zoomTo animation if both props are set. In this case, it is recommended to set animationDuration to values that would not overlap, or use fixedPath to prioritize the animation which occurs.

This example has not been ported to Julia yet - showing the Python version instead.

Visit the old docs site for Julia at: https://community.plotly.com/c/dash/julia/20

import json
import urllib.request as urlreq
from dash import Dash, html, dcc, Input, Output, callback
import dash_bio as dashbio

app = Dash()



model_data = urlreq.urlopen(
    'https://git.io/mol3d-model_data.js'
).read().decode('utf-8')

styles_data = urlreq.urlopen(
    'https://git.io/mol3d-styles_data.js'
).read().decode('utf-8')

model_data = json.loads(model_data)
styles_data = json.loads(styles_data)

app.layout = html.Div(
    [
        dashbio.Molecule3dViewer(
            id="zoomfactor-molecule3d", styles=styles_data, modelData=model_data
        ),
        dcc.Slider(
            id="zoomfactor-slider",
            min=0.4,
            max=2.0,
            step=None,
            marks={0.4: "0.4", 0.8: "0.8", 1.2: "1.2", 1.6: "1.6", 2.0: "2.0"},
            value=0.8,
        ),
    ]
)

@callback(
    Output("zoomfactor-molecule3d", "zoom"),
    Input("zoomfactor-slider", "value"),
    prevent_initial_call=True,
)
def zoom(value):
    return {"factor": value, "animationDuration": 1000, "fixedPath": False}

if __name__ == "__main__":
    app.run(debug=True)

Zooming to Specific Residues

We can zoom into specific residues and chains on the molecule by setting the zoomTo prop. An optional animationDuration denotes the duration of the zoom animation (in milliseconds),

The chain key indicates the protein chain identifier from the molecule’s model data, and resi is the internal integer index value on the chain for the residue of interest.

In the example below, select the rows on the table to zoom into and label the chosen residue.

This example has not been ported to Julia yet - showing the Python version instead.

Visit the old docs site for Julia at: https://community.plotly.com/c/dash/julia/20

from dash import Dash, html, dash_table, Input, Output, callback
import dash_bio as dashbio
from dash_bio.utils import PdbParser, create_mol3d_style
import pandas as pd

app = Dash()

parser = PdbParser('https://git.io/4K8X.pdb')

data = parser.mol3d_data()
styles = create_mol3d_style(
    data['atoms'], visualization_type='cartoon', color_element='residue'
)

df = pd.DataFrame(data["atoms"])
df = df.drop_duplicates(subset=['residue_name'])
df['positions'] = df['positions'].apply(lambda x: ', '.join(map(str, x)))

app.layout = html.Div(
    [
        dash_table.DataTable(
            id="zooming-specific-residue-table",
            columns=[{"name": i, "id": i} for i in df.columns],
            data=df.to_dict("records"),
            row_selectable="single",
            page_size=10,
        ),
        dashbio.Molecule3dViewer(
            id="zooming-specific-molecule3d-zoomto",
            modelData=data,
            styles=styles
        ),
    ]
)


@callback(
    Output("zooming-specific-molecule3d-zoomto", "zoomTo"),
    Output("zooming-specific-molecule3d-zoomto", "labels"),
    Input("zooming-specific-residue-table", "selected_rows"),
    prevent_initial_call=True
)
def residue(selected_row):
    row = df.iloc[selected_row]
    row['positions'] = row['positions'].apply(lambda x: [float(x) for x in x.split(',')])
    return [
        {
            "sel": {"chain": row["chain"], "resi": row["residue_index"]},
            "animationDuration": 1500,
            "fixedPath": True,
        },
        [
            {
                "text": "Residue Name: {}".format(row["residue_name"].values[0]),
                "position": {
                    "x": row["positions"].values[0][0],
                    "y": row["positions"].values[0][1],
                    "z": row["positions"].values[0][2],
                },
            }
        ],
    ]

if __name__ == "__main__":
    app.run(debug=True)

Selection Type

Choose what gets highlighted with the same color upon selection.

using Dash, DashBio
using StringEncodings, HTTP, JSON

app = dash()

model_data = HTTP.request("GET", "https://git.io/mol3d-model_data.js")
styles_data  = HTTP.request("GET", "https://git.io/mol3d-styles_data.js")

model_data = JSON.parse(decode(model_data.body, "UTF-8"))
styles_data = JSON.parse(decode(styles_data.body, "UTF-8"))

app.layout = dashbio_molecule3dviewer(
    styles=styles_data,
    modelData=model_data,
    selectionType="Chain"
)

run_server(app, "0.0.0.0", debug=true)

Background Color/Opacity

Change the background color and opacity of the canvas on which Mol3D is rendered.

using Dash, DashBio
using StringEncodings, HTTP, JSON

app = dash()

model_data = HTTP.request("GET", "https://git.io/mol3d-model_data.js")
styles_data  = HTTP.request("GET", "https://git.io/mol3d-styles_data.js")

model_data = JSON.parse(decode(model_data.body, "UTF-8"))
styles_data = JSON.parse(decode(styles_data.body, "UTF-8"))

app.layout = dashbio_molecule3dviewer(
    styles=styles_data,
    modelData=model_data,
    backgroundColor="#FF0000",
    backgroundOpacity=0.2
)

run_server(app, "0.0.0.0", debug=true)

Labels

Add labels corresponding to the atom of the molecule. Label styles can be set with additional parameters. For styling keys, see.

using Dash, DashBio
using StringEncodings, HTTP, JSON

app = dash()

model_data = HTTP.request("GET", "https://git.io/mol3d-model_data.js")
styles_data  = HTTP.request("GET", "https://git.io/mol3d-styles_data.js")

model_data = JSON.parse(decode(model_data.body, "UTF-8"))
styles_data = JSON.parse(decode(styles_data.body, "UTF-8"))

app.layout = dashbio_molecule3dviewer(
    styles=styles_data,
    modelData=model_data,
    labels = [
        Dict("text" => "Residue Name: GLY1", "fontColor" => "red", "font" => "Courier New, monospace"),
        Dict("text" => "Residue Chain: A", "position" => Dict("x" =>15.407, "y" => -8.432, "z" => 6.573))
    ],
)

run_server(app, "0.0.0.0", debug=true)

Shapes

Add predefined renderable shapes to the molecule. Supported shape types are Arrow, Sphere, and Cylinder.

using Dash, DashBio
using StringEncodings, HTTP, JSON

app = dash()

model_data = HTTP.request("GET", "https://git.io/mol3d-model_data.js")
styles_data  = HTTP.request("GET", "https://git.io/mol3d-styles_data.js")

model_data = JSON.parse(decode(model_data.body, "UTF-8"))
styles_data = JSON.parse(decode(styles_data.body, "UTF-8"))

app.layout = dashbio_molecule3dviewer(
    styles=styles_data,
    modelData=model_data,
    shapes = [
        Dict(
            "type" => "Sphere",
            "center" => Dict("x" =>0,"y" =>0,"z" =>0),
            "radius" => 3.0,
            "color" => "blue",
            "opacity" => 1
        ),
        Dict(
            "type" => "Arrow",
            "start" => Dict("x" =>40, "y" =>20.0, "z" =>0.0),
            "end" => Dict("x" =>20.0, "y" =>10.0, "z" =>0.0),
            "radius" => 1.0,
            "radiusRadio" =>0.5,
            "mid" =>1.0,
            "color" => "red",
            "opacity" => 1
        ),
        Dict(
            "type" => "Cylinder",
            "start" => Dict("x" => 10.0, "y" => -30.0, "z" => 0.0),
            "end" => Dict("x" => 20.0, "y" => -50.0, "z" => 0.0),
            "radius" => 1.0,
            "fromCap" => 1,
            "toCap" => 2,
            "color" => "green",
            "opacity" => 1
        )
    ],
)

run_server(app, "0.0.0.0", debug=true)

Isosurfaces

Render a 3D isosurface. Volumetric orbital data must be provided in the cube file format.

using Dash, DashBio
using StringEncodings, HTTP, JSON

app = dash()

model_data = HTTP.request("GET", "https://git.io/mol3d-model_data.js")
styles_data  = HTTP.request("GET", "https://git.io/mol3d-styles_data.js")

model_data = JSON.parse(decode(model_data.body, "UTF-8"))
styles_data = JSON.parse(decode(styles_data.body, "UTF-8"))

cube_data = HTTP.request("GET", "https://git.io/mol3d-benzene-homo.cube")
cube_data = decode(cube_data.body, "UTF-8")

app.layout = dashbio_molecule3dviewer(
    styles=styles_data,
    modelData=model_data,
    selectionType="atom",
    orbital=Dict(
        "cube_file" => cube_data,
        "iso_val" => 0.1,
        "opacity" => 1.0,
        "positiveVolumetricColor" => "red",
        "negativeVolumetricColor" => "blue",
    )
)

run_server(app, "0.0.0.0", debug=true)

Molecule3dViewer Properties

Our recommended IDE for writing Dash apps is Dash Enterprise’s
Data Science Workspaces,
which has typeahead support for Dash Component Properties.
Find out if your company is using
Dash Enterprise.

id (String; optional):
The ID used to identify this component in callbacks.

selectionType (a value equal to: ‘atom’, ‘residue’ or ‘chain’; default 'atom'):
The selection type - may be atom, residue or chain.

backgroundColor (String; default '#FFFFFF'):
Property to change the background color of the molecule viewer.

backgroundOpacity (Real; default 0):
Property to change the background opacity - ranges from 0 to 1.

styles (Array of Dicts; optional):
Property that can be used to change the representation of the
molecule. Options include sticks, cartoon and sphere.

styles is an Array of Dicts with keys:

  • color (String; optional)

  • visualization_type (a value equal to: ‘cartoon’, ‘sphere’ or ‘stick’; optional)

modelData (Dict; optional):
The data that will be used to display the molecule in 3D The data will
be in JSON format and should have two main dictionaries - atoms, bonds.

modelData is a Dict with keys:

  • atoms (Array; optional)

  • bonds (Array; optional)

atomLabelsShown (Bool; optional):
Property to either show or hide labels.

selectedAtomIds (Array; optional):
Property that stores a list of all selected atoms.

labels (Array of Dicts; optional):
Labels corresponding to the atoms of the molecule. Each label has a
text field, a string containing the label content, and can have many
other styling fields as described in
https://3dmol.csb.pitt.edu/doc/types.html#LabelSpec.

orbital (Dict; optional):
Add an isosurface from volumetric data provided in the cube_file.

orbital is a Dict with keys:

  • cube_file (String; optional):
    The filepath containing raw volumetric data for vertex coloring.

  • iso_val (Real; optional):
    The isovalue to draw the surface at.

  • negativeVolumetricColor (String; optional):
    Color for the negative value of the isosurface orbital.

  • opacity (Real; optional):
    Transparency of the surface, between 0 and 1.

  • positiveVolumetricColor (String; optional):
    Color for the positive value of the isosurface orbital.

zoom (Dict; default { factor: 0.8, animationDuration: 0, fixedPath: false,}):
Zoom the current view by a constant factor, with optional parameters
to modify the duration and motion of the zoom animation.

zoom is a Dict with keys:

  • animationDuration (Real; optional):
    An optional parameter that denotes the duration of a zoom
    animation, in milliseconds.

  • factor (Real; optional):
    Magnification factor. Values greater than 1 will zoom, in, less
    than one will zoom out. Default 2.

  • fixedPath (Bool; optional):
    If true, animation is constrained to requested motion, overriding
    updates that happen during the animation.

zoomTo (Dict; default { sel: {}, animationDuration: 0, fixedPath: false,}):
Zoom to center of atom selection.

zoomTo is a Dict with keys:

  • animationDuration (Real; optional):
    An optional parameter that denotes the duration of a zoom
    animation , in milliseconds.

  • fixedPath (Bool; optional):
    If true, animation is constrained to requested motion, overriding
    updates that happen during the animation.

  • sel (Dict; optional):
    Selection specification specifying model and atom properties to
    select. Default: all atoms in viewer.

    sel is a Dict with keys:

    • chain (String; optional):
      Chain that the residue is located on.

    • resi (Real; optional):
      The index value used to identify the residue; residues are
      numbered sequentially starting from 1.

shapes (Array of Dicts; optional):
Add a predefined renderable shape objects to the molecule. Valid shape
types are Arrow, Sphere, and Cylinder.

height (Real; optional):
The height (in px) of the container.

width (Real; optional):
The width (in px) of the container.

style (Dict; default { height: 500, width: 500,}):
Generic style overrides on the plot div.

onRenderNewData (optional):
Callback to re-render molecule viewer when modelData is changed.

onChangeSelection (optional):
Callback to change append selectedAtomIds when a selection is made.

loading_state (Dict; optional):
Object that holds the loading state object coming from dash-renderer.

loading_state is a Dict with keys:

  • component_name (String; optional):
    Holds the name of the component that is loading.

  • is_loading (Bool; optional):
    Determines if the component is loading or not.

  • prop_name (String; optional):
    Holds which property is loading.

Example Data