Dash VTK

Dash VTK lets you integrate the vtk.js visualization pipeline directly into your Dash app. It is powered by react-vtk-js.

Getting started

Quickstart (Python)

First, install the library through pip:

pip install dash-vtk

Then, create a file called app.py and add the following example:

import dash
import dash_vtk
import dash_html_components as html

app = dash.Dash(__name__)

app.layout = html.Div(
    style={"width": "100%", "height": "calc(100vh - 16px)"},
    children=dash_vtk.View([
        dash_vtk.GeometryRepresentation([
            dash_vtk.Algorithm(
                vtkClass="vtkConeSource",
                state={"resolution": 64, "capping": False},
            )
        ]),
    ]),
)

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

Now, simply run the app:

python app.py

For a more detailed example, see usage.py.

Quickstart (R)

First, install the package from GitHub (the package is not yet available via CRAN):

remotes::install_github("plotly/dash-vtk")

then, create your component and add it to your layout:

library(dash)
library(dashVtk)
library(dashHtmlComponents)

app <- Dash$new()

app$layout(htmlDiv(
    style = list("width" = "100%", "height" = "calc(100vh - 16px)"),
    children = vtkView(list(
        vtkGeometryRepresentation(
            vtkAlgorithm(
                vtkClass = "vtkConeSource",
                state = list("resolution" = 64, "capping" = FALSE),
            )
        )
    ))
))

app$run_server()

Contributing

See docs/CONTRIBUTING.md to learn about:

• Setting up the environment
• Coding Style
• Code quality & design
• Tests
• Publishing

Running the demos

First clone the project (replace <name> with the desired demo):

git clone https://github.com/plotly/dash-vtk.git
cd dash-vtk/demos/<name>/

Create a venv and install the requirements:

python -m venv venv
source venv/bin/activate  # for Windows, use venv\Scripts\activate.bat
pip install -e ../../  # IMPORTANT! If you skip you will get the pip version of dash-vtk
pip install -r requirements.txt

Run the demo:

python app.py

References

You can find the complete API reference in docs/REFERENCES.md for each of the following components:

• Algorithm
• Calculator
• CellData
• DataArray
• FieldData
• GeometryRepresentation
• ImageData
• PointCloudRepresentation
• PointData
• PolyData
• Reader
• ShareDataSet
• SliceRepresentation
• View
• VolumeController
• VolumeDataRepresentation
• VolumeRepresentation

Demos

Usage for dash_vtk.Algorithm

• Code
• Online Demo (coming soon)

Point Cloud with PyVista

• Code
• Online Demo (coming soon)

Terrain deformation using PyVista and dash-vtk

• Code
• Online Demo (coming soon)

Volume Rendering

• Code
• Online Demo (coming soon)

VTK for data processing and dash-vtk for rendering

• Code
• Online Demo (coming soon)

Synthetic Volume Rendering

• Code
• Online Demo (coming soon)