Dash VTK Reference

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; optional)

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

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

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

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

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; optional)

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

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

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

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

arrays (Array of Strings; optional):
List of fields you want available for your formula.

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

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; optional)

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

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

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

values (Array of Reals; optional):
Actual values to use inside our array.

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

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

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; optional)

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; 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 (Array of Reals; default [0, 1]):
Data range use for the colorMap.

showCubeAxes (Bool; 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.

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; optional)

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

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

dimensions (Array of Reals; default [1, 1, 1]):
Number of points along x, y, z.

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

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

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

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

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

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

xyz (Array of Reals; default [0, 0, 0]):
Points coordinates.

rgb (Array of Reals; optional):
Use RGB values to attach to the points/vertex.

rgba (Array of Reals; optional):
Use RGBA values to attach to the points/vertex.

scalars (Array of Reals; optional):
Field values to attach to the points.

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

colorDataRange (Array of Reals; default [0, 1]):
Data range use for the colorMap.

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

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; optional)

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; optional)

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

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

points (Array of Reals; optional):
xyz coordinates.

verts (Array of Reals; optional):
verts cells.

lines (Array of Reals; optional):
lines cells.

polys (Array of Reals; optional):
polys cells.

strips (Array of Reals; optional):
strips cells.

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

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; optional)

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

port (Real; 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 (Bool; default true):
Automatically render on data loaded.

resetCameraOnUpdate (Bool; default true):
Automatically reset camera on data loaded.

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; optional)

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

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

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

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; 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 (Array of Reals | String; default 'auto'):
Data range use for the colorMap.

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

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

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

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

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

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

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; 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 (Array; 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 (Array; 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 (Array; default [0, 0, 1]):
Initial camera position from an object in [0,0,0].

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

cameraParallelProjection (Bool; default false):
Use parallel projection (default: false).

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

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

pickingModes (Array 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.

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

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

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

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

size (Array of Reals; default [400, 150]):
Controller size in pixels.

rescaleColorMap (Bool; default true):
Use opacity range to rescale color map.

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

dimensions (Array of Reals; optional):
Number of points along x, y, z.

spacing (Array of Reals; optional):
Spacing along x, y, z between points in world coordinates.

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

rgb (Array of Reals; optional):
Use RGB values to attach to the points/vertex.

rgba (Array of Reals; optional):
Use RGBA values to attach to the points/vertex.

scalars (Array of Reals; 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 (Bool; default true):
Show volumeController.

controllerSize (Array of Reals; default [400, 150]):
Controller size in pixels.

rescaleColorMap (Bool; default true):
Use opacity range to rescale color map.

colorDataRange (Array of Reals | String; default 'auto'):
Data range use for the colorMap.

children (Array of Array of or a singular dash component, String or Reals | Array of or a singular dash component, String or Real; 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 (Array of Reals | String; default 'auto'):
Data range use for the colorMap.