docs: stub bulk of missing extension docs

This commit is contained in:
dannyrb 2019-12-07 01:20:09 -05:00
parent 4920b527d1
commit 076b89ef83
3 changed files with 72 additions and 0 deletions

View File

@ -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'],
};
},
};
```

View File

@ -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,
};
},
};
```

View File

@ -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