Dash VTK Reference
Algorithm Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.Algorithm)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
id (string; optional):
The ID used to identify this component.
port (number; default 0):
downstream connection port.
vtkClass (string; default 'vtkConeSource'):
vtkClass name.
state (dict; optional):
set of property values for vtkClass.
Calculator Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.Calculator)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
id (string; optional):
The ID used to identify this component.
port (number; default 0):
downstream connection port.
name (string; default 'scalars'):
Field name.
location (string; default 'POINT'):
Field location [POINT, CELL, COORDINATE, SCALARS, ].
arrays (list of strings; optional):
List of fields you want available for your formula.
formula (default (xyz) => xyz[0]):
Field formula.
CellData Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.CellData)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
DataArray Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.DataArray)
```
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.
type (string; default 'Float32Array'):
Typed array name.
name (string; default 'scalars'):
Field name.
values (list of numbers; optional):
Actual values to use inside our array.
numberOfComponents (number; default 1):
Number of components / Tuple size.
registration (string; default 'addArray'):
Name of the method to call on the fieldData (addArray, setScalars,
setVectors…).
FieldData Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.FieldData)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
GeometryRepresentation Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.GeometryRepresentation)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
id (string; optional):
The ID used to identify this component.
actor (dict; optional):
Properties to set to the actor.
mapper (dict; optional):
Properties to set to the actor.
property (dict; optional):
Properties to set to the actor.property.
colorMapPreset (string; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.
colorDataRange (list of numbers; default [0, 1]):
Data range use for the colorMap.
showCubeAxes (boolean; optional):
Show/Hide Cube Axes for the given representation.
cubeAxesStyle (dict; optional):
Configure cube Axes style by overriding the set of properties defined
https://github.com/Kitware/vtk-js/blob/HEAD/Sources/Rendering/Core/CubeAxesActor/index.js#L703-L719.
ImageData Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.ImageData)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
id (string; optional):
The ID used to identify this component.
port (number; default 0):
downstream connection port.
dimensions (list of numbers; default [1, 1, 1]):
Number of points along x, y, z.
spacing (list of numbers; default [1, 1, 1]):
Spacing along x, y, z between points in world coordinates.
origin (list of numbers; default [0, 0, 0]):
World coordinate of the lower left corner of your vtkImageData (i=0,
j=0, k=0).
direction (list of numbers; default [ 1, 0, 0, 0, 1, 0, 0, 0, 1,]):
3x3 matrix use to orient the image data.
Mesh Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.Mesh)
```
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.
port (number; default 0):
downstream connection port.
state (dict; default { mesh: { points: [] },}):
State of the mesh.
PointCloudRepresentation Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.PointCloudRepresentation)
```
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.
xyz (list of numbers; default [0, 0, 0]):
Points coordinates.
rgb (list of numbers; optional):
Use RGB values to attach to the points/vertex.
rgba (list of numbers; optional):
Use RGBA values to attach to the points/vertex.
scalars (list of numbers; optional):
Field values to attach to the points.
colorMapPreset (string; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.
colorDataRange (list of numbers; default [0, 1]):
Data range use for the colorMap.
property (dict; optional):
Properties to set to the actor.property.
PointData Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.PointData)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
PolyData Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.PolyData)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
id (string; optional):
The ID used to identify this component.
port (number; default 0):
downstream connection port.
points (list of numbers; optional):
xyz coordinates.
verts (list of numbers; optional):
verts cells.
lines (list of numbers; optional):
lines cells.
polys (list of numbers; optional):
polys cells.
strips (list of numbers; optional):
strips cells.
connectivity (string; default 'manual'):
Type of connectivity manual or implicit such as points,
triangles, strips.
Reader Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.Reader)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
id (string; optional):
The ID used to identify this component.
port (number; default 0):
downstream connection port.
vtkClass (string; default ''):
vtkClass name.
url (string; optional):
set of url to fetch data from.
parseAsText (string; optional):
set text data to process.
parseAsArrayBuffer (string; optional):
set binary data to process from base64 string.
renderOnUpdate (boolean; default True):
Automatically render on data loaded.
resetCameraOnUpdate (boolean; default True):
Automatically reset camera on data loaded.
ShareDataSet Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.ShareDataSet)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
id (string; optional):
The ID used to identify this component.
port (number; default 0):
downstream connection port.
name (string; default 'shared'):
Unique dataset name to cross reference.
SliceRepresentation Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.SliceRepresentation)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
id (string; optional):
The ID used to identify this component.
mapper (dict; optional):
Properties to set to the mapper.
actor (dict; optional):
Properties to set to the slice/actor.
property (dict; optional):
Properties to set to the volume.property.
colorMapPreset (string; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.
colorDataRange (list of numbers | string; default 'auto'):
Data range use for the colorMap.
iSlice (number; optional):
index of the slice along i.
jSlice (number; optional):
index of the slice along j.
kSlice (number; optional):
index of the slice along k.
xSlice (number; optional):
index of the slice along x.
ySlice (number; optional):
index of the slice along y.
zSlice (number; optional):
index of the slice along z.
View Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.View)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional):
List of representation to show.
id (string; optional):
The ID used to identify this component.
style (dict; default { width: '100%', height: '100%',}):
Allow user to override the default View style { width: ‘100%’, height:
‘100%’ }.
className (string; optional):
Allow user to provide custom className associated to root element.
background (list; default [0.2, 0.3, 0.4]):
The color of the view background using 3 floating numbers between 0-1
of Red, Green, Blue component.
interactorSettings (list; default [ { button: 1, action: 'Rotate', }, { button: 2, action: 'Pan', }, { button: 3, action: 'Zoom', scrollEnabled: True, }, { button: 1, action: 'Pan', shift: True, }, { button: 1, action: 'Zoom', alt: True, }, { button: 1, action: 'ZoomToMouse', control: True, }, { button: 1, action: 'Roll', alt: True, shift: True, },]):
Configure the interactions.
cameraPosition (list; default [0, 0, 1]):
Initial camera position from an object in [0,0,0].
cameraViewUp (list; default [0, 1, 0]):
Initial camera position from an object in [0,0,0].
cameraParallelProjection (boolean; default False):
Use parallel projection (default: False).
triggerRender (number; default 0):
Property use to trigger a render when changing.
triggerResetCamera (number; default 0):
Property use to trigger a resetCamera when changing.
pickingModes (list of strings; optional):
List of picking listeners to bind. The supported values are click
and hover. By default it is disabled (empty array).
clickInfo (dict; optional):
Read-only prop. To use this, make sure that pickingModes contains
click. This prop is updated when an element in the map is clicked.
This contains the picking info describing the object being clicked on.
hoverInfo (dict; optional):
Read-only prop. To use this, make sure that pickingModes contains
hover. This prop is updated when an element in the map is hovered.
This contains the picking info describing the object being hovered.
Volume Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.Volume)
```
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.
port (number; default 0):
downstream connection port.
state (dict; default { image: { dimension: [10, 10, 10] },}):
State of the volume.
VolumeController Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.VolumeController)
```
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.
size (list of numbers; default [400, 150]):
Controller size in pixels.
rescaleColorMap (boolean; default True):
Use opacity range to rescale color map.
VolumeDataRepresentation Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.VolumeDataRepresentation)
```
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.
dimensions (list of numbers; optional):
Number of points along x, y, z.
spacing (list of numbers; optional):
Spacing along x, y, z between points in world coordinates.
origin (list of numbers; optional):
World coordinate of the lower left corner of your vtkImageData (i=0,
j=0, k=0).
rgb (list of numbers; optional):
Use RGB values to attach to the points/vertex.
rgba (list of numbers; optional):
Use RGBA values to attach to the points/vertex.
scalars (list of numbers; optional):
Field values to attach to the points.
scalarsType (string; default 'Float32Array'):
Types of numbers provided in scalars.
mapper (dict; optional):
Properties to set to the mapper.
volume (dict; optional):
Properties to set to the volume.
property (dict; optional):
Properties to set to the volume.property.
colorMapPreset (string; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.
volumeController (boolean; default True):
Show volumeController.
controllerSize (list of numbers; default [400, 150]):
Controller size in pixels.
rescaleColorMap (boolean; default True):
Use opacity range to rescale color map.
colorDataRange (list of numbers | string; default 'auto'):
Data range use for the colorMap.
VolumeRepresentation Properties
Access this documentation in your Python terminal with:
```pythonhelp(dash_vtk.VolumeRepresentation)
```
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.
children (list of list of or a singular dash component, string or numbers | list of or a singular dash component, string or number; optional)
id (string; optional):
The ID used to identify this component.
mapper (dict; optional):
Properties to set to the mapper.
volume (dict; optional):
Properties to set to the volume.
property (dict; optional):
Properties to set to the volume.property.
colorMapPreset (string; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.
colorDataRange (list of numbers | string; default 'auto'):
Data range use for the colorMap.