fixes for hotkeys usage in docusaurus
This commit is contained in:
1 parent
7a9f113b91
commit
ff28a2264b
24 files changed
+61
-659
No files matched your search
@@ -70,7 +70,7 @@ and registered extension's features, are configured using this file.
|
||||
|
||||
The easiest way to apply your own configuration is to modify the `default.js`
|
||||
file. For more advanced cofiguration options, check out our
|
||||
[configuration essentials guide](../configuring/index.md).
|
||||
[configuration essentials guide](../../configuration/index.md).
|
||||
|
||||
## Next Steps
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 4
|
||||
sidebar_label: Issue & PR Triage Process
|
||||
---
|
||||
|
||||
|
||||
@@ -2,27 +2,17 @@
|
||||
sidebar_position: 3
|
||||
sidebar_label: Data Source
|
||||
---
|
||||
|
||||
# Module: Data Source
|
||||
|
||||
|
||||
## Overview
|
||||
The internal data structure of OHIF’s metadata follows naturalized DICOM JSON, A format pioneered by `dcmjs`. In short DICOM metadata headers with DICOM Keywords instead of tags and sequences as arrays, for easy development and clear code.
|
||||
|
||||
The internal data structure of OHIF’s metadata follows naturalized DICOM JSON, A
|
||||
format pioneered by `dcmjs`. In short DICOM metadata headers with DICOM Keywords
|
||||
instead of tags and sequences as arrays, for easy development and clear code.
|
||||
We have built a standard for fetching and mapping data into OHIF’s native format, which we call DataSources, and have provided one implementation of this standard.
|
||||
|
||||
We have built a standard for fetching and mapping data into OHIF’s native
|
||||
format, which we call DataSources, and have provided one implementation of this
|
||||
standard.
|
||||
You can make another datasource implementation which communicates to your backend and maps to OHIF’s native format, then use any existing mode on your platform. Your data doesn’t even need to be DICOM if you can map some proprietary data to the correct format.
|
||||
|
||||
You can make another datasource implementation which communicates to your
|
||||
backend and maps to OHIF’s native format, then use any existing mode on your
|
||||
platform. Your data doesn’t even need to be DICOM if you can map some
|
||||
proprietary data to the correct format.
|
||||
|
||||
The DataSource is also a place to add easy helper methods that platform-specific
|
||||
extensions can call in order to interact with the backend, meaning proprietary
|
||||
data interactions can be wrapped in extensions.
|
||||
The DataSource is also a place to add easy helper methods that platform-specific extensions can call in order to interact with the backend, meaning proprietary data interactions can be wrapped in extensions.
|
||||
|
||||
```js
|
||||
const getDataSourcesModule = () => [
|
||||
@@ -36,13 +26,13 @@ const getDataSourcesModule = () => [
|
||||
];
|
||||
```
|
||||
|
||||
Default extension provides two main data sources that are commonly used:
|
||||
`dicomweb` and `dicomjson`
|
||||
Default extension provides two main data sources that are commonly used: `dicomweb` and `dicomjson`
|
||||
|
||||
```js
|
||||
import { createDicomWebApi } from './DicomWebDataSource/index.js';
|
||||
import { createDicomJSONApi } from './DicomJSONDataSource/index.js';
|
||||
|
||||
|
||||
function getDataSourcesModule() {
|
||||
return [
|
||||
{
|
||||
@@ -59,14 +49,13 @@ function getDataSourcesModule() {
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Custom DataSource
|
||||
You can add your custom datasource by creating the implementation using `IWebApiDataSource.create` from `@ohif/core`. This factory function creates a new "Web API" data source that fetches data over HTTP.
|
||||
|
||||
You need to make sure, you implement the following functions for the data source.
|
||||
|
||||
You can add your custom datasource by creating the implementation using
|
||||
`IWebApiDataSource.create` from `@ohif/core`. This factory function creates a
|
||||
new "Web API" data source that fetches data over HTTP.
|
||||
|
||||
You need to make sure, you implement the following functions for the data
|
||||
source.
|
||||
|
||||
```js title="platform/core/src/DataSources/IWebApiDataSource.js"
|
||||
function create({
|
||||
@@ -87,9 +76,8 @@ function create({
|
||||
You can take a look at `dicomweb` data source implementation to get an idea
|
||||
`extensions/default/src/DicomWebDataSource/index.js`
|
||||
|
||||
## DicomMetadataStore
|
||||
|
||||
In `OHIF-v3` we have a central location for the metadata of studies and they are
|
||||
located in `DicomMetadataStore`. Your custom datasource can communicate with
|
||||
`DicomMetadataStore` to store, and fetch Study/Series/Instance metadata. We will
|
||||
learn more about `DicomMetadataStore` in services.
|
||||
|
||||
## DicomMetadataStore
|
||||
In `OHIF-v3` we have a central location for the metadata of studies and they are located
|
||||
in `DicomMetadataStore`. Your custom datasource can communicate with `DicomMetadataStore` to store, and fetch Study/Series/Instance metadata. We will learn more about `DicomMetadataStore` in services.
|
||||
@@ -78,7 +78,7 @@ There are two types of `routes` that are created by the mode.
|
||||
- Routes with dataSourceName `/${mode.id}/${dataSourceName}`
|
||||
- Routes without dataSourceName `/${mode.id}`
|
||||
|
||||
Therefore navigating to `http://localhost:3000/viewer/?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125113417.1` will run the app with the layout and functionalities of the `viewer` mode using the `defaultDataSourceName` which is defined in the [App Config](../configuring/index.md)
|
||||
Therefore navigating to `http://localhost:3000/viewer/?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125113417.1` will run the app with the layout and functionalities of the `viewer` mode using the `defaultDataSourceName` which is defined in the [App Config](../../configuration/index.md)
|
||||
|
||||
You can use the same exact mode using a different registered data source (e.g., `dicomjson`) by navigating to `http://localhost:3000/viewer/dicomjson/?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125113417.1`
|
||||
|
||||
|
||||
Reference in new issue
Block a user