diff --git a/extensions/ohif-vtk-extension/.prettierrc b/extensions/ohif-vtk-extension/.prettierrc index 92cde390a..12348ec6a 100644 --- a/extensions/ohif-vtk-extension/.prettierrc +++ b/extensions/ohif-vtk-extension/.prettierrc @@ -1,3 +1,9 @@ { - "singleQuote": true -} \ No newline at end of file + "trailingComma": "es5", + "printWidth": 80, + "proseWrap": "always", + "tabWidth": 2, + "semi": true, + "singleQuote": true, + "endOfLine": "lf" +} diff --git a/extensions/ohif-vtk-extension/README.md b/extensions/ohif-vtk-extension/README.md index 1b4c09ef6..e21a3f0bb 100644 --- a/extensions/ohif-vtk-extension/README.md +++ b/extensions/ohif-vtk-extension/README.md @@ -1 +1,55 @@ # @ohif/extension-vtk + +![npm (scoped)](https://img.shields.io/npm/v/@ohif/extension-vtk.svg?style=flat-square) + + + +#### Index + +Extension Id: `vtk` + +- [Commands Module](#commands-module) +- [Toolbar Module](#toolbar-module) +- [Viewport Module](#viewport-module) + +## Commands Module + +| Command Name | Description | Store Contexts | +| ---------------------- | ----------- | -------------- | +| `axial` | | viewports | +| `coronal` | | viewports | +| `sagittal` | | viewports | +| `enableRotateTool` | | viewports | +| `enableCrosshairsTool` | | viewports | +| `enableLevelTool` | | viewports | +| `mpr2d` | | viewports | + +## Toolbar Module + +Our toolbar module contains definitions for: + +- `Crosshairs` +- `WWWC` +- `Rotate` + +All use the `ACTIVE_VIEWPORT::VTK` context. + +## Viewport Module + +Our Viewport wraps [OHIF/react-vtkjs-viewport][react-viewport] and is connected +the redux store. This module is the most prone to change as we hammer out our +Viewport interface. + +## Resources + +### Repositories + +- [OHIF/react-vtkjs-viewport][react-viewport] + + + + +[react-viewport]: https://github.com/OHIF/react-vtkjs-viewport +