Dash VTK Reference

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

port (numeric; default 0):
downstream connection port.

vtkClass (character; default 'vtkConeSource'):
vtkClass name.

state (named list; optional):
set of property values for vtkClass.

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

port (numeric; default 0):
downstream connection port.

name (character; default 'scalars'):
Field name.

location (character; default 'POINT'):
Field location [POINT, CELL, COORDINATE, SCALARS, ].

arrays (unnamed list of characters; optional):
List of fields you want available for your formula.

formula (default (xyz) => xyz[0]):
Field formula.

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

type (character; default 'Float32Array'):
Typed array name.

name (character; default 'scalars'):
Field name.

values (unnamed list of numerics; optional):
Actual values to use inside our array.

numberOfComponents (numeric; default 1):
Number of components / Tuple size.

registration (character; default 'addArray'):
Name of the method to call on the fieldData (addArray, setScalars,
setVectors…).

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

actor (named list; optional):
Properties to set to the actor.

mapper (named list; optional):
Properties to set to the actor.

property (named list; optional):
Properties to set to the actor.property.

colorMapPreset (character; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.

colorDataRange (unnamed list of numerics; default [0, 1]):
Data range use for the colorMap.

showCubeAxes (logical; optional):
Show/Hide Cube Axes for the given representation.

cubeAxesStyle (named list; 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.

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

port (numeric; default 0):
downstream connection port.

dimensions (unnamed list of numerics; default [1, 1, 1]):
Number of points along x, y, z.

spacing (unnamed list of numerics; default [1, 1, 1]):
Spacing along x, y, z between points in world coordinates.

origin (unnamed list of numerics; default [0, 0, 0]):
World coordinate of the lower left corner of your vtkImageData (i=0,
j=0, k=0).

direction (unnamed list of numerics; default [ 1, 0, 0, 0, 1, 0, 0, 0, 1,]):
3x3 matrix use to orient the image data.

id (character; optional):
The ID used to identify this component.

port (numeric; default 0):
downstream connection port.

state (named list; default { mesh: { points: [] },}):
State of the mesh.

xyz (unnamed list of numerics; default [0, 0, 0]):
Points coordinates.

rgb (unnamed list of numerics; optional):
Use RGB values to attach to the points/vertex.

rgba (unnamed list of numerics; optional):
Use RGBA values to attach to the points/vertex.

scalars (unnamed list of numerics; optional):
Field values to attach to the points.

colorMapPreset (character; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.

colorDataRange (unnamed list of numerics; default [0, 1]):
Data range use for the colorMap.

property (named list; optional):
Properties to set to the actor.property.

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

port (numeric; default 0):
downstream connection port.

points (unnamed list of numerics; optional):
xyz coordinates.

verts (unnamed list of numerics; optional):
verts cells.

lines (unnamed list of numerics; optional):
lines cells.

polys (unnamed list of numerics; optional):
polys cells.

strips (unnamed list of numerics; optional):
strips cells.

connectivity (character; default 'manual'):
Type of connectivity manual or implicit such as points,
triangles, strips.

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

port (numeric; default 0):
downstream connection port.

vtkClass (character; default ''):
vtkClass name.

url (character; optional):
set of url to fetch data from.

parseAsText (character; optional):
set text data to process.

parseAsArrayBuffer (character; optional):
set binary data to process from base64 string.

renderOnUpdate (logical; default TRUE):
Automatically render on data loaded.

resetCameraOnUpdate (logical; default TRUE):
Automatically reset camera on data loaded.

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

port (numeric; default 0):
downstream connection port.

name (character; default 'shared'):
Unique dataset name to cross reference.

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

mapper (named list; optional):
Properties to set to the mapper.

actor (named list; optional):
Properties to set to the slice/actor.

property (named list; optional):
Properties to set to the volume.property.

colorMapPreset (character; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.

colorDataRange (unnamed list of numerics | character; default 'auto'):
Data range use for the colorMap.

iSlice (numeric; optional):
index of the slice along i.

jSlice (numeric; optional):
index of the slice along j.

kSlice (numeric; optional):
index of the slice along k.

xSlice (numeric; optional):
index of the slice along x.

ySlice (numeric; optional):
index of the slice along y.

zSlice (numeric; optional):
index of the slice along z.

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional):
List of representation to show.

id (character; optional):
The ID used to identify this component.

style (named list; default { width: '100%', height: '100%',}):
Allow user to override the default View style { width: ‘100%’, height:
‘100%’ }.

className (character; optional):
Allow user to provide custom className associated to root element.

background (unnamed 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 (unnamed 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 (unnamed list; default [0, 0, 1]):
Initial camera position from an object in [0,0,0].

cameraViewUp (unnamed list; default [0, 1, 0]):
Initial camera position from an object in [0,0,0].

cameraParallelProjection (logical; default FALSE):
Use parallel projection (default: FALSE).

triggerRender (numeric; default 0):
Property use to trigger a render when changing.

triggerResetCamera (numeric; default 0):
Property use to trigger a resetCamera when changing.

pickingModes (unnamed list of characters; optional):
List of picking listeners to bind. The supported values are click
and hover. By default it is disabled (empty array).

clickInfo (named list; 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 (named list; 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.

id (character; optional):
The ID used to identify this component.

port (numeric; default 0):
downstream connection port.

state (named list; default { image: { dimension: [10, 10, 10] },}):
State of the volume.

id (character; optional):
The ID used to identify this component.

size (unnamed list of numerics; default [400, 150]):
Controller size in pixels.

rescaleColorMap (logical; default TRUE):
Use opacity range to rescale color map.

id (character; optional):
The ID used to identify this component.

dimensions (unnamed list of numerics; optional):
Number of points along x, y, z.

spacing (unnamed list of numerics; optional):
Spacing along x, y, z between points in world coordinates.

origin (unnamed list of numerics; optional):
World coordinate of the lower left corner of your vtkImageData (i=0,
j=0, k=0).

rgb (unnamed list of numerics; optional):
Use RGB values to attach to the points/vertex.

rgba (unnamed list of numerics; optional):
Use RGBA values to attach to the points/vertex.

scalars (unnamed list of numerics; optional):
Field values to attach to the points.

scalarsType (character; default 'Float32Array'):
Types of numbers provided in scalars.

mapper (named list; optional):
Properties to set to the mapper.

volume (named list; optional):
Properties to set to the volume.

property (named list; optional):
Properties to set to the volume.property.

colorMapPreset (character; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.

volumeController (logical; default TRUE):
Show volumeController.

controllerSize (unnamed list of numerics; default [400, 150]):
Controller size in pixels.

rescaleColorMap (logical; default TRUE):
Use opacity range to rescale color map.

colorDataRange (unnamed list of numerics | character; default 'auto'):
Data range use for the colorMap.

children (unnamed list of unnamed list of or a singular dash component, character or numerics | unnamed list of or a singular dash component, character or numeric; optional)

id (character; optional):
The ID used to identify this component.

mapper (named list; optional):
Properties to set to the mapper.

volume (named list; optional):
Properties to set to the volume.

property (named list; optional):
Properties to set to the volume.property.

colorMapPreset (character; default 'erdc_rainbow_bright'):
Preset name for the lookup table color map.

colorDataRange (unnamed list of numerics | character; default 'auto'):
Data range use for the colorMap.