From 076b89ef833f7b8157c554bd20227d23a74f4b7d Mon Sep 17 00:00:00 2001 From: dannyrb Date: Sat, 7 Dec 2019 01:20:09 -0500 Subject: [PATCH] docs: stub bulk of missing extension docs --- docs/latest/extensions/modules/panel.md | 31 +++++++++++++++++ .../extensions/modules/sop-class-handler.md | 33 +++++++++++++++++++ docs/latest/viewer/index.md | 8 +++++ 3 files changed, 72 insertions(+) diff --git a/docs/latest/extensions/modules/panel.md b/docs/latest/extensions/modules/panel.md index 4604d4154..77de01541 100644 --- a/docs/latest/extensions/modules/panel.md +++ b/docs/latest/extensions/modules/panel.md @@ -1,3 +1,34 @@ # Module: Panel ... + +```js +import MyComponent from './MyComponent.js'; + +export default { + id: 'example-panel-module', + + /** + * @param {object} params + * @param {object} params.servicesManager + */ + getPanelModule({ servicesManager }) { + return { + menuOptions: [ + { + icon: 'list', + label: 'Magic', + target: 'target-component-id', + }, + ], + components: [ + { + id: 'target-component-id', + component: MyComponent, + }, + ], + defaultContext: ['VIEWER'], + }; + }, +}; +``` diff --git a/docs/latest/extensions/modules/sop-class-handler.md b/docs/latest/extensions/modules/sop-class-handler.md index 4a7e81699..82aaf93fd 100644 --- a/docs/latest/extensions/modules/sop-class-handler.md +++ b/docs/latest/extensions/modules/sop-class-handler.md @@ -1,3 +1,36 @@ # Module: SOP Class Handler ... + +```js +const SOP_CLASS_UIDS = { + BASIC_TEXT_SR: '1.2.840.10008.5.1.4.1.1.88.11', + ENHANCED_SR: '1.2.840.10008.5.1.4.1.1.88.22', +}; + +const sopClassHandlerModule = { + id: 'OHIFDicomHtmlSopClassHandler', + sopClassUids: Object.values(SOP_CLASS_UIDS), + + /** + * @param {object} series - + * @param {object} study - + * @param {object} dicomWebClient - + * @param {object} authorizationHeaders - + */ + getDisplaySetFromSeries(series, study, dicomWebClient, authorizationHeaders) { + const instance = series.getFirstInstance(); + + return { + plugin: 'html', + displaySetInstanceUid: 0, + wadoRoot: study.getData().wadoRoot, + wadoUri: instance.getData().wadouri, + sopInstanceUid: instance.getSOPInstanceUID(), + seriesInstanceUid: series.getSeriesInstanceUID(), + studyInstanceUid: study.getStudyInstanceUID(), + authorizationHeaders, + }; + }, +}; +``` diff --git a/docs/latest/viewer/index.md b/docs/latest/viewer/index.md index 22d366efe..1a484583e 100644 --- a/docs/latest/viewer/index.md +++ b/docs/latest/viewer/index.md @@ -1 +1,9 @@ # Viewer + +The OHIF Viewing Platform strives to be highly configurable and extensible. This +makes it easier for our community members to keep their "secret sauce" private, +and incentivises contributions back to the platform. The `@ohif/viewer` project +of the platform is the lynchpin that combines everything to create our +application. + +- When configuration and themeing aren't enough