Home > composition-plot > MultidimensionalPlot
Class that creates a multidimensional composition plot (2,3,4,5,6,7,8-dimensional) in 3D
The position of the samples is affected as follows: - 2-d: Line - 3-d: Triangle - 4-d: Tetrahedron - 5,6,7,8-d: Predefined tabulated positions
Signature:
declare class MultidimensionalPlot
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(div, dp, compositionToPosition) | The constructor of MultidimensionalPlot |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| actor | any | ||
| colors | RGBColor[] | ||
| compositionSpace | string[] | undefined | ||
| compositionToPosition | ICompositionToPositionProvider | ||
| div | HTMLElement | ||
| dp | DataProvider | ||
| inverted | boolean | ||
| labelWidgets | any[] | ||
| linesActor | any | ||
| linesMapper | any | ||
| linesPolyData | any | ||
| lut | any | ||
| mapper | any | ||
| polyData | any | ||
| radiusFn | (sample: ISample) => number | ||
| range | Vec2 | ||
| renderer | any | ||
| renderWindow | any | ||
| viewer | any |
| Method | Modifiers | Description |
|---|---|---|
| activeScalarsUpdated() | Rerender after the active figure of merit has changed | |
| addLabels() | ||
| addLines() | ||
| dataUpdated() | The data in the DataProvider have changed, redraw the entire plot | |
| getCamera() | Get the vtkCamera object of this composition plot | |
| removeLabels() | ||
| removeLines() | ||
| resize() | Resize the 3D canvas to span the container size | |
| setBackground(color) | Set the background color of the 3D canvas | |
| setCamera(camera, resetCamera, watchModified) | Set a specific vtkCamera object to be usedThis is useful if there are multiple composition plots that need to have their camera sychronized | |
| setColorMap(map, range) | Set the colormap used to color samples based on a figure of merit | |
| setCompositionSpace(compositionSpace) | Set the composition space of this plotThe composition space is the list of elements that a sample can be expected to have in its composition | |
| setCompositionToPosition(compositionToPosition) | Change the way samples are mapped to the 3D space based on their composition | |
| setInverted(inverted) | Invert the direction of the colormap | |
| setRadiusFn(radiusFn) | Set the function that determines the radius of each sample | |
| updateSizesArray() | Rerender after the sample radius function has been modified |