History

Danny Brown cae54b0779 Fix/update branch cherry pick (#2039 ) * Update all the icons * Turn off global tool sync; watch as the world burns * Shift a bunch of things around so we can start tracking/setting per element * ToolBarService to initiate one of three different calls; callback passed to all button types * SplitButton and Toolbar Button to use new `onInteraction` prop and new toolbar state * Changes to toolbar button interface and config * Fix broken layout selector * Update SR viewport to activate tools in viewport component * Duplicate activation logic in measurement tracking extension * Add alternative/dashed variants for SR Viewport * pass through "setToolActive" commands for other viewport types * fix small overlay bugs (no wwwc or scale info) * Show SpacingBetweenSlices instead of PixelSpacing in patient information dialog * Fix prop-types * Update tracked viewport to have alternative tracked styling * alt styling for SR viewports * Update to support isLocked + isRehydratable * fix broken logic * fix broken logic * switch icon style * fix icon styles * hover and click to start flow * expedited workflow when data is not dirty (just after SR hydration) * fix: setting elliptical roi tool * fix arrow annotate dialog * fix: do not show learn more button for now * remove dead code * simpler cache invalidation * simpler cache invalidation part 2 * Fix for unable to spand study cards on separate pages		2020-09-14 21:18:46 -04:00
..
.webpack	fix: Add some code splitting for PWA build (#937 )	2019-09-26 11:35:13 +02:00
src	Fix/update branch cherry pick (#2039 )	2020-09-14 21:18:46 -04:00
babel.config.js	Make thumbnails display	2020-05-18 23:21:41 +02:00
CHANGELOG.md	chore(release): publish [skip ci]	2020-05-12 14:49:58 +00:00
jest.config.js	feat: 🎸 MeasurementService (#1314 )	2020-02-10 14:15:05 -05:00
LICENSE	Chore/kill yalc with fire (#629 )	2019-08-13 15:36:46 -04:00
package.json	bump react-cornerstone-viewport version	2020-08-20 12:30:38 -04:00
README.md	feat: 🎸 Configuration so viewer tools can nix handles (#1304 )	2019-12-20 12:15:40 -05:00

README.md

@ohif/extension-cornerstone

This extension adds support for viewing and manipulating 2D medical images via a viewport. The underlying implementation wraps the cornerstonejs/react-cornerstone-viewport, and provides basic commands and toolbar buttons for common actions.

Index

Extension Id: cornerstone

Commands Module
Toolbar Module
Viewport Module

Commands Module

This extensions includes the following Commands and Command Definitions. These can be registered with @ohif/core's CommandManager. After registering the commands, they can be bound to hotkeys using the HotkeysManager and listed in the UserPreferences modal.

You can read more about [Commands][docs-commands], [Hotkeys][docs-hotkeys], and the [UserPreferences Modal][docs-userprefs] in their respective locations in the OHIF Viewer's documentation.

Command Name	Description	Store Contexts
`rotateViewportCW`		viewports
`rotateViewportCCW`		viewports
`invertViewport`		viewports
`flipViewportVertical`		viewports
`flipViewportHorizontal`		viewports
`scaleUpViewport`		viewports
`scaleDownViewport`		viewports
`fitViewportToWindow`		viewports
`resetViewport`		viewports
clearAnnotations	TODO
next/previous Image	TODO
first/last Image	TODO
`nextViewportDisplaySet`
`previousViewportDisplaySet`
`setToolActive`	Activates tool for primary button/touch

Our toolbar module contains definitions for:

StackScroll
Zoom
Wwwc
Pan
Length
Angle
Reset
Cine

All use the ACTIVE_VIEWPORT::CORNERSTONE context.

Viewport Module

Our Viewport wraps [cornerstonejs/react-cornerstone-viewport][react-viewport] and is connected the redux store. This module is the most prone to change as we hammer out our Viewport interface.

Tool Configuration

Tools can be configured through extension configuration using the tools key:

  ...
  cornerstoneExtensionConfig: {
    tools: {
      ArrowAnnotate: {
        configuration: {
          getTextCallback: (callback, eventDetails) => callback(prompt('Enter your custom annotation')),
        },
      },
    },
  },
  ...

Annotate Tools Configuration

We currently support one property for annotation tools.

Hide handles

This extension configuration allows you to toggle on/off handle rendering for all annotate tools:

  ...
  cornerstoneExtensionConfig: {
    hideHandles: true,
  },
  ...

## Resources

### Repositories

- [cornerstonejs/react-cornerstone-viewport][react-viewport]
- [cornerstonejs/cornerstoneTools][cornerstone-tools]
- [cornerstonejs/cornerstone][cornerstone]

<!--
  Links
  -->

<!-- prettier-ignore-start -->
[docs-commands]: https://www.com
[docs-hotkeys]: https://www.com
[docs-userprefs]: htt
[react-viewport]: https://github.com/cornerstonejs/react-cornerstone-viewport
[cornerstone-tools]: https://github.com/cornerstonejs/cornerstoneTools
[cornerstone]: https://github.com/cornerstonejs/cornerstone
<!-- prettier-ignore-end -->