From 6a1838bf0d0578641f4a16fe6ae9e37a28d5d454 Mon Sep 17 00:00:00 2001 From: Alireza Date: Thu, 28 Aug 2025 12:57:45 -0400 Subject: [PATCH] fix/migration 3p11 (#5370) --- .../migration-guide/3p10-to-3p11/index.md | 11 +- platform/docs/docusaurus.config.js | 5 + .../version-3.10/development/link.md | 11 -- .../migration-guide/3p9-to-3p10/index.md | 9 - .../customization-service/Measurements.md | 9 - .../customization-service/Segmentation.md | 9 - .../customization-service/StudyBrowser.md | 11 -- .../services/data/MultiMonitorService.md | 71 ------- .../platform/services/ui/cine-service.md | 8 - .../{version-3.10 => version-3.11}/README.md | 0 .../assets/designs/architecture-diagram | Bin .../assets/designs/canny-full.fig | Bin .../assets/designs/cloud.svg | 0 .../assets/designs/embedded-viewer-diagram | Bin .../assets/designs/nginx-image-archive.fig | Bin .../assets/designs/npm-logo-red.svg | 0 .../assets/designs/scope-of-project.fig | Bin .../user-access-control-request-flow.fig | Bin .../assets/img/Loading-Indicator.png | Bin .../assets/img/OHIF-e2e-test-studies.png | Bin .../assets/img/SR-exported.png | Bin .../assets/img/WORKFLOW_DEPLOY.png | Bin .../assets/img/WORKFLOW_PR_CHECKS.png | Bin .../WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH.png | Bin .../assets/img/WORKFLOW_RELEASE.png | Bin .../assets/img/aboutModal.png | Bin .../assets/img/add-extension.png | Bin .../assets/img/add-mode.png | Bin .../assets/img/azure1.png | Bin .../assets/img/azure10.png | Bin .../assets/img/azure2.png | Bin .../assets/img/azure3.png | Bin .../assets/img/azure4.png | Bin .../assets/img/azure5.png | Bin .../assets/img/azure6.png | Bin .../assets/img/azure7.png | Bin .../assets/img/azure8.png | Bin .../assets/img/azure9.png | Bin .../browser-console-non-secure-context.png | Bin .../assets/img/captureViewportModal.png | Bin .../assets/img/cli-search-no-verbose.png | Bin .../assets/img/cli-search-with-verbose.png | Bin .../assets/img/clock-mode.png | Bin .../assets/img/clock-mode1.png | Bin .../assets/img/colorbarImage.png | Bin .../assets/img/context-menu.jpg | Bin .../assets/img/cornerstone-tools-link.gif | Bin .../img/cors-browser-console-errors.png | Bin .../assets/img/cors-network-panel-errors.png | Bin .../assets/img/create-extension.png | Bin .../assets/img/create-mode.png | Bin .../assets/img/custom-logo.png | Bin .../assets/img/customizable-overlay.jpeg | Bin .../img/data-source-configuration-ui.png | Bin .../assets/img/dcm4chee-upload.gif | Bin .../assets/img/demo-4d.webp | Bin .../assets/img/demo-measurements.webp | Bin .../assets/img/demo-pdf.webp | Bin .../assets/img/demo-ptct.webp | Bin .../assets/img/demo-rtstruct.webp | Bin .../assets/img/demo-segmentation.webp | Bin .../assets/img/demo-video.webp | Bin .../assets/img/demo-volume-rendering.webp | Bin .../assets/img/demo-volumeRendering.png | Bin .../assets/img/dicom-json-public.png | Bin .../assets/img/dicom-json.png | Bin .../assets/img/docker-pacs.png | Bin .../assets/img/e2e-cypress-final.png | Bin .../assets/img/e2e-cypress.png | Bin .../assets/img/embedded-viewer-diagram.png | Bin .../assets/img/filtering-worklist.png | Bin .../img/github-readme-branches-Jun2024.png | Bin .../assets/img/google-create-credentials.png | Bin .../assets/img/google-enable-apis.png | Bin ...oogle-healthcare-service-agent-warning.png | Bin .../assets/img/google-manually-add-scopes.png | Bin .../assets/img/google-oauth-consent-steps.png | Bin .../assets/img/google-projects-drop-down.png | Bin .../img/google-provided-accounts-checkbox.png | Bin .../assets/img/hangingProtocolExample.png | Bin .../assets/img/iframe-basic.png | Bin .../assets/img/iframe-headers.png | Bin .../assets/img/jwt-explained.png | Bin .../assets/img/keycloak-default-theme.png | Bin .../assets/img/keycloak-ohif-theme.png | Bin .../assets/img/labelling-flow.png | Bin .../assets/img/large-pt-ct.jpeg | Bin ...utSelectorAdvancedPresetGeneratorImage.png | Bin .../img/layoutSelectorCommonPresetsImage.png | Bin .../assets/img/loading-indicator-icon.png | Bin .../assets/img/loading-indicator-percent.png | Bin .../assets/img/locizeSponsor.svg | 0 .../assets/img/locked-sr.png | Bin .../assets/img/measurement-labels-auto.png | Bin .../assets/img/measurement-panel-1.png | Bin .../assets/img/measurement-panel-prompt.png | Bin .../assets/img/measurement-panel-tracked.png | Bin .../assets/img/measurement-temporary.png | Bin .../assets/img/measurements-prevNext.png | Bin .../assets/img/memory-profiling-regular.png | Bin .../assets/img/microscopy.webp | Bin .../assets/img/migration-modes.png | Bin .../assets/img/migration-split-button.png | Bin .../assets/img/mode-archs.png | Bin .../assets/img/mode-clock.png | Bin .../assets/img/mode-template.png | Bin .../assets/img/nginx-image-archive.png | Bin .../assets/img/ohif-cli-list.png | Bin .../assets/img/ohif-non-secure-context.png | Bin .../assets/img/ohif-pacs-keycloak.png | Bin .../assets/img/open-graph.png | Bin .../assets/img/overview.png | Bin .../assets/img/panel-module-left-right.png | Bin .../assets/img/panel-module-v3.png | Bin .../assets/img/panelmodule-icon.png | Bin .../assets/img/preferSizeOverAccuracy.png | Bin .../assets/img/progressDropdown.png | Bin .../assets/img/promptAddSeriesContent.png | Bin .../assets/img/promptBeginTrackingContent.png | Bin .../assets/img/promptDiscardDirtyContent.png | Bin .../assets/img/promptDiscardSeriesContent.png | Bin .../assets/img/promptDiscardStudyContent.png | Bin .../assets/img/promptRtstructContent.png | Bin .../assets/img/promptSRTrackingContent.png | Bin .../assets/img/promptTrackStudyContent.png | Bin .../assets/img/promptsegmentationContent.png | Bin .../assets/img/reference-lines-from-start.png | Bin .../assets/img/restore-exported-sr.png | Bin .../assets/img/scope-of-project.png | Bin .../assets/img/segDisplayEditingFalse.png | Bin .../assets/img/segDisplayEditingTrue.png | Bin .../assets/img/segmentation-overlay.png | Bin .../img/segmentationShowAddSegmentImage.png | Bin .../assets/img/segmentationTableModeImage.png | Bin .../img/segmentationTableModeImage2.png | Bin .../img/self-signed-cert-advanced-warning.png | Bin .../assets/img/self-signed-cert-warning.png | Bin .../assets/img/seriesSort.png | Bin .../assets/img/services-data.png | Bin .../assets/img/services-measurements.png | Bin .../assets/img/services-ui.png | Bin .../assets/img/services.png | Bin .../assets/img/static-dicom-web.png | Bin .../assets/img/studyMenuItemsImage.png | Bin .../assets/img/surge-deploy.gif | Bin .../assets/img/template-extension-files.png | Bin .../assets/img/template-mode-files.png | Bin .../assets/img/template-mode-ui.png | Bin .../assets/img/thumbnailMenuItemsImage.png | Bin .../assets/img/toolbar-module.png | Bin .../assets/img/toolbarModule-layout.png | Bin .../img/toolbarModule-nested-buttons.png | Bin .../assets/img/toolbarModule-zoom.png | Bin .../assets/img/toolbox-modal.png | Bin .../assets/img/tracked-not-tracked.png | Bin .../assets/img/tracking-workflow1.png | Bin .../assets/img/tracking-workflow2.png | Bin .../assets/img/tracking-workflow3.png | Bin .../assets/img/ui-modal.gif | Bin .../assets/img/ui-services.png | Bin .../assets/img/uploader.gif | Bin .../img/user-access-control-request-flow.png | Bin .../assets/img/user-hotkeys-default.png | Bin .../assets/img/user-hotkeys.png | Bin .../assets/img/user-measurement-export.png | Bin .../assets/img/user-open-viewer.png | Bin .../assets/img/user-study-filter.png | Bin .../assets/img/user-study-list.png | Bin .../assets/img/user-study-next.png | Bin .../assets/img/user-study-panel.png | Bin .../assets/img/user-study-summary.png | Bin .../assets/img/user-studyist-modespecific.png | Bin .../assets/img/user-toolbar-download-icon.png | Bin .../assets/img/user-toolbar-extra.png | Bin .../assets/img/user-toolbar-preset.png | Bin .../assets/img/user-toolbarDownload.png | Bin .../assets/img/user-viewer-layout.png | Bin .../assets/img/user-viewer-main.png | Bin .../img/user-viewer-toolbar-measurements.png | Bin .../assets/img/user-viewer-toolbar.png | Bin .../assets/img/user-viewer.png | Bin .../assets/img/viewport-action-corners.png | Bin .../assets/img/viewport-download-warning.png | Bin .../assets/img/viewport-notification.png | Bin .../assets/img/viewportModule-layout.png | Bin .../assets/img/viewportModule.png | Bin .../img/viewportOverlay-customization.png | Bin .../assets/img/webgl-int16.png | Bin .../assets/img/webgl-report-norm16.png | Bin .../assets/img/windowLevelActionMenu.png | Bin .../assets/img/windowLevelPresets.png | Bin .../configuration/_category_.json | 0 .../configuration/configurationFiles.md | 3 + .../configuration/dataSources/_category_.json | 0 .../dataSources/configuration-ui.md | 2 + .../configuration/dataSources/dicom-json.md | 2 + .../dataSources/dicom-web-proxy.md | 2 + .../configuration/dataSources/dicom-web.md | 2 + .../configuration/dataSources/introduction.md | 2 + .../configuration/dataSources/static-files.md | 2 + .../configuration/tour-demo.gif | Bin .../configuration/tours.md | 2 + .../configuration/url.md | 2 + .../conformance.md | 1 + .../deployment/_category_.json | 0 .../deployment/authorization.md | 2 + .../deployment/azure.md | 2 + .../deployment/build-for-production.md | 2 + .../deployment/cors.md | 2 + .../deployment/custom-url-access.md | 1 + .../deployment/docker/docker.md | 2 + .../deployment/docker/ssl.md | 3 +- .../deployment/google-cloud-healthcare.md | 2 + .../deployment/iframe.md | 2 + .../deployment/index.md | 2 + .../deployment/nginx--image-archive.md | 2 + .../deployment/static-assets.md | 2 + .../deployment/user-account-control.md | 2 + .../development/_category_.json | 0 .../development/android-ios-debugging.md | 2 + .../development/architecture.md | 2 + .../development/continuous-integration.md | 2 + .../development/contributing.md | 2 + .../development/getting-started.md | 2 + .../version-3.11/development/link.md | 52 +++++ .../development/ohif-cli.md | 2 + .../development/our-process.md | 2 + .../development/playwright-testing.md | 7 +- .../development/testing.md | 2 + .../development/types.md | 2 + .../development/video-tutorials.md | 2 + .../development/webWorkers.md | 2 + .../faq/_category_.json | 0 .../version-3.11/faq/add-viewport-icon.md | 178 ++++++++++++++++++ .../faq/faq-measure-1.png | Bin .../faq/faq-measure-2.png | Bin .../faq/faq-measure-4.png | Bin .../faq/faq-measure-5.png | Bin .../faq/faq-measure3.png | Bin .../faq/general.md | 2 + .../faq/index.md | 2 + .../faq/study-sorting.png | Bin .../faq/technical.md | 7 + .../migration-guide/3p10-to-3p11/commands.md | 72 +++++++ .../migration-guide/3p10-to-3p11/hydration.md | 85 +++++++++ .../migration-guide/3p10-to-3p11/index.md | 8 + .../migration-guide/3p10-to-3p11/other.md | 46 +++++ .../3p10-to-3p11/toolbarService.md | 178 ++++++++++++++++++ .../migration-guide/3p10-to-3p11/ui.md | 60 ++++++ .../3p10-to-3p11/viewport-action-menu.md | 124 ++++++++++++ .../migration-guide/3p11-to-3p12/index.md | 8 + .../migration-guide/3p8-to-3p9/0-general.md | 1 + .../1-segmentation/1-Architecture.md | 1 + .../2-segmentationService-basic.md | 1 + .../3-segmentationserice-representation.md | 1 + .../4-segmentationserice-creation.md | 3 +- .../4-segmentationserice-modification.md | 1 + .../5-segmentationserice-style.md | 1 + .../6-segmentationserice-other.md | 1 + .../3p8-to-3p9/1-segmentation/index.md | 1 + .../migration-guide/3p8-to-3p9/2-Renamings.md | 1 + .../3p8-to-3p9/3-DataSources.md | 1 + .../3p8-to-3p9/4-Measurements.md | 1 + .../3p8-to-3p9/4-ViewportActionCorner.md | 1 + .../3p8-to-3p9/5-StateSyncService.md | 1 + .../migration-guide/3p8-to-3p9/6-RTSTRUCT.md | 1 + .../migration-guide/3p8-to-3p9/7-UI.md | 1 + .../3p8-to-3p9/8-Refactorings.md | 1 + .../migration-guide/3p8-to-3p9/9-other.md | 1 + .../migration-guide/3p8-to-3p9/index.md | 1 + .../3p9-to-3p10/1-General/commands.md | 1 + .../3p9-to-3p10/1-General/general-m.md | 1 + .../3p9-to-3p10/1-General/hotkeys.md | 1 + .../3p9-to-3p10/1-General/routerBaseName.md | 1 + .../2-CustomizationService/index.md | 1 + .../3p9-to-3p10/3-UI/1-Introduction.md | 1 + .../3-UI/10-Migration-3p10-Tests.md | 1 + .../3p9-to-3p10/3-UI/1a-Colors.md | 1 + .../3-UI/2-Migration-3p10-Icons.md | 62 ++++++ .../3-UI/2a-Migration-3p10-Button.md | 1 + .../3-UI/3-Migration-3p10-Input.md | 1 + .../3-UI/4-Migration-3p10-Tooltip.md | 1 + .../3-UI/4a-Migration-3p10-Select.md | 3 +- .../3-UI/4a-Migration-3p10-Switch.md | 1 + .../3-UI/5-Migration-3p10-Toolbar.md | 1 + .../6-Migration-3p10-SegmentationTable.md | 1 + .../3-UI/7-Migration-3p10-Tours.md | 1 + .../3-UI/8-Migration-3p10-DialogService.md | 137 +++++++++++--- .../3-UI/9-Migration-3p10-ModalService.md | 69 +++++++ .../migration-guide/3p9-to-3p10/index.md | 11 ++ .../migration-guide/_category_.json | 0 .../migration-guide/from-3p7-to-3p8.md | 2 + .../migration-guide/from-v2.md | 2 + .../migration-guide/index.md | 2 + .../platform/_category_.json | 0 .../platform/browser-support.md | 2 + .../platform/environment-variables.md | 2 + .../platform/extensions/_category_.json | 0 .../platform/extensions/extension.md | 2 + .../platform/extensions/index.md | 2 + .../platform/extensions/installation.md | 2 + .../platform/extensions/lifecycle.md | 2 + .../extensions/modules/_category_.json | 0 .../platform/extensions/modules/commands.md | 2 + .../extensions/modules/contextModule.md | 2 + .../extensions/modules/data-source.md | 2 + .../platform/extensions/modules/hpModule.md | 2 + .../extensions/modules/layout-template.md | 2 + .../platform/extensions/modules/panel.md | 2 + .../extensions/modules/sop-class-handler.md | 2 + .../platform/extensions/modules/toolbar.md | 2 + .../platform/extensions/modules/utility.md | 2 + .../platform/extensions/modules/viewport.md | 2 + .../version-3.11/platform/hooks/index.md | 33 ++++ .../platform/hooks/useDynamicMaxHeight.md | 65 +++++++ .../platform/hooks/useMeasurementTracking.md | 79 ++++++++ .../platform/hooks/useMeasurements.md | 68 +++++++ .../platform/hooks/usePatientInfo.md | 68 +++++++ .../platform/hooks/useSearchParams.md | 69 +++++++ .../platform/hooks/useSessionStorage.md | 84 +++++++++ .../platform/hooks/useViewportDisplaySets.md | 98 ++++++++++ .../platform/hooks/useViewportHover.md | 57 ++++++ .../hooks/useViewportSegmentations.md | 95 ++++++++++ .../platform/internationalization.md | 2 + .../platform/managers/_category_.json | 0 .../platform/managers/commands.md | 2 + .../platform/managers/extension.md | 2 + .../platform/managers/hotkeys.md | 2 + .../platform/managers/index.md | 2 + .../platform/managers/service.md | 2 + .../platform/modes/_category_.json | 0 .../platform/modes/index.md | 2 + .../platform/modes/installation.md | 2 + .../platform/modes/lifecycle.md | 2 + .../platform/modes/routes.md | 2 + .../platform/modes/validity.md | 2 + .../platform/pwa-vs-packaged.md | 2 + .../platform/scope-of-project.md | 2 + .../platform/services/_category_.json | 0 .../customization-service/Measurements.md | 11 ++ .../customization-service/Segmentation.md | 11 ++ .../customization-service/StudyBrowser.md | 13 ++ .../customization-service/_category_.json | 0 .../customization-service/advanced.md | 2 + .../customization-service/contextMenu.md | 2 + .../customization-service/customRoutes.md | 2 + .../customizationService.md | 2 + .../sampleCustomizations.tsx | 76 +++----- .../customization-service/viewportOverlay.md | 3 + .../services/data/DicomMetadataStore.md | 2 + .../services/data/DisplaySetService.md | 19 +- .../services/data/HangingProtocolService.md | 2 + .../services/data/MeasurementService.md | 5 +- .../services/data/MultiMonitorService.md | 163 ++++++++++++++++ .../platform/services/data/PanelService.md | 2 + .../services/data/SegmentationService.md | 2 + .../services/data/SyncGroupService.md | 2 + .../services/data/ToolGroupService.md | 2 + .../platform/services/data/ToolbarService.md | 2 + .../services/data/WorkflowStepService.md | 2 + .../platform/services/data/_category_.json | 0 .../platform/services/data/index.md | 2 + .../platform/services/index.md | 2 + .../platform/services/pubsub.md | 2 + .../platform/services/ui/_category_.json | 0 .../platform/services/ui/cine-service.md | 10 + .../platform/services/ui/index.md | 2 + .../platform/services/ui/ui-dialog-service.md | 2 + .../platform/services/ui/ui-modal-service.md | 2 + .../services/ui/ui-notification-service.md | 2 + .../services/ui/ui-viewport-dialog-service.md | 2 + .../services/ui/viewport-action-menu.md | 2 + .../services/ui/viewport-grid-service.md | 2 + .../platform/themeing.md | 2 + .../release-notes.md | 2 + .../resources.md | 2 + .../version-3.11/test-coverage.md | 17 ++ .../user-guide/_category_.json | 0 .../user-guide/index.md | 0 .../user-guide/viewer/Language.md | 0 .../user-guide/viewer/_category_.json | 0 .../user-guide/viewer/hotkeys.md | 0 .../user-guide/viewer/index.md | 0 .../user-guide/viewer/measurement-panel.md | 0 .../user-guide/viewer/measurement-tracking.md | 0 .../version-3.11/user-guide/viewer/mpr.md | 18 ++ .../user-guide/viewer/study-panel.md | 0 .../user-guide/viewer/toolbar.md | 0 .../user-guide/viewer/viewport.md | 0 ...debars.json => version-3.11-sidebars.json} | 0 platform/docs/versions.json | 2 +- 391 files changed, 2322 insertions(+), 215 deletions(-) delete mode 100644 platform/docs/versioned_docs/version-3.10/development/link.md delete mode 100644 platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/index.md delete mode 100644 platform/docs/versioned_docs/version-3.10/platform/services/customization-service/Measurements.md delete mode 100644 platform/docs/versioned_docs/version-3.10/platform/services/customization-service/Segmentation.md delete mode 100644 platform/docs/versioned_docs/version-3.10/platform/services/customization-service/StudyBrowser.md delete mode 100644 platform/docs/versioned_docs/version-3.10/platform/services/data/MultiMonitorService.md delete mode 100644 platform/docs/versioned_docs/version-3.10/platform/services/ui/cine-service.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/README.md (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/designs/architecture-diagram (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/designs/canny-full.fig (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/designs/cloud.svg (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/designs/embedded-viewer-diagram (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/designs/nginx-image-archive.fig (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/designs/npm-logo-red.svg (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/designs/scope-of-project.fig (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/designs/user-access-control-request-flow.fig (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/Loading-Indicator.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/OHIF-e2e-test-studies.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/SR-exported.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/WORKFLOW_DEPLOY.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/WORKFLOW_PR_CHECKS.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/WORKFLOW_RELEASE.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/aboutModal.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/add-extension.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/add-mode.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure1.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure10.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure2.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure3.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure4.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure5.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure6.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure7.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure8.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/azure9.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/browser-console-non-secure-context.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/captureViewportModal.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/cli-search-no-verbose.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/cli-search-with-verbose.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/clock-mode.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/clock-mode1.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/colorbarImage.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/context-menu.jpg (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/cornerstone-tools-link.gif (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/cors-browser-console-errors.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/cors-network-panel-errors.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/create-extension.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/create-mode.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/custom-logo.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/customizable-overlay.jpeg (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/data-source-configuration-ui.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/dcm4chee-upload.gif (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/demo-4d.webp (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/demo-measurements.webp (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/demo-pdf.webp (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/demo-ptct.webp (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/demo-rtstruct.webp (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/demo-segmentation.webp (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/demo-video.webp (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/demo-volume-rendering.webp (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/demo-volumeRendering.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/dicom-json-public.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/dicom-json.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/docker-pacs.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/e2e-cypress-final.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/e2e-cypress.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/embedded-viewer-diagram.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/filtering-worklist.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/github-readme-branches-Jun2024.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/google-create-credentials.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/google-enable-apis.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/google-healthcare-service-agent-warning.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/google-manually-add-scopes.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/google-oauth-consent-steps.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/google-projects-drop-down.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/google-provided-accounts-checkbox.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/hangingProtocolExample.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/iframe-basic.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/iframe-headers.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/jwt-explained.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/keycloak-default-theme.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/keycloak-ohif-theme.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/labelling-flow.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/large-pt-ct.jpeg (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/layoutSelectorAdvancedPresetGeneratorImage.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/layoutSelectorCommonPresetsImage.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/loading-indicator-icon.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/loading-indicator-percent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/locizeSponsor.svg (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/locked-sr.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/measurement-labels-auto.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/measurement-panel-1.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/measurement-panel-prompt.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/measurement-panel-tracked.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/measurement-temporary.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/measurements-prevNext.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/memory-profiling-regular.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/microscopy.webp (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/migration-modes.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/migration-split-button.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/mode-archs.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/mode-clock.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/mode-template.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/nginx-image-archive.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/ohif-cli-list.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/ohif-non-secure-context.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/ohif-pacs-keycloak.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/open-graph.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/overview.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/panel-module-left-right.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/panel-module-v3.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/panelmodule-icon.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/preferSizeOverAccuracy.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/progressDropdown.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/promptAddSeriesContent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/promptBeginTrackingContent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/promptDiscardDirtyContent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/promptDiscardSeriesContent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/promptDiscardStudyContent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/promptRtstructContent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/promptSRTrackingContent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/promptTrackStudyContent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/promptsegmentationContent.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/reference-lines-from-start.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/restore-exported-sr.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/scope-of-project.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/segDisplayEditingFalse.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/segDisplayEditingTrue.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/segmentation-overlay.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/segmentationShowAddSegmentImage.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/segmentationTableModeImage.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/segmentationTableModeImage2.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/self-signed-cert-advanced-warning.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/self-signed-cert-warning.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/seriesSort.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/services-data.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/services-measurements.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/services-ui.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/services.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/static-dicom-web.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/studyMenuItemsImage.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/surge-deploy.gif (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/template-extension-files.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/template-mode-files.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/template-mode-ui.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/thumbnailMenuItemsImage.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/toolbar-module.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/toolbarModule-layout.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/toolbarModule-nested-buttons.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/toolbarModule-zoom.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/toolbox-modal.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/tracked-not-tracked.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/tracking-workflow1.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/tracking-workflow2.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/tracking-workflow3.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/ui-modal.gif (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/ui-services.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/uploader.gif (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-access-control-request-flow.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-hotkeys-default.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-hotkeys.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-measurement-export.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-open-viewer.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-study-filter.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-study-list.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-study-next.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-study-panel.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-study-summary.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-studyist-modespecific.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-toolbar-download-icon.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-toolbar-extra.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-toolbar-preset.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-toolbarDownload.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-viewer-layout.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-viewer-main.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-viewer-toolbar-measurements.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-viewer-toolbar.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/user-viewer.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/viewport-action-corners.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/viewport-download-warning.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/viewport-notification.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/viewportModule-layout.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/viewportModule.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/viewportOverlay-customization.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/webgl-int16.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/webgl-report-norm16.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/windowLevelActionMenu.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/assets/img/windowLevelPresets.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/configurationFiles.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/dataSources/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/dataSources/configuration-ui.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/dataSources/dicom-json.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/dataSources/dicom-web-proxy.md (88%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/dataSources/dicom-web.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/dataSources/introduction.md (76%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/dataSources/static-files.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/tour-demo.gif (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/tours.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/configuration/url.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/conformance.md (56%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/authorization.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/azure.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/build-for-production.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/cors.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/custom-url-access.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/docker/docker.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/docker/ssl.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/google-cloud-healthcare.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/iframe.md (89%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/index.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/nginx--image-archive.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/static-assets.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/deployment/user-account-control.md (98%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/android-ios-debugging.md (92%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/architecture.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/continuous-integration.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/contributing.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/getting-started.md (95%) create mode 100644 platform/docs/versioned_docs/version-3.11/development/link.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/ohif-cli.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/our-process.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/playwright-testing.md (94%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/testing.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/types.md (91%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/video-tutorials.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/development/webWorkers.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/_category_.json (100%) create mode 100644 platform/docs/versioned_docs/version-3.11/faq/add-viewport-icon.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/faq-measure-1.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/faq-measure-2.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/faq-measure-4.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/faq-measure-5.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/faq-measure3.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/general.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/index.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/study-sorting.png (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/faq/technical.md (97%) create mode 100644 platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/commands.md create mode 100644 platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/hydration.md create mode 100644 platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/index.md create mode 100644 platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/other.md create mode 100644 platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/toolbarService.md create mode 100644 platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/ui.md create mode 100644 platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/viewport-action-menu.md create mode 100644 platform/docs/versioned_docs/version-3.11/migration-guide/3p11-to-3p12/index.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/0-general.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md (87%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md (94%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/1-segmentation/index.md (72%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/2-Renamings.md (80%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/3-DataSources.md (82%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/4-Measurements.md (89%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md (88%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/5-StateSyncService.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/6-RTSTRUCT.md (71%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/7-UI.md (94%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/8-Refactorings.md (90%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/9-other.md (94%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p8-to-3p9/index.md (51%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/1-General/commands.md (88%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/1-General/general-m.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/1-General/hotkeys.md (94%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/1-General/routerBaseName.md (92%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/2-CustomizationService/index.md (98%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md (73%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md (89%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md (89%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md (98%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md (87%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md (92%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md (85%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md (65%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md (59%) create mode 100644 platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/index.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/from-3p7-to-3p8.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/from-v2.md (99%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/migration-guide/index.md (58%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/browser-support.md (86%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/environment-variables.md (76%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/extension.md (86%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/index.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/installation.md (58%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/lifecycle.md (92%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/commands.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/contextModule.md (75%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/data-source.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/hpModule.md (98%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/layout-template.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/panel.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/sop-class-handler.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/toolbar.md (98%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/utility.md (85%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/extensions/modules/viewport.md (93%) create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/index.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/useDynamicMaxHeight.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/useMeasurementTracking.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/useMeasurements.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/usePatientInfo.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/useSearchParams.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/useSessionStorage.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportDisplaySets.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportHover.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportSegmentations.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/internationalization.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/managers/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/managers/commands.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/managers/extension.md (90%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/managers/hotkeys.md (89%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/managers/index.md (87%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/managers/service.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/modes/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/modes/index.md (98%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/modes/installation.md (57%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/modes/lifecycle.md (92%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/modes/routes.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/modes/validity.md (76%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/pwa-vs-packaged.md (80%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/scope-of-project.md (90%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/_category_.json (100%) create mode 100644 platform/docs/versioned_docs/version-3.11/platform/services/customization-service/Measurements.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/services/customization-service/Segmentation.md create mode 100644 platform/docs/versioned_docs/version-3.11/platform/services/customization-service/StudyBrowser.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/customization-service/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/customization-service/advanced.md (93%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/customization-service/contextMenu.md (73%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/customization-service/customRoutes.md (91%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/customization-service/customizationService.md (98%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/customization-service/sampleCustomizations.tsx (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/customization-service/viewportOverlay.md (63%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/DicomMetadataStore.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/DisplaySetService.md (80%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/HangingProtocolService.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/MeasurementService.md (94%) create mode 100644 platform/docs/versioned_docs/version-3.11/platform/services/data/MultiMonitorService.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/PanelService.md (89%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/SegmentationService.md (92%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/SyncGroupService.md (94%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/ToolGroupService.md (94%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/ToolbarService.md (97%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/WorkflowStepService.md (95%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/data/index.md (88%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/index.md (94%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/pubsub.md (91%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/ui/_category_.json (100%) create mode 100644 platform/docs/versioned_docs/version-3.11/platform/services/ui/cine-service.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/ui/index.md (96%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/ui/ui-dialog-service.md (86%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/ui/ui-modal-service.md (90%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/ui/ui-notification-service.md (90%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/ui/ui-viewport-dialog-service.md (89%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/ui/viewport-action-menu.md (83%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/services/ui/viewport-grid-service.md (91%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/platform/themeing.md (92%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/release-notes.md (51%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/resources.md (96%) create mode 100644 platform/docs/versioned_docs/version-3.11/test-coverage.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/index.md (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/viewer/Language.md (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/viewer/_category_.json (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/viewer/hotkeys.md (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/viewer/index.md (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/viewer/measurement-panel.md (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/viewer/measurement-tracking.md (100%) create mode 100644 platform/docs/versioned_docs/version-3.11/user-guide/viewer/mpr.md rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/viewer/study-panel.md (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/viewer/toolbar.md (100%) rename platform/docs/versioned_docs/{version-3.10 => version-3.11}/user-guide/viewer/viewport.md (100%) rename platform/docs/versioned_sidebars/{version-3.10-sidebars.json => version-3.11-sidebars.json} (100%) diff --git a/platform/docs/docs/migration-guide/3p10-to-3p11/index.md b/platform/docs/docs/migration-guide/3p10-to-3p11/index.md index d91498504..90c2dfc5b 100644 --- a/platform/docs/docs/migration-guide/3p10-to-3p11/index.md +++ b/platform/docs/docs/migration-guide/3p10-to-3p11/index.md @@ -1,8 +1,15 @@ --- +id: index sidebar_position: 1 sidebar_label: 3.10 -> 3.11 +title: 3.10 to 3.11 Migration Guide --- -# Migration Guide +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; -This guide provides information about migrating from OHIF version 3.10 to version 3.11. +# 3.10 to 3.11 Migration Guide + +Here you can find the migration guides for upgrading from OHIF version 3.10 to version 3.11. + + item.docId !== 'migration-guide/3p10-to-3p11/index')}/> diff --git a/platform/docs/docusaurus.config.js b/platform/docs/docusaurus.config.js index 4932c566d..38332df7e 100644 --- a/platform/docs/docusaurus.config.js +++ b/platform/docs/docusaurus.config.js @@ -3,6 +3,11 @@ const fs = require('fs'); const versions = fs.readFileSync('../../version.txt', 'utf8').split('\n'); const ArchivedVersionsDropdownItems = [ + { + version: '3.10', + href: 'https://v3p10.docs.ohif.org', + isExternal: true, + }, { version: '3.9', href: 'https://v3p9.docs.ohif.org', diff --git a/platform/docs/versioned_docs/version-3.10/development/link.md b/platform/docs/versioned_docs/version-3.10/development/link.md deleted file mode 100644 index 5d8882fd1..000000000 --- a/platform/docs/versioned_docs/version-3.10/development/link.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 9 -sidebar_label: Local Linking ---- - -# Introduction - -Local linking allows you to develop and test a library in the context of an application before it's published or when you encounter -a bug that you suspect is related to a library. With Yarn, this can be achieved through the yarn link command. - -You can take a look at the Cornerstonejs tutorial for linking https://www.cornerstonejs.org/docs/contribute/linking diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/index.md b/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/index.md deleted file mode 100644 index b72e7aa44..000000000 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 -sidebar_label: 3.9 -> 3.10 ---- - -# Migration Guide - - -## General diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/Measurements.md b/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/Measurements.md deleted file mode 100644 index 7d8a69801..000000000 --- a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/Measurements.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Measurements ---- - - - -import { measurementsCustomizations, TableGenerator } from './sampleCustomizations'; - -{TableGenerator(measurementsCustomizations)} diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/Segmentation.md b/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/Segmentation.md deleted file mode 100644 index 7953b39b3..000000000 --- a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/Segmentation.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Segmentation ---- - - - -import { segmentationCustomizations, TableGenerator } from './sampleCustomizations'; - -{TableGenerator(segmentationCustomizations)} diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/StudyBrowser.md b/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/StudyBrowser.md deleted file mode 100644 index fbbf3830e..000000000 --- a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/StudyBrowser.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Study Browser ---- - -# Study Browser - -The Study Browser is a component that allows users to browse and manage studies. - -import { studyBrowserCustomizations, TableGenerator } from './sampleCustomizations'; - -{TableGenerator(studyBrowserCustomizations)} diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/MultiMonitorService.md b/platform/docs/versioned_docs/version-3.10/platform/services/data/MultiMonitorService.md deleted file mode 100644 index eb74d28af..000000000 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/MultiMonitorService.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -sidebar_position: 5 -sidebar_label: Multi Monitor Service ---- - - -# Multi Monitor Service - -::: info - -We plan to enhance this service in the future. Currently, it offers a basic implementation of multi-monitor support, allowing you to manually open multiple windows on the same monitor. It is not yet a full multi-monitor solution! - -::: - - - - -The multi-monitor service provides detection, launch and communication support -for multiple monitors or windows/screens within a single monitor. - -:::info - -The multi-monitor service is currently applied via configuration file. - -```js -customizationService: ['@ohif/extension-default.customizationModule.multimonitor'], -``` - -::: - - - -## Configurations -The service supports two predefined configurations: - -1. **Split Screen (`multimonitor=split`)** - Splits the primary monitor into two windows. - -2. **Multi-Monitor (`multimonitor=2`)** - Opens windows across separate physical monitors. - -### Launch Methods -- Specify `&screenNumber=0` to designate the first window explicitly. -- Omit `screenNumber` to let the service handle window assignments dynamically. -- Use `launchAll` in the query parameters to launch all configured screens simultaneously. - -#### Example URLs: -- **Split Screen:** - `http://viewer.ohif.org/.....&multimonitor=split` - Splits the primary monitor into two windows when a study is viewed. - -- **Multi-Monitor with All Screens:** - `http://viewer.ohif.org/.....&multimonitor=2&screenNumber=0&launchAll` - Launches two monitors and opens all configured screens. - ---- - -## Behavior - -### Refresh, Close and Open -If you refresh the base/original window, then all the other windows will also -refresh. However, you can safely refresh any single other window, and on the next -command to the other windows, it will re-create the other window links without -losing content in the other windows. You can also close any other window and -it will be reopened the next time you try to call to it. - - -## Executing Commands -The MultiMonitorService adds the ability to run commands on other specified windows. -This allows opening up a study on another window without needing to refresh -it's contents. The command below shows an example of how this can be done: diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/ui/cine-service.md b/platform/docs/versioned_docs/version-3.10/platform/services/ui/cine-service.md deleted file mode 100644 index 707b5d97f..000000000 --- a/platform/docs/versioned_docs/version-3.10/platform/services/ui/cine-service.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -sidebar_position: 7 -sidebar_label: CINE Service ---- - -# CINE Service - -TODO... diff --git a/platform/docs/versioned_docs/version-3.10/README.md b/platform/docs/versioned_docs/version-3.11/README.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/README.md rename to platform/docs/versioned_docs/version-3.11/README.md diff --git a/platform/docs/versioned_docs/version-3.10/assets/designs/architecture-diagram b/platform/docs/versioned_docs/version-3.11/assets/designs/architecture-diagram similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/designs/architecture-diagram rename to platform/docs/versioned_docs/version-3.11/assets/designs/architecture-diagram diff --git a/platform/docs/versioned_docs/version-3.10/assets/designs/canny-full.fig b/platform/docs/versioned_docs/version-3.11/assets/designs/canny-full.fig similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/designs/canny-full.fig rename to platform/docs/versioned_docs/version-3.11/assets/designs/canny-full.fig diff --git a/platform/docs/versioned_docs/version-3.10/assets/designs/cloud.svg b/platform/docs/versioned_docs/version-3.11/assets/designs/cloud.svg similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/designs/cloud.svg rename to platform/docs/versioned_docs/version-3.11/assets/designs/cloud.svg diff --git a/platform/docs/versioned_docs/version-3.10/assets/designs/embedded-viewer-diagram b/platform/docs/versioned_docs/version-3.11/assets/designs/embedded-viewer-diagram similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/designs/embedded-viewer-diagram rename to platform/docs/versioned_docs/version-3.11/assets/designs/embedded-viewer-diagram diff --git a/platform/docs/versioned_docs/version-3.10/assets/designs/nginx-image-archive.fig b/platform/docs/versioned_docs/version-3.11/assets/designs/nginx-image-archive.fig similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/designs/nginx-image-archive.fig rename to platform/docs/versioned_docs/version-3.11/assets/designs/nginx-image-archive.fig diff --git a/platform/docs/versioned_docs/version-3.10/assets/designs/npm-logo-red.svg b/platform/docs/versioned_docs/version-3.11/assets/designs/npm-logo-red.svg similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/designs/npm-logo-red.svg rename to platform/docs/versioned_docs/version-3.11/assets/designs/npm-logo-red.svg diff --git a/platform/docs/versioned_docs/version-3.10/assets/designs/scope-of-project.fig b/platform/docs/versioned_docs/version-3.11/assets/designs/scope-of-project.fig similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/designs/scope-of-project.fig rename to platform/docs/versioned_docs/version-3.11/assets/designs/scope-of-project.fig diff --git a/platform/docs/versioned_docs/version-3.10/assets/designs/user-access-control-request-flow.fig b/platform/docs/versioned_docs/version-3.11/assets/designs/user-access-control-request-flow.fig similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/designs/user-access-control-request-flow.fig rename to platform/docs/versioned_docs/version-3.11/assets/designs/user-access-control-request-flow.fig diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/Loading-Indicator.png b/platform/docs/versioned_docs/version-3.11/assets/img/Loading-Indicator.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/Loading-Indicator.png rename to platform/docs/versioned_docs/version-3.11/assets/img/Loading-Indicator.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/OHIF-e2e-test-studies.png b/platform/docs/versioned_docs/version-3.11/assets/img/OHIF-e2e-test-studies.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/OHIF-e2e-test-studies.png rename to platform/docs/versioned_docs/version-3.11/assets/img/OHIF-e2e-test-studies.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/SR-exported.png b/platform/docs/versioned_docs/version-3.11/assets/img/SR-exported.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/SR-exported.png rename to platform/docs/versioned_docs/version-3.11/assets/img/SR-exported.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/WORKFLOW_DEPLOY.png b/platform/docs/versioned_docs/version-3.11/assets/img/WORKFLOW_DEPLOY.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/WORKFLOW_DEPLOY.png rename to platform/docs/versioned_docs/version-3.11/assets/img/WORKFLOW_DEPLOY.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/WORKFLOW_PR_CHECKS.png b/platform/docs/versioned_docs/version-3.11/assets/img/WORKFLOW_PR_CHECKS.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/WORKFLOW_PR_CHECKS.png rename to platform/docs/versioned_docs/version-3.11/assets/img/WORKFLOW_PR_CHECKS.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH.png b/platform/docs/versioned_docs/version-3.11/assets/img/WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH.png rename to platform/docs/versioned_docs/version-3.11/assets/img/WORKFLOW_PR_OPTIONAL_DOCKER_PUBLISH.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/WORKFLOW_RELEASE.png b/platform/docs/versioned_docs/version-3.11/assets/img/WORKFLOW_RELEASE.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/WORKFLOW_RELEASE.png rename to platform/docs/versioned_docs/version-3.11/assets/img/WORKFLOW_RELEASE.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/aboutModal.png b/platform/docs/versioned_docs/version-3.11/assets/img/aboutModal.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/aboutModal.png rename to platform/docs/versioned_docs/version-3.11/assets/img/aboutModal.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/add-extension.png b/platform/docs/versioned_docs/version-3.11/assets/img/add-extension.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/add-extension.png rename to platform/docs/versioned_docs/version-3.11/assets/img/add-extension.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/add-mode.png b/platform/docs/versioned_docs/version-3.11/assets/img/add-mode.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/add-mode.png rename to platform/docs/versioned_docs/version-3.11/assets/img/add-mode.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure1.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure1.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure1.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure1.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure10.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure10.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure10.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure10.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure2.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure2.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure2.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure2.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure3.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure3.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure3.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure3.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure4.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure4.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure4.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure4.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure5.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure5.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure5.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure5.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure6.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure6.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure6.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure6.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure7.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure7.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure7.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure7.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure8.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure8.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure8.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure8.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/azure9.png b/platform/docs/versioned_docs/version-3.11/assets/img/azure9.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/azure9.png rename to platform/docs/versioned_docs/version-3.11/assets/img/azure9.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/browser-console-non-secure-context.png b/platform/docs/versioned_docs/version-3.11/assets/img/browser-console-non-secure-context.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/browser-console-non-secure-context.png rename to platform/docs/versioned_docs/version-3.11/assets/img/browser-console-non-secure-context.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/captureViewportModal.png b/platform/docs/versioned_docs/version-3.11/assets/img/captureViewportModal.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/captureViewportModal.png rename to platform/docs/versioned_docs/version-3.11/assets/img/captureViewportModal.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/cli-search-no-verbose.png b/platform/docs/versioned_docs/version-3.11/assets/img/cli-search-no-verbose.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/cli-search-no-verbose.png rename to platform/docs/versioned_docs/version-3.11/assets/img/cli-search-no-verbose.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/cli-search-with-verbose.png b/platform/docs/versioned_docs/version-3.11/assets/img/cli-search-with-verbose.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/cli-search-with-verbose.png rename to platform/docs/versioned_docs/version-3.11/assets/img/cli-search-with-verbose.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/clock-mode.png b/platform/docs/versioned_docs/version-3.11/assets/img/clock-mode.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/clock-mode.png rename to platform/docs/versioned_docs/version-3.11/assets/img/clock-mode.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/clock-mode1.png b/platform/docs/versioned_docs/version-3.11/assets/img/clock-mode1.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/clock-mode1.png rename to platform/docs/versioned_docs/version-3.11/assets/img/clock-mode1.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/colorbarImage.png b/platform/docs/versioned_docs/version-3.11/assets/img/colorbarImage.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/colorbarImage.png rename to platform/docs/versioned_docs/version-3.11/assets/img/colorbarImage.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/context-menu.jpg b/platform/docs/versioned_docs/version-3.11/assets/img/context-menu.jpg similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/context-menu.jpg rename to platform/docs/versioned_docs/version-3.11/assets/img/context-menu.jpg diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/cornerstone-tools-link.gif b/platform/docs/versioned_docs/version-3.11/assets/img/cornerstone-tools-link.gif similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/cornerstone-tools-link.gif rename to platform/docs/versioned_docs/version-3.11/assets/img/cornerstone-tools-link.gif diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/cors-browser-console-errors.png b/platform/docs/versioned_docs/version-3.11/assets/img/cors-browser-console-errors.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/cors-browser-console-errors.png rename to platform/docs/versioned_docs/version-3.11/assets/img/cors-browser-console-errors.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/cors-network-panel-errors.png b/platform/docs/versioned_docs/version-3.11/assets/img/cors-network-panel-errors.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/cors-network-panel-errors.png rename to platform/docs/versioned_docs/version-3.11/assets/img/cors-network-panel-errors.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/create-extension.png b/platform/docs/versioned_docs/version-3.11/assets/img/create-extension.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/create-extension.png rename to platform/docs/versioned_docs/version-3.11/assets/img/create-extension.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/create-mode.png b/platform/docs/versioned_docs/version-3.11/assets/img/create-mode.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/create-mode.png rename to platform/docs/versioned_docs/version-3.11/assets/img/create-mode.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/custom-logo.png b/platform/docs/versioned_docs/version-3.11/assets/img/custom-logo.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/custom-logo.png rename to platform/docs/versioned_docs/version-3.11/assets/img/custom-logo.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/customizable-overlay.jpeg b/platform/docs/versioned_docs/version-3.11/assets/img/customizable-overlay.jpeg similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/customizable-overlay.jpeg rename to platform/docs/versioned_docs/version-3.11/assets/img/customizable-overlay.jpeg diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/data-source-configuration-ui.png b/platform/docs/versioned_docs/version-3.11/assets/img/data-source-configuration-ui.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/data-source-configuration-ui.png rename to platform/docs/versioned_docs/version-3.11/assets/img/data-source-configuration-ui.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/dcm4chee-upload.gif b/platform/docs/versioned_docs/version-3.11/assets/img/dcm4chee-upload.gif similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/dcm4chee-upload.gif rename to platform/docs/versioned_docs/version-3.11/assets/img/dcm4chee-upload.gif diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/demo-4d.webp b/platform/docs/versioned_docs/version-3.11/assets/img/demo-4d.webp similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/demo-4d.webp rename to platform/docs/versioned_docs/version-3.11/assets/img/demo-4d.webp diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/demo-measurements.webp b/platform/docs/versioned_docs/version-3.11/assets/img/demo-measurements.webp similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/demo-measurements.webp rename to platform/docs/versioned_docs/version-3.11/assets/img/demo-measurements.webp diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/demo-pdf.webp b/platform/docs/versioned_docs/version-3.11/assets/img/demo-pdf.webp similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/demo-pdf.webp rename to platform/docs/versioned_docs/version-3.11/assets/img/demo-pdf.webp diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/demo-ptct.webp b/platform/docs/versioned_docs/version-3.11/assets/img/demo-ptct.webp similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/demo-ptct.webp rename to platform/docs/versioned_docs/version-3.11/assets/img/demo-ptct.webp diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/demo-rtstruct.webp b/platform/docs/versioned_docs/version-3.11/assets/img/demo-rtstruct.webp similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/demo-rtstruct.webp rename to platform/docs/versioned_docs/version-3.11/assets/img/demo-rtstruct.webp diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/demo-segmentation.webp b/platform/docs/versioned_docs/version-3.11/assets/img/demo-segmentation.webp similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/demo-segmentation.webp rename to platform/docs/versioned_docs/version-3.11/assets/img/demo-segmentation.webp diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/demo-video.webp b/platform/docs/versioned_docs/version-3.11/assets/img/demo-video.webp similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/demo-video.webp rename to platform/docs/versioned_docs/version-3.11/assets/img/demo-video.webp diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/demo-volume-rendering.webp b/platform/docs/versioned_docs/version-3.11/assets/img/demo-volume-rendering.webp similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/demo-volume-rendering.webp rename to platform/docs/versioned_docs/version-3.11/assets/img/demo-volume-rendering.webp diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/demo-volumeRendering.png b/platform/docs/versioned_docs/version-3.11/assets/img/demo-volumeRendering.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/demo-volumeRendering.png rename to platform/docs/versioned_docs/version-3.11/assets/img/demo-volumeRendering.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/dicom-json-public.png b/platform/docs/versioned_docs/version-3.11/assets/img/dicom-json-public.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/dicom-json-public.png rename to platform/docs/versioned_docs/version-3.11/assets/img/dicom-json-public.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/dicom-json.png b/platform/docs/versioned_docs/version-3.11/assets/img/dicom-json.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/dicom-json.png rename to platform/docs/versioned_docs/version-3.11/assets/img/dicom-json.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/docker-pacs.png b/platform/docs/versioned_docs/version-3.11/assets/img/docker-pacs.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/docker-pacs.png rename to platform/docs/versioned_docs/version-3.11/assets/img/docker-pacs.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/e2e-cypress-final.png b/platform/docs/versioned_docs/version-3.11/assets/img/e2e-cypress-final.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/e2e-cypress-final.png rename to platform/docs/versioned_docs/version-3.11/assets/img/e2e-cypress-final.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/e2e-cypress.png b/platform/docs/versioned_docs/version-3.11/assets/img/e2e-cypress.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/e2e-cypress.png rename to platform/docs/versioned_docs/version-3.11/assets/img/e2e-cypress.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/embedded-viewer-diagram.png b/platform/docs/versioned_docs/version-3.11/assets/img/embedded-viewer-diagram.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/embedded-viewer-diagram.png rename to platform/docs/versioned_docs/version-3.11/assets/img/embedded-viewer-diagram.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/filtering-worklist.png b/platform/docs/versioned_docs/version-3.11/assets/img/filtering-worklist.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/filtering-worklist.png rename to platform/docs/versioned_docs/version-3.11/assets/img/filtering-worklist.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/github-readme-branches-Jun2024.png b/platform/docs/versioned_docs/version-3.11/assets/img/github-readme-branches-Jun2024.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/github-readme-branches-Jun2024.png rename to platform/docs/versioned_docs/version-3.11/assets/img/github-readme-branches-Jun2024.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/google-create-credentials.png b/platform/docs/versioned_docs/version-3.11/assets/img/google-create-credentials.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/google-create-credentials.png rename to platform/docs/versioned_docs/version-3.11/assets/img/google-create-credentials.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/google-enable-apis.png b/platform/docs/versioned_docs/version-3.11/assets/img/google-enable-apis.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/google-enable-apis.png rename to platform/docs/versioned_docs/version-3.11/assets/img/google-enable-apis.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/google-healthcare-service-agent-warning.png b/platform/docs/versioned_docs/version-3.11/assets/img/google-healthcare-service-agent-warning.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/google-healthcare-service-agent-warning.png rename to platform/docs/versioned_docs/version-3.11/assets/img/google-healthcare-service-agent-warning.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/google-manually-add-scopes.png b/platform/docs/versioned_docs/version-3.11/assets/img/google-manually-add-scopes.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/google-manually-add-scopes.png rename to platform/docs/versioned_docs/version-3.11/assets/img/google-manually-add-scopes.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/google-oauth-consent-steps.png b/platform/docs/versioned_docs/version-3.11/assets/img/google-oauth-consent-steps.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/google-oauth-consent-steps.png rename to platform/docs/versioned_docs/version-3.11/assets/img/google-oauth-consent-steps.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/google-projects-drop-down.png b/platform/docs/versioned_docs/version-3.11/assets/img/google-projects-drop-down.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/google-projects-drop-down.png rename to platform/docs/versioned_docs/version-3.11/assets/img/google-projects-drop-down.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/google-provided-accounts-checkbox.png b/platform/docs/versioned_docs/version-3.11/assets/img/google-provided-accounts-checkbox.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/google-provided-accounts-checkbox.png rename to platform/docs/versioned_docs/version-3.11/assets/img/google-provided-accounts-checkbox.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/hangingProtocolExample.png b/platform/docs/versioned_docs/version-3.11/assets/img/hangingProtocolExample.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/hangingProtocolExample.png rename to platform/docs/versioned_docs/version-3.11/assets/img/hangingProtocolExample.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/iframe-basic.png b/platform/docs/versioned_docs/version-3.11/assets/img/iframe-basic.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/iframe-basic.png rename to platform/docs/versioned_docs/version-3.11/assets/img/iframe-basic.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/iframe-headers.png b/platform/docs/versioned_docs/version-3.11/assets/img/iframe-headers.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/iframe-headers.png rename to platform/docs/versioned_docs/version-3.11/assets/img/iframe-headers.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/jwt-explained.png b/platform/docs/versioned_docs/version-3.11/assets/img/jwt-explained.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/jwt-explained.png rename to platform/docs/versioned_docs/version-3.11/assets/img/jwt-explained.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/keycloak-default-theme.png b/platform/docs/versioned_docs/version-3.11/assets/img/keycloak-default-theme.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/keycloak-default-theme.png rename to platform/docs/versioned_docs/version-3.11/assets/img/keycloak-default-theme.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/keycloak-ohif-theme.png b/platform/docs/versioned_docs/version-3.11/assets/img/keycloak-ohif-theme.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/keycloak-ohif-theme.png rename to platform/docs/versioned_docs/version-3.11/assets/img/keycloak-ohif-theme.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/labelling-flow.png b/platform/docs/versioned_docs/version-3.11/assets/img/labelling-flow.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/labelling-flow.png rename to platform/docs/versioned_docs/version-3.11/assets/img/labelling-flow.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/large-pt-ct.jpeg b/platform/docs/versioned_docs/version-3.11/assets/img/large-pt-ct.jpeg similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/large-pt-ct.jpeg rename to platform/docs/versioned_docs/version-3.11/assets/img/large-pt-ct.jpeg diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/layoutSelectorAdvancedPresetGeneratorImage.png b/platform/docs/versioned_docs/version-3.11/assets/img/layoutSelectorAdvancedPresetGeneratorImage.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/layoutSelectorAdvancedPresetGeneratorImage.png rename to platform/docs/versioned_docs/version-3.11/assets/img/layoutSelectorAdvancedPresetGeneratorImage.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/layoutSelectorCommonPresetsImage.png b/platform/docs/versioned_docs/version-3.11/assets/img/layoutSelectorCommonPresetsImage.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/layoutSelectorCommonPresetsImage.png rename to platform/docs/versioned_docs/version-3.11/assets/img/layoutSelectorCommonPresetsImage.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/loading-indicator-icon.png b/platform/docs/versioned_docs/version-3.11/assets/img/loading-indicator-icon.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/loading-indicator-icon.png rename to platform/docs/versioned_docs/version-3.11/assets/img/loading-indicator-icon.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/loading-indicator-percent.png b/platform/docs/versioned_docs/version-3.11/assets/img/loading-indicator-percent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/loading-indicator-percent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/loading-indicator-percent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/locizeSponsor.svg b/platform/docs/versioned_docs/version-3.11/assets/img/locizeSponsor.svg similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/locizeSponsor.svg rename to platform/docs/versioned_docs/version-3.11/assets/img/locizeSponsor.svg diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/locked-sr.png b/platform/docs/versioned_docs/version-3.11/assets/img/locked-sr.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/locked-sr.png rename to platform/docs/versioned_docs/version-3.11/assets/img/locked-sr.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/measurement-labels-auto.png b/platform/docs/versioned_docs/version-3.11/assets/img/measurement-labels-auto.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/measurement-labels-auto.png rename to platform/docs/versioned_docs/version-3.11/assets/img/measurement-labels-auto.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/measurement-panel-1.png b/platform/docs/versioned_docs/version-3.11/assets/img/measurement-panel-1.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/measurement-panel-1.png rename to platform/docs/versioned_docs/version-3.11/assets/img/measurement-panel-1.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/measurement-panel-prompt.png b/platform/docs/versioned_docs/version-3.11/assets/img/measurement-panel-prompt.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/measurement-panel-prompt.png rename to platform/docs/versioned_docs/version-3.11/assets/img/measurement-panel-prompt.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/measurement-panel-tracked.png b/platform/docs/versioned_docs/version-3.11/assets/img/measurement-panel-tracked.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/measurement-panel-tracked.png rename to platform/docs/versioned_docs/version-3.11/assets/img/measurement-panel-tracked.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/measurement-temporary.png b/platform/docs/versioned_docs/version-3.11/assets/img/measurement-temporary.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/measurement-temporary.png rename to platform/docs/versioned_docs/version-3.11/assets/img/measurement-temporary.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/measurements-prevNext.png b/platform/docs/versioned_docs/version-3.11/assets/img/measurements-prevNext.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/measurements-prevNext.png rename to platform/docs/versioned_docs/version-3.11/assets/img/measurements-prevNext.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/memory-profiling-regular.png b/platform/docs/versioned_docs/version-3.11/assets/img/memory-profiling-regular.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/memory-profiling-regular.png rename to platform/docs/versioned_docs/version-3.11/assets/img/memory-profiling-regular.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/microscopy.webp b/platform/docs/versioned_docs/version-3.11/assets/img/microscopy.webp similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/microscopy.webp rename to platform/docs/versioned_docs/version-3.11/assets/img/microscopy.webp diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/migration-modes.png b/platform/docs/versioned_docs/version-3.11/assets/img/migration-modes.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/migration-modes.png rename to platform/docs/versioned_docs/version-3.11/assets/img/migration-modes.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/migration-split-button.png b/platform/docs/versioned_docs/version-3.11/assets/img/migration-split-button.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/migration-split-button.png rename to platform/docs/versioned_docs/version-3.11/assets/img/migration-split-button.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/mode-archs.png b/platform/docs/versioned_docs/version-3.11/assets/img/mode-archs.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/mode-archs.png rename to platform/docs/versioned_docs/version-3.11/assets/img/mode-archs.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/mode-clock.png b/platform/docs/versioned_docs/version-3.11/assets/img/mode-clock.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/mode-clock.png rename to platform/docs/versioned_docs/version-3.11/assets/img/mode-clock.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/mode-template.png b/platform/docs/versioned_docs/version-3.11/assets/img/mode-template.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/mode-template.png rename to platform/docs/versioned_docs/version-3.11/assets/img/mode-template.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/nginx-image-archive.png b/platform/docs/versioned_docs/version-3.11/assets/img/nginx-image-archive.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/nginx-image-archive.png rename to platform/docs/versioned_docs/version-3.11/assets/img/nginx-image-archive.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/ohif-cli-list.png b/platform/docs/versioned_docs/version-3.11/assets/img/ohif-cli-list.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/ohif-cli-list.png rename to platform/docs/versioned_docs/version-3.11/assets/img/ohif-cli-list.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/ohif-non-secure-context.png b/platform/docs/versioned_docs/version-3.11/assets/img/ohif-non-secure-context.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/ohif-non-secure-context.png rename to platform/docs/versioned_docs/version-3.11/assets/img/ohif-non-secure-context.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/ohif-pacs-keycloak.png b/platform/docs/versioned_docs/version-3.11/assets/img/ohif-pacs-keycloak.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/ohif-pacs-keycloak.png rename to platform/docs/versioned_docs/version-3.11/assets/img/ohif-pacs-keycloak.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/open-graph.png b/platform/docs/versioned_docs/version-3.11/assets/img/open-graph.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/open-graph.png rename to platform/docs/versioned_docs/version-3.11/assets/img/open-graph.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/overview.png b/platform/docs/versioned_docs/version-3.11/assets/img/overview.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/overview.png rename to platform/docs/versioned_docs/version-3.11/assets/img/overview.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/panel-module-left-right.png b/platform/docs/versioned_docs/version-3.11/assets/img/panel-module-left-right.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/panel-module-left-right.png rename to platform/docs/versioned_docs/version-3.11/assets/img/panel-module-left-right.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/panel-module-v3.png b/platform/docs/versioned_docs/version-3.11/assets/img/panel-module-v3.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/panel-module-v3.png rename to platform/docs/versioned_docs/version-3.11/assets/img/panel-module-v3.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/panelmodule-icon.png b/platform/docs/versioned_docs/version-3.11/assets/img/panelmodule-icon.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/panelmodule-icon.png rename to platform/docs/versioned_docs/version-3.11/assets/img/panelmodule-icon.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/preferSizeOverAccuracy.png b/platform/docs/versioned_docs/version-3.11/assets/img/preferSizeOverAccuracy.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/preferSizeOverAccuracy.png rename to platform/docs/versioned_docs/version-3.11/assets/img/preferSizeOverAccuracy.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/progressDropdown.png b/platform/docs/versioned_docs/version-3.11/assets/img/progressDropdown.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/progressDropdown.png rename to platform/docs/versioned_docs/version-3.11/assets/img/progressDropdown.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/promptAddSeriesContent.png b/platform/docs/versioned_docs/version-3.11/assets/img/promptAddSeriesContent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/promptAddSeriesContent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/promptAddSeriesContent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/promptBeginTrackingContent.png b/platform/docs/versioned_docs/version-3.11/assets/img/promptBeginTrackingContent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/promptBeginTrackingContent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/promptBeginTrackingContent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/promptDiscardDirtyContent.png b/platform/docs/versioned_docs/version-3.11/assets/img/promptDiscardDirtyContent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/promptDiscardDirtyContent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/promptDiscardDirtyContent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/promptDiscardSeriesContent.png b/platform/docs/versioned_docs/version-3.11/assets/img/promptDiscardSeriesContent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/promptDiscardSeriesContent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/promptDiscardSeriesContent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/promptDiscardStudyContent.png b/platform/docs/versioned_docs/version-3.11/assets/img/promptDiscardStudyContent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/promptDiscardStudyContent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/promptDiscardStudyContent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/promptRtstructContent.png b/platform/docs/versioned_docs/version-3.11/assets/img/promptRtstructContent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/promptRtstructContent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/promptRtstructContent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/promptSRTrackingContent.png b/platform/docs/versioned_docs/version-3.11/assets/img/promptSRTrackingContent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/promptSRTrackingContent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/promptSRTrackingContent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/promptTrackStudyContent.png b/platform/docs/versioned_docs/version-3.11/assets/img/promptTrackStudyContent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/promptTrackStudyContent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/promptTrackStudyContent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/promptsegmentationContent.png b/platform/docs/versioned_docs/version-3.11/assets/img/promptsegmentationContent.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/promptsegmentationContent.png rename to platform/docs/versioned_docs/version-3.11/assets/img/promptsegmentationContent.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/reference-lines-from-start.png b/platform/docs/versioned_docs/version-3.11/assets/img/reference-lines-from-start.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/reference-lines-from-start.png rename to platform/docs/versioned_docs/version-3.11/assets/img/reference-lines-from-start.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/restore-exported-sr.png b/platform/docs/versioned_docs/version-3.11/assets/img/restore-exported-sr.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/restore-exported-sr.png rename to platform/docs/versioned_docs/version-3.11/assets/img/restore-exported-sr.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/scope-of-project.png b/platform/docs/versioned_docs/version-3.11/assets/img/scope-of-project.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/scope-of-project.png rename to platform/docs/versioned_docs/version-3.11/assets/img/scope-of-project.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/segDisplayEditingFalse.png b/platform/docs/versioned_docs/version-3.11/assets/img/segDisplayEditingFalse.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/segDisplayEditingFalse.png rename to platform/docs/versioned_docs/version-3.11/assets/img/segDisplayEditingFalse.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/segDisplayEditingTrue.png b/platform/docs/versioned_docs/version-3.11/assets/img/segDisplayEditingTrue.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/segDisplayEditingTrue.png rename to platform/docs/versioned_docs/version-3.11/assets/img/segDisplayEditingTrue.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/segmentation-overlay.png b/platform/docs/versioned_docs/version-3.11/assets/img/segmentation-overlay.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/segmentation-overlay.png rename to platform/docs/versioned_docs/version-3.11/assets/img/segmentation-overlay.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/segmentationShowAddSegmentImage.png b/platform/docs/versioned_docs/version-3.11/assets/img/segmentationShowAddSegmentImage.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/segmentationShowAddSegmentImage.png rename to platform/docs/versioned_docs/version-3.11/assets/img/segmentationShowAddSegmentImage.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/segmentationTableModeImage.png b/platform/docs/versioned_docs/version-3.11/assets/img/segmentationTableModeImage.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/segmentationTableModeImage.png rename to platform/docs/versioned_docs/version-3.11/assets/img/segmentationTableModeImage.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/segmentationTableModeImage2.png b/platform/docs/versioned_docs/version-3.11/assets/img/segmentationTableModeImage2.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/segmentationTableModeImage2.png rename to platform/docs/versioned_docs/version-3.11/assets/img/segmentationTableModeImage2.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/self-signed-cert-advanced-warning.png b/platform/docs/versioned_docs/version-3.11/assets/img/self-signed-cert-advanced-warning.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/self-signed-cert-advanced-warning.png rename to platform/docs/versioned_docs/version-3.11/assets/img/self-signed-cert-advanced-warning.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/self-signed-cert-warning.png b/platform/docs/versioned_docs/version-3.11/assets/img/self-signed-cert-warning.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/self-signed-cert-warning.png rename to platform/docs/versioned_docs/version-3.11/assets/img/self-signed-cert-warning.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/seriesSort.png b/platform/docs/versioned_docs/version-3.11/assets/img/seriesSort.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/seriesSort.png rename to platform/docs/versioned_docs/version-3.11/assets/img/seriesSort.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/services-data.png b/platform/docs/versioned_docs/version-3.11/assets/img/services-data.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/services-data.png rename to platform/docs/versioned_docs/version-3.11/assets/img/services-data.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/services-measurements.png b/platform/docs/versioned_docs/version-3.11/assets/img/services-measurements.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/services-measurements.png rename to platform/docs/versioned_docs/version-3.11/assets/img/services-measurements.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/services-ui.png b/platform/docs/versioned_docs/version-3.11/assets/img/services-ui.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/services-ui.png rename to platform/docs/versioned_docs/version-3.11/assets/img/services-ui.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/services.png b/platform/docs/versioned_docs/version-3.11/assets/img/services.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/services.png rename to platform/docs/versioned_docs/version-3.11/assets/img/services.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/static-dicom-web.png b/platform/docs/versioned_docs/version-3.11/assets/img/static-dicom-web.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/static-dicom-web.png rename to platform/docs/versioned_docs/version-3.11/assets/img/static-dicom-web.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/studyMenuItemsImage.png b/platform/docs/versioned_docs/version-3.11/assets/img/studyMenuItemsImage.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/studyMenuItemsImage.png rename to platform/docs/versioned_docs/version-3.11/assets/img/studyMenuItemsImage.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/surge-deploy.gif b/platform/docs/versioned_docs/version-3.11/assets/img/surge-deploy.gif similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/surge-deploy.gif rename to platform/docs/versioned_docs/version-3.11/assets/img/surge-deploy.gif diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/template-extension-files.png b/platform/docs/versioned_docs/version-3.11/assets/img/template-extension-files.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/template-extension-files.png rename to platform/docs/versioned_docs/version-3.11/assets/img/template-extension-files.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/template-mode-files.png b/platform/docs/versioned_docs/version-3.11/assets/img/template-mode-files.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/template-mode-files.png rename to platform/docs/versioned_docs/version-3.11/assets/img/template-mode-files.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/template-mode-ui.png b/platform/docs/versioned_docs/version-3.11/assets/img/template-mode-ui.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/template-mode-ui.png rename to platform/docs/versioned_docs/version-3.11/assets/img/template-mode-ui.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/thumbnailMenuItemsImage.png b/platform/docs/versioned_docs/version-3.11/assets/img/thumbnailMenuItemsImage.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/thumbnailMenuItemsImage.png rename to platform/docs/versioned_docs/version-3.11/assets/img/thumbnailMenuItemsImage.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/toolbar-module.png b/platform/docs/versioned_docs/version-3.11/assets/img/toolbar-module.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/toolbar-module.png rename to platform/docs/versioned_docs/version-3.11/assets/img/toolbar-module.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/toolbarModule-layout.png b/platform/docs/versioned_docs/version-3.11/assets/img/toolbarModule-layout.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/toolbarModule-layout.png rename to platform/docs/versioned_docs/version-3.11/assets/img/toolbarModule-layout.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/toolbarModule-nested-buttons.png b/platform/docs/versioned_docs/version-3.11/assets/img/toolbarModule-nested-buttons.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/toolbarModule-nested-buttons.png rename to platform/docs/versioned_docs/version-3.11/assets/img/toolbarModule-nested-buttons.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/toolbarModule-zoom.png b/platform/docs/versioned_docs/version-3.11/assets/img/toolbarModule-zoom.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/toolbarModule-zoom.png rename to platform/docs/versioned_docs/version-3.11/assets/img/toolbarModule-zoom.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/toolbox-modal.png b/platform/docs/versioned_docs/version-3.11/assets/img/toolbox-modal.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/toolbox-modal.png rename to platform/docs/versioned_docs/version-3.11/assets/img/toolbox-modal.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/tracked-not-tracked.png b/platform/docs/versioned_docs/version-3.11/assets/img/tracked-not-tracked.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/tracked-not-tracked.png rename to platform/docs/versioned_docs/version-3.11/assets/img/tracked-not-tracked.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/tracking-workflow1.png b/platform/docs/versioned_docs/version-3.11/assets/img/tracking-workflow1.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/tracking-workflow1.png rename to platform/docs/versioned_docs/version-3.11/assets/img/tracking-workflow1.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/tracking-workflow2.png b/platform/docs/versioned_docs/version-3.11/assets/img/tracking-workflow2.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/tracking-workflow2.png rename to platform/docs/versioned_docs/version-3.11/assets/img/tracking-workflow2.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/tracking-workflow3.png b/platform/docs/versioned_docs/version-3.11/assets/img/tracking-workflow3.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/tracking-workflow3.png rename to platform/docs/versioned_docs/version-3.11/assets/img/tracking-workflow3.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/ui-modal.gif b/platform/docs/versioned_docs/version-3.11/assets/img/ui-modal.gif similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/ui-modal.gif rename to platform/docs/versioned_docs/version-3.11/assets/img/ui-modal.gif diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/ui-services.png b/platform/docs/versioned_docs/version-3.11/assets/img/ui-services.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/ui-services.png rename to platform/docs/versioned_docs/version-3.11/assets/img/ui-services.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/uploader.gif b/platform/docs/versioned_docs/version-3.11/assets/img/uploader.gif similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/uploader.gif rename to platform/docs/versioned_docs/version-3.11/assets/img/uploader.gif diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-access-control-request-flow.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-access-control-request-flow.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-access-control-request-flow.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-access-control-request-flow.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-hotkeys-default.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-hotkeys-default.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-hotkeys-default.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-hotkeys-default.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-hotkeys.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-hotkeys.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-hotkeys.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-hotkeys.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-measurement-export.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-measurement-export.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-measurement-export.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-measurement-export.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-open-viewer.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-open-viewer.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-open-viewer.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-open-viewer.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-study-filter.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-study-filter.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-study-filter.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-study-filter.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-study-list.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-study-list.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-study-list.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-study-list.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-study-next.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-study-next.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-study-next.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-study-next.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-study-panel.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-study-panel.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-study-panel.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-study-panel.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-study-summary.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-study-summary.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-study-summary.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-study-summary.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-studyist-modespecific.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-studyist-modespecific.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-studyist-modespecific.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-studyist-modespecific.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-toolbar-download-icon.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-toolbar-download-icon.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-toolbar-download-icon.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-toolbar-download-icon.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-toolbar-extra.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-toolbar-extra.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-toolbar-extra.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-toolbar-extra.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-toolbar-preset.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-toolbar-preset.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-toolbar-preset.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-toolbar-preset.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-toolbarDownload.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-toolbarDownload.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-toolbarDownload.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-toolbarDownload.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-viewer-layout.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-viewer-layout.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-viewer-layout.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-viewer-layout.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-viewer-main.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-viewer-main.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-viewer-main.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-viewer-main.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-viewer-toolbar-measurements.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-viewer-toolbar-measurements.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-viewer-toolbar-measurements.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-viewer-toolbar-measurements.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-viewer-toolbar.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-viewer-toolbar.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-viewer-toolbar.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-viewer-toolbar.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/user-viewer.png b/platform/docs/versioned_docs/version-3.11/assets/img/user-viewer.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/user-viewer.png rename to platform/docs/versioned_docs/version-3.11/assets/img/user-viewer.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/viewport-action-corners.png b/platform/docs/versioned_docs/version-3.11/assets/img/viewport-action-corners.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/viewport-action-corners.png rename to platform/docs/versioned_docs/version-3.11/assets/img/viewport-action-corners.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/viewport-download-warning.png b/platform/docs/versioned_docs/version-3.11/assets/img/viewport-download-warning.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/viewport-download-warning.png rename to platform/docs/versioned_docs/version-3.11/assets/img/viewport-download-warning.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/viewport-notification.png b/platform/docs/versioned_docs/version-3.11/assets/img/viewport-notification.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/viewport-notification.png rename to platform/docs/versioned_docs/version-3.11/assets/img/viewport-notification.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/viewportModule-layout.png b/platform/docs/versioned_docs/version-3.11/assets/img/viewportModule-layout.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/viewportModule-layout.png rename to platform/docs/versioned_docs/version-3.11/assets/img/viewportModule-layout.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/viewportModule.png b/platform/docs/versioned_docs/version-3.11/assets/img/viewportModule.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/viewportModule.png rename to platform/docs/versioned_docs/version-3.11/assets/img/viewportModule.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/viewportOverlay-customization.png b/platform/docs/versioned_docs/version-3.11/assets/img/viewportOverlay-customization.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/viewportOverlay-customization.png rename to platform/docs/versioned_docs/version-3.11/assets/img/viewportOverlay-customization.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/webgl-int16.png b/platform/docs/versioned_docs/version-3.11/assets/img/webgl-int16.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/webgl-int16.png rename to platform/docs/versioned_docs/version-3.11/assets/img/webgl-int16.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/webgl-report-norm16.png b/platform/docs/versioned_docs/version-3.11/assets/img/webgl-report-norm16.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/webgl-report-norm16.png rename to platform/docs/versioned_docs/version-3.11/assets/img/webgl-report-norm16.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/windowLevelActionMenu.png b/platform/docs/versioned_docs/version-3.11/assets/img/windowLevelActionMenu.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/windowLevelActionMenu.png rename to platform/docs/versioned_docs/version-3.11/assets/img/windowLevelActionMenu.png diff --git a/platform/docs/versioned_docs/version-3.10/assets/img/windowLevelPresets.png b/platform/docs/versioned_docs/version-3.11/assets/img/windowLevelPresets.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/assets/img/windowLevelPresets.png rename to platform/docs/versioned_docs/version-3.11/assets/img/windowLevelPresets.png diff --git a/platform/docs/versioned_docs/version-3.10/configuration/_category_.json b/platform/docs/versioned_docs/version-3.11/configuration/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/configuration/_category_.json rename to platform/docs/versioned_docs/version-3.11/configuration/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/configuration/configurationFiles.md b/platform/docs/versioned_docs/version-3.11/configuration/configurationFiles.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/configuration/configurationFiles.md rename to platform/docs/versioned_docs/version-3.11/configuration/configurationFiles.md index c02e2955d..0bdeb2765 100644 --- a/platform/docs/versioned_docs/version-3.10/configuration/configurationFiles.md +++ b/platform/docs/versioned_docs/version-3.11/configuration/configurationFiles.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Configuration Files +title: Configuration Files +summary: Comprehensive guide to configuring OHIF Viewer, including data sources, environment variables, advanced options like study prefetching, and detailed explanations of configuration parameters for performance optimization and feature customization. --- # Config files @@ -184,6 +186,7 @@ if auth headers are used, a preflight request is required. } ``` - `showLoadingIndicator`: (default to true), if set to false, the loading indicator will not be shown when navigating between studies. +- `showStudyList`: (default to false), if set to false, the OHIF search (or work list) page will not be shown nor will there be a back button (chevron) in the viewer to navigate to it - `useNorm16Texture`: (default to false), if set to true, it will use 16 bit data type for the image data wherever possible which has significant impact on reducing the memory usage. However, the 16Bit textures require EXT_texture_norm16 extension in webGL 2.0 (you can check if you have it here https://webglreport.com/?v=2). In addition to the extension, there are reported problems for Intel Macs that might cause the viewer to crash. In summary, it is great a configuration if you have support for it. - `useSharedArrayBuffer` (default to 'TRUE', options: 'AUTO', 'FALSE', 'TRUE', note that these are strings), for volume loading we use sharedArrayBuffer to be able to diff --git a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/_category_.json b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/configuration/dataSources/_category_.json rename to platform/docs/versioned_docs/version-3.11/configuration/dataSources/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/configuration-ui.md b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/configuration-ui.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/configuration/dataSources/configuration-ui.md rename to platform/docs/versioned_docs/version-3.11/configuration/dataSources/configuration-ui.md index 200fc167f..0b76d58fc 100644 --- a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/configuration-ui.md +++ b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/configuration-ui.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Configuration UI +title: Configuration UI +summary: Describes interfaces for implementing configurable data sources in OHIF, with details on BaseDataSourceConfigurationAPI and BaseDataSourceConfigurationAPIItem to enable generic UIs for hierarchical data source configuration. --- # Configuration UI diff --git a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/dicom-json.md b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/dicom-json.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/configuration/dataSources/dicom-json.md rename to platform/docs/versioned_docs/version-3.11/configuration/dataSources/dicom-json.md index 84e7be228..a183c47d1 100644 --- a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/dicom-json.md +++ b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/dicom-json.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: DICOM JSON +title: DICOM JSON +summary: Explains how to configure and use the DICOM JSON data source format in OHIF, including structure of the JSON file with study/series/instance metadata, implementation examples, and local deployment instructions. --- # DICOM JSON diff --git a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/dicom-web-proxy.md b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/dicom-web-proxy.md similarity index 88% rename from platform/docs/versioned_docs/version-3.10/configuration/dataSources/dicom-web-proxy.md rename to platform/docs/versioned_docs/version-3.11/configuration/dataSources/dicom-web-proxy.md index faeea85e6..8f96bc96d 100644 --- a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/dicom-web-proxy.md +++ b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/dicom-web-proxy.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: DICOMweb Proxy +title: DICOMweb Proxy +summary: Documents the DICOMweb Proxy data source which constructs a dynamic DICOMweb datasource from a configuration JSON file, allowing OHIF to delegate subsequent requests for metadata and images to the configured server. --- # DICOMweb Proxy diff --git a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/dicom-web.md b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/dicom-web.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/configuration/dataSources/dicom-web.md rename to platform/docs/versioned_docs/version-3.11/configuration/dataSources/dicom-web.md index 2707370fe..b04c11983 100644 --- a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/dicom-web.md +++ b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/dicom-web.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: DICOMweb +title: DICOMweb +summary: Comprehensive guide to configuring DICOMweb data sources in OHIF, including setting up local DICOM servers (Orthanc, DCM4CHEE), configurations for PDF, video, and bulkdata handling, and detailed instructions for development environments. --- # DICOMweb diff --git a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/introduction.md b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/introduction.md similarity index 76% rename from platform/docs/versioned_docs/version-3.10/configuration/dataSources/introduction.md rename to platform/docs/versioned_docs/version-3.11/configuration/dataSources/introduction.md index 2a0add515..e66c647ac 100644 --- a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/introduction.md +++ b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/introduction.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: Data Source Introduction +summary: Introduces OHIF's data structure based on naturalized DICOM JSON format, providing an overview of common data sources available in OHIF and how custom data sources can be implemented. --- # Data Source diff --git a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/static-files.md b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/static-files.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/configuration/dataSources/static-files.md rename to platform/docs/versioned_docs/version-3.11/configuration/dataSources/static-files.md index ec460db2b..7746935bf 100644 --- a/platform/docs/versioned_docs/version-3.10/configuration/dataSources/static-files.md +++ b/platform/docs/versioned_docs/version-3.11/configuration/dataSources/static-files.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Static Files +title: Static DICOMweb Files +summary: Details how to use the static-wado project to generate and serve optimized static DICOMweb files for enhanced OHIF Viewer performance, with step-by-step instructions for installation, file generation, and viewer configuration. --- diff --git a/platform/docs/versioned_docs/version-3.10/configuration/tour-demo.gif b/platform/docs/versioned_docs/version-3.11/configuration/tour-demo.gif similarity index 100% rename from platform/docs/versioned_docs/version-3.10/configuration/tour-demo.gif rename to platform/docs/versioned_docs/version-3.11/configuration/tour-demo.gif diff --git a/platform/docs/versioned_docs/version-3.10/configuration/tours.md b/platform/docs/versioned_docs/version-3.11/configuration/tours.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/configuration/tours.md rename to platform/docs/versioned_docs/version-3.11/configuration/tours.md index 340800053..2bcfb8329 100644 --- a/platform/docs/versioned_docs/version-3.10/configuration/tours.md +++ b/platform/docs/versioned_docs/version-3.11/configuration/tours.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Tours +title: Configuring Tours in OHIF +summary: Guide to implementing interactive guided tours in OHIF using Shepherd.js, including detailed configuration options, step definitions, customization parameters, and examples for creating effective user onboarding experiences. --- # Configuring Tours in OHIF with Shepherd.js diff --git a/platform/docs/versioned_docs/version-3.10/configuration/url.md b/platform/docs/versioned_docs/version-3.11/configuration/url.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/configuration/url.md rename to platform/docs/versioned_docs/version-3.11/configuration/url.md index cac7e5ad4..2fa3a736d 100644 --- a/platform/docs/versioned_docs/version-3.10/configuration/url.md +++ b/platform/docs/versioned_docs/version-3.11/configuration/url.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: URL +title: URL Parameters +summary: Reference for OHIF Viewer URL parameters that control WorkList filtering, study/series loading, and viewer behavior, including parameters for filtering by patient name, modality, data sources, specifying initial series/instances, and selecting hanging protocols. --- # URL diff --git a/platform/docs/versioned_docs/version-3.10/conformance.md b/platform/docs/versioned_docs/version-3.11/conformance.md similarity index 56% rename from platform/docs/versioned_docs/version-3.10/conformance.md rename to platform/docs/versioned_docs/version-3.11/conformance.md index ac34b46de..f83322a85 100644 --- a/platform/docs/versioned_docs/version-3.10/conformance.md +++ b/platform/docs/versioned_docs/version-3.11/conformance.md @@ -2,6 +2,7 @@ sidebar_position: 12 sidebar_label: DICOM Conformance Statement title: DICOM Conformance Statement +summary: Access information about the OHIF Viewer's compliance with DICOM standards through an open-sourced document provided by Radical Imaging, which details the application's implementation of DICOM protocols and services. --- You can find a version that has been open sourced by Radical Imaging [in this link](https://docs.google.com/document/d/1hbDlUApX4svX33gAUGxGfD7fXXZNaBsX0hSePbc-hNA/edit?usp=sharing) diff --git a/platform/docs/versioned_docs/version-3.10/deployment/_category_.json b/platform/docs/versioned_docs/version-3.11/deployment/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/deployment/_category_.json rename to platform/docs/versioned_docs/version-3.11/deployment/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/deployment/authorization.md b/platform/docs/versioned_docs/version-3.11/deployment/authorization.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/deployment/authorization.md rename to platform/docs/versioned_docs/version-3.11/deployment/authorization.md index b3589b1a9..76abd915b 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/authorization.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/authorization.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Auth +title: Authorization and Authentication +summary: Guide to configuring OpenID-Connect authentication in OHIF Viewer, including setup of authorization flows, token handling, and implementation details for securing access to medical imaging data. --- # Authorization and Authentication diff --git a/platform/docs/versioned_docs/version-3.10/deployment/azure.md b/platform/docs/versioned_docs/version-3.11/deployment/azure.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/deployment/azure.md rename to platform/docs/versioned_docs/version-3.11/deployment/azure.md index 219532d90..983eafa4c 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/azure.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/azure.md @@ -1,5 +1,7 @@ --- sidebar_position: 12 +title: Microsoft Azure Integration +summary: Comprehensive guide for configuring OHIF with Microsoft Azure Healthcare APIs, including step-by-step instructions for Azure AD registration, DICOM service setup, CORS configuration, and OAuth authentication implementation. --- # Microsoft Azure diff --git a/platform/docs/versioned_docs/version-3.10/deployment/build-for-production.md b/platform/docs/versioned_docs/version-3.11/deployment/build-for-production.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/deployment/build-for-production.md rename to platform/docs/versioned_docs/version-3.11/deployment/build-for-production.md index dbd89a8a9..f4521327f 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/build-for-production.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/build-for-production.md @@ -1,5 +1,7 @@ --- sidebar_position: 2 +title: Build for Production +summary: Step-by-step guide to building a production-ready version of the OHIF Viewer, including environment setup, code acquisition, dependency restoration, production build creation, and configuration options for deployment. --- # Build for Production diff --git a/platform/docs/versioned_docs/version-3.10/deployment/cors.md b/platform/docs/versioned_docs/version-3.11/deployment/cors.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/deployment/cors.md rename to platform/docs/versioned_docs/version-3.11/deployment/cors.md index 7035ab213..315e10fd5 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/cors.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/cors.md @@ -1,5 +1,7 @@ --- sidebar_position: 8 +title: Cross-Origin Resource Sharing +summary: Detailed explanation of cross-origin security configurations for OHIF Viewer, covering CORS requirements for data source access, iframe embedding, secure contexts, and troubleshooting techniques for proper implementation. --- # Cross-Origin Information for OHIF diff --git a/platform/docs/versioned_docs/version-3.10/deployment/custom-url-access.md b/platform/docs/versioned_docs/version-3.11/deployment/custom-url-access.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/deployment/custom-url-access.md rename to platform/docs/versioned_docs/version-3.11/deployment/custom-url-access.md index c4639aedf..7ec16626f 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/custom-url-access.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/custom-url-access.md @@ -1,6 +1,7 @@ --- sidebar_position: 4 title: Custom URL Access/Build +summary: "Instructions for hosting the OHIF Viewer on custom URL paths, with two deployment approaches: simple setup for serving the viewer from a subpath with assets at the root, and advanced setup for custom asset paths with detailed configuration steps." --- diff --git a/platform/docs/versioned_docs/version-3.10/deployment/docker/docker.md b/platform/docs/versioned_docs/version-3.11/deployment/docker/docker.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/deployment/docker/docker.md rename to platform/docs/versioned_docs/version-3.11/deployment/docker/docker.md index e9c7e212f..327782fc2 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/docker/docker.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/docker/docker.md @@ -1,5 +1,7 @@ --- sidebar_position: 4 +title: Docker Deployment +summary: Comprehensive guide for deploying OHIF Viewer using Docker, covering pre-built images from Docker Hub, custom image building, configuration options through build arguments and environment variables, and runtime container management. --- # Docker diff --git a/platform/docs/versioned_docs/version-3.10/deployment/docker/ssl.md b/platform/docs/versioned_docs/version-3.11/deployment/docker/ssl.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/deployment/docker/ssl.md rename to platform/docs/versioned_docs/version-3.11/deployment/docker/ssl.md index 1942468ec..b6650ba0a 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/docker/ssl.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/docker/ssl.md @@ -1,6 +1,7 @@ --- sidebar_position: 2 -title: SSL +title: SSL Configuration for Docker +summary: Guide to configuring SSL for OHIF Viewer in Docker deployments, including environment variable setup, certificate mounting, permissions management, and instructions for both CA-signed and self-signed certificate implementation. --- # SSL diff --git a/platform/docs/versioned_docs/version-3.10/deployment/google-cloud-healthcare.md b/platform/docs/versioned_docs/version-3.11/deployment/google-cloud-healthcare.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/deployment/google-cloud-healthcare.md rename to platform/docs/versioned_docs/version-3.11/deployment/google-cloud-healthcare.md index 54df8bb02..6fef07c6a 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/google-cloud-healthcare.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/google-cloud-healthcare.md @@ -1,5 +1,7 @@ --- sidebar_position: 9 +title: Google Cloud Healthcare Integration +summary: Guide to setting up Google Cloud Healthcare API as a DICOM data source for OHIF, including project creation, API configuration, OAuth authentication setup, and implementation details for connecting the viewer to Google-hosted medical imaging data. --- # Google Cloud Healthcare diff --git a/platform/docs/versioned_docs/version-3.10/deployment/iframe.md b/platform/docs/versioned_docs/version-3.11/deployment/iframe.md similarity index 89% rename from platform/docs/versioned_docs/version-3.10/deployment/iframe.md rename to platform/docs/versioned_docs/version-3.11/deployment/iframe.md index 671756911..c4460052e 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/iframe.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/iframe.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: iframe +title: Embedding OHIF in an iframe +summary: Guidelines for embedding OHIF Viewer within other applications using iframe integration, explaining configuration requirements for path settings, static builds, and proper setup to ensure WebWorkers, WASM, and WebGL features function correctly. --- # iframe diff --git a/platform/docs/versioned_docs/version-3.10/deployment/index.md b/platform/docs/versioned_docs/version-3.11/deployment/index.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/deployment/index.md rename to platform/docs/versioned_docs/version-3.11/deployment/index.md index 6698c607f..7b8ca8810 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/index.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Overview +title: Deployment Overview +summary: Comprehensive guide to deploying the OHIF Viewer as a standalone web application or embedded iframe, covering data source configuration, security considerations, and various deployment options with examples for different hosting environments. --- # Deployment diff --git a/platform/docs/versioned_docs/version-3.10/deployment/nginx--image-archive.md b/platform/docs/versioned_docs/version-3.11/deployment/nginx--image-archive.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/deployment/nginx--image-archive.md rename to platform/docs/versioned_docs/version-3.11/deployment/nginx--image-archive.md index b1a2fd34b..1f77a5f3a 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/nginx--image-archive.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/nginx--image-archive.md @@ -1,5 +1,7 @@ --- sidebar_position: 10 +title: Nginx + Image Archive Setup +summary: Tutorial for setting up OHIF Viewer with Nginx and PACS (Orthanc or DCM4CHEE), using Docker for a production-ready system with reverse proxy configuration to securely handle medical imaging data, including installation steps and troubleshooting tips. --- # Nginx + Image Archive diff --git a/platform/docs/versioned_docs/version-3.10/deployment/static-assets.md b/platform/docs/versioned_docs/version-3.11/deployment/static-assets.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/deployment/static-assets.md rename to platform/docs/versioned_docs/version-3.11/deployment/static-assets.md index 4186a1b3c..d04d7af0f 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/static-assets.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/static-assets.md @@ -1,5 +1,7 @@ --- sidebar_position: 3 +title: Deploy Static Assets +summary: Guide to deploying OHIF Viewer static assets using various hosting options, from simple drag-and-drop methods like Netlify to more advanced cloud platforms like AWS, GCP, and Azure, with step-by-step instructions for each deployment approach. --- # Deploy Static Assets diff --git a/platform/docs/versioned_docs/version-3.10/deployment/user-account-control.md b/platform/docs/versioned_docs/version-3.11/deployment/user-account-control.md similarity index 98% rename from platform/docs/versioned_docs/version-3.10/deployment/user-account-control.md rename to platform/docs/versioned_docs/version-3.11/deployment/user-account-control.md index 87f0235be..91fa965d0 100644 --- a/platform/docs/versioned_docs/version-3.10/deployment/user-account-control.md +++ b/platform/docs/versioned_docs/version-3.11/deployment/user-account-control.md @@ -1,5 +1,7 @@ --- sidebar_position: 11 +title: User Account Control +summary: Comprehensive guide for implementing user authentication in OHIF using Keycloak, covering setup with both Orthanc and DCM4CHEE, configuration with OAuth2 proxy, SSL implementation, and detailed steps for local and production deployment scenarios. --- # User Account Control diff --git a/platform/docs/versioned_docs/version-3.10/development/_category_.json b/platform/docs/versioned_docs/version-3.11/development/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/development/_category_.json rename to platform/docs/versioned_docs/version-3.11/development/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/development/android-ios-debugging.md b/platform/docs/versioned_docs/version-3.11/development/android-ios-debugging.md similarity index 92% rename from platform/docs/versioned_docs/version-3.10/development/android-ios-debugging.md rename to platform/docs/versioned_docs/version-3.11/development/android-ios-debugging.md index 67c42734a..1e5ebe8a7 100644 --- a/platform/docs/versioned_docs/version-3.10/development/android-ios-debugging.md +++ b/platform/docs/versioned_docs/version-3.11/development/android-ios-debugging.md @@ -1,6 +1,8 @@ --- sidebar_position: 12 sidebar_label: Android & iOS Debugging +title: Android & iOS Debugging +summary: Comprehensive guide for debugging OHIF Viewer on mobile devices, covering setup of Android and iOS emulators, step-by-step instructions for connecting Chrome DevTools and Safari Web Inspector, and video tutorials demonstrating the debugging workflow. --- # Android & iOS Debugging for OHIF using Emulators diff --git a/platform/docs/versioned_docs/version-3.10/development/architecture.md b/platform/docs/versioned_docs/version-3.11/development/architecture.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/development/architecture.md rename to platform/docs/versioned_docs/version-3.11/development/architecture.md index f191f16ed..ea7587a42 100644 --- a/platform/docs/versioned_docs/version-3.10/development/architecture.md +++ b/platform/docs/versioned_docs/version-3.11/development/architecture.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Architecture +title: OHIF Architecture +summary: Detailed explanation of OHIF Viewer's architecture, covering the platform's core components, extensions system, modes concept, and the relationships between these elements that enable building flexible and extensible medical imaging applications. --- # Architecture diff --git a/platform/docs/versioned_docs/version-3.10/development/continuous-integration.md b/platform/docs/versioned_docs/version-3.11/development/continuous-integration.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/development/continuous-integration.md rename to platform/docs/versioned_docs/version-3.11/development/continuous-integration.md index 48ad4c4d0..15055a374 100644 --- a/platform/docs/versioned_docs/version-3.10/development/continuous-integration.md +++ b/platform/docs/versioned_docs/version-3.11/development/continuous-integration.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: Continuous Integration +title: Continuous Integration +summary: Overview of OHIF's CI/CD setup using CircleCI and Netlify, detailing workflows for pull request checks, optional Docker image publishing, deployment to development/staging/production environments, and the release process for npm packages and documentation. --- # Continuous Integration (CI) diff --git a/platform/docs/versioned_docs/version-3.10/development/contributing.md b/platform/docs/versioned_docs/version-3.11/development/contributing.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/development/contributing.md rename to platform/docs/versioned_docs/version-3.11/development/contributing.md index 5e513b7c3..a0d9f0c9e 100644 --- a/platform/docs/versioned_docs/version-3.10/development/contributing.md +++ b/platform/docs/versioned_docs/version-3.11/development/contributing.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Contributing +title: Contributing to OHIF +summary: Guidelines for contributing to the OHIF project, including best practices for submitting pull requests, working with multiple repositories, and advice on creating changes that are more likely to be accepted by the core team. --- # Contributing diff --git a/platform/docs/versioned_docs/version-3.10/development/getting-started.md b/platform/docs/versioned_docs/version-3.11/development/getting-started.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/development/getting-started.md rename to platform/docs/versioned_docs/version-3.11/development/getting-started.md index 32214b66f..c23bc9bcf 100644 --- a/platform/docs/versioned_docs/version-3.10/development/getting-started.md +++ b/platform/docs/versioned_docs/version-3.11/development/getting-started.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Getting Started +title: Getting Started with OHIF Development +summary: Quick start guide for OHIF development, covering repository setup options, branch organization, development environment requirements, project initialization, and steps for building production-ready assets. --- # Getting Started diff --git a/platform/docs/versioned_docs/version-3.11/development/link.md b/platform/docs/versioned_docs/version-3.11/development/link.md new file mode 100644 index 000000000..92d93eb6a --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/development/link.md @@ -0,0 +1,52 @@ +--- +sidebar_position: 9 +sidebar_label: Local Linking +title: Local Library Linking +summary: Brief introduction to the concept of local linking for library development in OHIF, explaining how to test libraries in application context before publishing, with reference to Cornerstonejs linking documentation. +--- + +# Introduction + +Local linking allows you to develop and test a library in the context of an application before it's published or when you encounter +a bug that you suspect is related to a library. With Yarn, this can be achieved through the yarn link command. + +You can take a look at the Cornerstonejs tutorial for linking https://www.cornerstonejs.org/docs/contribute/linking + +## Linking with `bun` + +The [instructions](#introduction) above describe how to use `yarn` for local linking. Some use `bun` for day-to-day +code linking and execution. The method to link locally using `bun` differs slightly. + +:::tip + +Linking locally with `bun` provides for running the [playwright tests](./playwright-testing.md) locally so as to include (and test) local changes from Cornerstone3D! + +::: + +In the local Cornerstone3D, simply replace `yarn` with `bun` for each of the commands. For example, in `cornerstone/packages/core` the following would be done. + +``` +# In cornerstone/packages/core +bun unlink +bun link +bun dev +``` + +In OHIF, edit the root `package.json` file to include the cornerstone3D packages to link and add them to the `resolutions`. + +For example here is a snippet of the `package.json` file linking cornerstone core and tools locally. Add whichever +cornerstone packages to link locally in the `resolutions`. + +``` + ... + "resolutions": { + "commander": "8.3.0", + "path-to-regexp": "0.1.12", + "@cornerstonejs/core": "link:@cornerstonejs/core", + "@cornerstonejs/tools": "link:@cornerstonejs/tools", + ... + }, + ... +``` + +In OHIF, run `bun install -f` and then run OHIF using either `bun dev` or `bun dev:fast`. diff --git a/platform/docs/versioned_docs/version-3.10/development/ohif-cli.md b/platform/docs/versioned_docs/version-3.11/development/ohif-cli.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/development/ohif-cli.md rename to platform/docs/versioned_docs/version-3.11/development/ohif-cli.md index 038f331a9..1cc90db3e 100644 --- a/platform/docs/versioned_docs/version-3.10/development/ohif-cli.md +++ b/platform/docs/versioned_docs/version-3.11/development/ohif-cli.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: OHIF CLI +title: OHIF Command Line Interface +summary: Comprehensive guide to the OHIF CLI tool for managing extensions and modes, including commands for creating, linking, adding, removing, and publishing components, with detailed examples and explanations of the underlying configuration system. --- # OHIF Command Line Interface diff --git a/platform/docs/versioned_docs/version-3.10/development/our-process.md b/platform/docs/versioned_docs/version-3.11/development/our-process.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/development/our-process.md rename to platform/docs/versioned_docs/version-3.11/development/our-process.md index 263135b1f..cda269eef 100644 --- a/platform/docs/versioned_docs/version-3.10/development/our-process.md +++ b/platform/docs/versioned_docs/version-3.11/development/our-process.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Issue & PR Triage Process +title: OHIF Development Process +summary: Detailed explanation of OHIF's issue triage, backlog management, contribution evaluation, and release processes, including categorization of issues, pull request workflow, quality assurance procedures, and continuous integration practices. --- # Our Process diff --git a/platform/docs/versioned_docs/version-3.10/development/playwright-testing.md b/platform/docs/versioned_docs/version-3.11/development/playwright-testing.md similarity index 94% rename from platform/docs/versioned_docs/version-3.10/development/playwright-testing.md rename to platform/docs/versioned_docs/version-3.11/development/playwright-testing.md index f85f02d33..e52e475d1 100644 --- a/platform/docs/versioned_docs/version-3.10/development/playwright-testing.md +++ b/platform/docs/versioned_docs/version-3.11/development/playwright-testing.md @@ -1,19 +1,22 @@ --- sidebar_position: 11 sidebar_label: Playwright Testing +title: Playwright End-to-End Testing +summary: Guide to writing and running end-to-end tests for OHIF Viewer using Playwright, covering test configuration, screenshot verification, simulating user interactions, accessing application services, and using the VSCode extension for test recording. --- :::note -You might need to run the `yarn playwright install ` for the first time if you have not +You might need to run the `bun playwright install ` for the first time if you have not ::: # Running the tests ```bash +# # run the tests -yarn test:e2e:ui +bun test:e2e:ui ``` diff --git a/platform/docs/versioned_docs/version-3.10/development/testing.md b/platform/docs/versioned_docs/version-3.11/development/testing.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/development/testing.md rename to platform/docs/versioned_docs/version-3.11/development/testing.md index 23f239755..fb7322696 100644 --- a/platform/docs/versioned_docs/version-3.10/development/testing.md +++ b/platform/docs/versioned_docs/version-3.11/development/testing.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: Testing +title: Testing OHIF +summary: Comprehensive guide to OHIF's testing approach, covering unit tests and end-to-end tests with detailed instructions for running them, explanation of test data management, and an overview of the project's testing philosophy and best practices. --- # Running Tests for OHIF diff --git a/platform/docs/versioned_docs/version-3.10/development/types.md b/platform/docs/versioned_docs/version-3.11/development/types.md similarity index 91% rename from platform/docs/versioned_docs/version-3.10/development/types.md rename to platform/docs/versioned_docs/version-3.11/development/types.md index a6af5df12..e048c98bb 100644 --- a/platform/docs/versioned_docs/version-3.10/development/types.md +++ b/platform/docs/versioned_docs/version-3.11/development/types.md @@ -1,6 +1,8 @@ --- sidebar_position: 10 sidebar_label: Global Types +title: Global Types and Service Extensions +summary: Guide to using and extending TypeScript types in OHIF applications, focusing on the withAppTypes utility for component typing, adding custom properties, and properly integrating new services into the global namespace for type safety and code completion. --- # Extending App Types and Services in Your Application diff --git a/platform/docs/versioned_docs/version-3.10/development/video-tutorials.md b/platform/docs/versioned_docs/version-3.11/development/video-tutorials.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/development/video-tutorials.md rename to platform/docs/versioned_docs/version-3.11/development/video-tutorials.md index 482967e26..15ffa4f5c 100644 --- a/platform/docs/versioned_docs/version-3.10/development/video-tutorials.md +++ b/platform/docs/versioned_docs/version-3.11/development/video-tutorials.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Video Tutorials +title: OHIF Development Video Tutorials +summary: Collection of instructional videos demonstrating key OHIF development workflows, including creating, linking, and publishing modes and extensions, with step-by-step demonstrations of the OHIF CLI and NPM publishing process. --- # Video Tutorials diff --git a/platform/docs/versioned_docs/version-3.10/development/webWorkers.md b/platform/docs/versioned_docs/version-3.11/development/webWorkers.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/development/webWorkers.md rename to platform/docs/versioned_docs/version-3.11/development/webWorkers.md index 7fa3bed1a..c90e6af23 100644 --- a/platform/docs/versioned_docs/version-3.10/development/webWorkers.md +++ b/platform/docs/versioned_docs/version-3.11/development/webWorkers.md @@ -1,6 +1,8 @@ --- sidebar_position: 13 sidebar_label: Web Workers +title: Web Workers Implementation Guide +summary: Step-by-step guide for implementing web workers in OHIF to handle computationally intensive tasks in background threads, including worker creation, registration, task execution, progress tracking, and best practices for code organization. --- # Web Worker Implementation Guide diff --git a/platform/docs/versioned_docs/version-3.10/faq/_category_.json b/platform/docs/versioned_docs/version-3.11/faq/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/faq/_category_.json rename to platform/docs/versioned_docs/version-3.11/faq/_category_.json diff --git a/platform/docs/versioned_docs/version-3.11/faq/add-viewport-icon.md b/platform/docs/versioned_docs/version-3.11/faq/add-viewport-icon.md new file mode 100644 index 000000000..11c35cdc2 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/faq/add-viewport-icon.md @@ -0,0 +1,178 @@ +--- +id: add-viewport-icon +title: How to add a custom icon to the viewport corners +summary: Learn how to add a custom icon or dropdown to one of the viewport corners in OHIF. +--- + +# How to add a custom icon to the viewport corners + +## Question +How can I add a custom icon or dropdown to one of the viewport corners in OHIF? + +## Answer +OHIF provides a customizable viewport action menu system that allows you to add icons, buttons, or dropdowns to any of the four corners of a viewport (topLeft, topRight, bottomLeft, bottomRight). This is done through the `customizationService` and the viewport action corners API. + +Here's a complete example that shows how to add a mode switch dropdown to the top-left corner of the viewport: + +```tsx +import React from 'react'; +import { Icons } from '@ohif/ui-next'; +import { useSystem } from '@ohif/core'; +import { + DropdownMenu, + DropdownMenuTrigger, + DropdownMenuContent, + DropdownMenuItem, + DropdownMenuLabel, + Button, +} from '@ohif/ui-next'; + +// This is a complete, self-contained component that shows a dropdown menu +// for switching modes when clicked +function getModeSwitchMenu({ viewportId, element, location }) { + const ModeSwitchMenu = () => { + const { servicesManager } = useSystem(); + const { router } = servicesManager.services; + const { viewportActionCornersService } = servicesManager.services; + + const handleModeSwitch = (mode) => { + const currentStudyInstanceUID = router.query.StudyInstanceUIDs; + // Navigate to the selected mode with the current study + router.navigate(`/${mode}?StudyInstanceUIDs=${currentStudyInstanceUID}`); + }; + + // Get proper alignment based on the location + let align = 'center'; + let side = 'bottom'; + + if (location !== undefined) { + const positioning = viewportActionCornersService.getAlignAndSide(location); + align = positioning.align; + side = positioning.side; + } + + return ( +
+ + + + + + Mode + handleModeSwitch('longitudinal')}> + Longitudinal + + handleModeSwitch('segmentation')}> + Segmentation + + handleModeSwitch('tmtv')}> + TMTV + + handleModeSwitch('microscopy')}> + Microscopy + + + +
+ ); + }; + + return ; +} + +// In your mode or extension, add this to the customizations +// This example shows how to add it in the onModeEnter lifecycle hook +function onModeEnter({ servicesManager }) { + const { customizationService } = servicesManager.services; + + // Add the mode switch icon to the top-left corner of the viewport + customizationService.setCustomizations({ + 'viewportActionMenu.topLeft': { + // Use $push to add to existing items or $set to replace all items + $push: [ + { + id: 'modeSwitch', + enabled: true, + component: getModeSwitchMenu, + }, + ], + }, + }); +} +``` + +## Key Concepts + +1. **Location-based customization**: The viewport is divided into four corners identified by: + - `viewportActionMenu.topLeft` + - `viewportActionMenu.topRight` + - `viewportActionMenu.bottomLeft` + - `viewportActionMenu.bottomRight` + +2. **Component structure**: + - `id` - A unique identifier for your component + - `enabled` - Boolean to control if the component should be displayed + - `component` - A function that returns a React component to render + +3. **Component positioning**: The component's position within a corner is determined by its order in the array. Components are rendered in the order they appear. + +4. **Dropdown positioning**: Use the `viewportActionCornersService.getAlignAndSide()` method to get the correct alignment for your dropdown menu based on its location. + +## Adding Multiple Components + +If you want to add multiple components to the same corner or different corners, you can do it in a single customization: + +```js +customizationService.setCustomizations({ + 'viewportActionMenu.topLeft': { + $push: [ + { + id: 'modeSwitch', + enabled: true, + component: getModeSwitchMenu, + }, + ], + }, + 'viewportActionMenu.topRight': { + $push: [ + { + id: 'anotherComponent', + enabled: true, + component: getAnotherComponent, + }, + ], + }, +}); +``` + +## Replacing Existing Components + +If you want to replace all components in a corner instead of adding to them, use `$set` instead of `$push`: + +```js +customizationService.setCustomizations({ + 'viewportActionMenu.topLeft': { + $set: [ + { + id: 'modeSwitch', + enabled: true, + component: getModeSwitchMenu, + }, + // This will be the only components in the top-left corner + ], + }, +}); +``` + +Remember that this customization will affect all viewports in the active mode. If you need different behavior for different viewports, you should check the `viewportId` parameter in your component's logic. diff --git a/platform/docs/versioned_docs/version-3.10/faq/faq-measure-1.png b/platform/docs/versioned_docs/version-3.11/faq/faq-measure-1.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/faq/faq-measure-1.png rename to platform/docs/versioned_docs/version-3.11/faq/faq-measure-1.png diff --git a/platform/docs/versioned_docs/version-3.10/faq/faq-measure-2.png b/platform/docs/versioned_docs/version-3.11/faq/faq-measure-2.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/faq/faq-measure-2.png rename to platform/docs/versioned_docs/version-3.11/faq/faq-measure-2.png diff --git a/platform/docs/versioned_docs/version-3.10/faq/faq-measure-4.png b/platform/docs/versioned_docs/version-3.11/faq/faq-measure-4.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/faq/faq-measure-4.png rename to platform/docs/versioned_docs/version-3.11/faq/faq-measure-4.png diff --git a/platform/docs/versioned_docs/version-3.10/faq/faq-measure-5.png b/platform/docs/versioned_docs/version-3.11/faq/faq-measure-5.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/faq/faq-measure-5.png rename to platform/docs/versioned_docs/version-3.11/faq/faq-measure-5.png diff --git a/platform/docs/versioned_docs/version-3.10/faq/faq-measure3.png b/platform/docs/versioned_docs/version-3.11/faq/faq-measure3.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/faq/faq-measure3.png rename to platform/docs/versioned_docs/version-3.11/faq/faq-measure3.png diff --git a/platform/docs/versioned_docs/version-3.10/faq/general.md b/platform/docs/versioned_docs/version-3.11/faq/general.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/faq/general.md rename to platform/docs/versioned_docs/version-3.11/faq/general.md index 2c01de7d1..7e0619b72 100644 --- a/platform/docs/versioned_docs/version-3.10/faq/general.md +++ b/platform/docs/versioned_docs/version-3.11/faq/general.md @@ -1,5 +1,7 @@ --- id: general +title: General FAQ +summary: Answers to common questions about OHIF Viewer, including how to report bugs, request features, contact for support or academic collaborations, regulatory compliance status (FDA/CE/HIPAA), and obtaining sample studies. --- diff --git a/platform/docs/versioned_docs/version-3.10/faq/index.md b/platform/docs/versioned_docs/version-3.11/faq/index.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/faq/index.md rename to platform/docs/versioned_docs/version-3.11/faq/index.md index e44af0f30..30a56b434 100644 --- a/platform/docs/versioned_docs/version-3.10/faq/index.md +++ b/platform/docs/versioned_docs/version-3.11/faq/index.md @@ -1,5 +1,7 @@ --- id: index +title: OHIF Viewer FAQ +summary: Comprehensive list of frequently asked questions about the OHIF Viewer, covering common inquiries about reporting bugs, requesting features, academic collaborations, regulatory status, and obtaining demo studies. --- diff --git a/platform/docs/versioned_docs/version-3.10/faq/study-sorting.png b/platform/docs/versioned_docs/version-3.11/faq/study-sorting.png similarity index 100% rename from platform/docs/versioned_docs/version-3.10/faq/study-sorting.png rename to platform/docs/versioned_docs/version-3.11/faq/study-sorting.png diff --git a/platform/docs/versioned_docs/version-3.10/faq/technical.md b/platform/docs/versioned_docs/version-3.11/faq/technical.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/faq/technical.md rename to platform/docs/versioned_docs/version-3.11/faq/technical.md index bee5b8f7e..785138076 100644 --- a/platform/docs/versioned_docs/version-3.10/faq/technical.md +++ b/platform/docs/versioned_docs/version-3.11/faq/technical.md @@ -1,5 +1,12 @@ +--- +id: technical +title: Technical FAQ +summary: Technical explanations and solutions for OHIF Viewer implementation challenges, including required metadata fields, handling large volumes for MPR/rendering, dynamically loading measurements, customizing series sorting, and addressing common rendering issues. +--- + # Technical FAQ +* [How to add a custom icon to the viewport corners](./add-viewport-icon.md) ## Viewer opens but does not show any thumbnails diff --git a/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/commands.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/commands.md new file mode 100644 index 000000000..d38b52f52 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/commands.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 4 +sidebar_label: Commands +summary: Migration guide for OHIF 3.11's different commands +--- + + + +## updateStoredPositionPresentation + +now uses displaySetInstanceUIDs instead of displaySetInstanceUID as a parameter. + + +## `loadSRMeasurements` Command + +**Key Changes:** + +* The `loadSRMeasurements` command, previously part of the `@ohif/extension-cornerstone-dicom-sr` extension, has been **removed**. +* Its functionality of hydrating a Structured Report (SR) and displaying its referenced series in a viewport is now primarily handled by the new `hydrateSecondaryDisplaySet` command available in the `@ohif/extension-cornerstone` extension. +* The `hydrateStructuredReport` command (from `@ohif/extension-cornerstone-dicom-sr`) now solely focuses on hydrating the SR and returning its data, without directly manipulating viewports. + +**Migration Steps:** + +If you were previously using the `loadSRMeasurements` command to load and display SR measurements, you should update your code to use the `hydrateSecondaryDisplaySet` command. + +1. **Identify `loadSRMeasurements` Usage:** + Locate where your code calls `commandsManager.runCommand('loadSRMeasurements', ...)`. + +2. **Update to `hydrateSecondaryDisplaySet`:** + Replace the call to `loadSRMeasurements` with `hydrateSecondaryDisplaySet`. You will need to pass the full `displaySet` object for the SR and the target `viewportId`. + + ```diff + - // Old way: using loadSRMeasurements + - commandsManager.runCommand('loadSRMeasurements', { + - displaySetInstanceUID: srDisplaySetInstanceUID, + - // viewportId was implicitly the active one or not directly specifiable here + - }); + - + + // New way: using hydrateSecondaryDisplaySet + + const { displaySetService, viewportGridService } = servicesManager.services; + + + + // 1. Get the SR displaySet object + + const srDisplaySet = displaySetService.getDisplaySetByUID(srDisplaySetInstanceUID); + + + + // 2. Determine the target viewportId (e.g., active viewport) + + const viewportId = viewportGridService.getActiveViewportId(); // Or your specific viewportId + + + + if (srDisplaySet && viewportId) { + + commandsManager.runCommand('hydrateSecondaryDisplaySet', { + + displaySet: srDisplaySet, + + viewportId: viewportId, + + }); + + } else { + + console.warn('SR DisplaySet or ViewportId not found, cannot hydrate.'); + + } + ``` + +**Explanation:** + +* The `loadSRMeasurements` command was responsible for both hydrating the SR (getting its measurement data and referenced series UIDs) and then updating the viewport to show the referenced series. +* The new `hydrateSecondaryDisplaySet` command, when given an SR `displaySet` (`displaySet.Modality === 'SR'`), will: + 1. Internally call the `hydrateStructuredReport` command to parse the SR and get its details (including `SeriesInstanceUIDs` of referenced images). + 2. Then, it will automatically find the corresponding image display sets for those `SeriesInstanceUIDs`. + 3. Finally, it will update the specified `viewportId` to display the primary referenced image series. +* This change centralizes the logic for hydrating secondary display sets (like SR, SEG, RTSTRUCT) and updating viewports into the `hydrateSecondaryDisplaySet` command within the core Cornerstone extension. + +**Note on UI/Button Changes:** +The UI button typically associated with "Load SR" (often seen in viewport corners or specific contexts) has also been refactored. The hydration of SRs is now often triggered by: +* The `TrackedMeasurementsContext` if the `@ohif/extension-measurement-tracking` is in use. +* The new `ModalityLoadBadge` component, which can appear in viewports containing SR, SEG, or RTSTRUCT display sets, offering a "LOAD" action that calls `hydrateSecondaryDisplaySet`. + +If you had custom UI invoking `loadSRMeasurements`, you'll need to adapt it to call `hydrateSecondaryDisplaySet` as described above. diff --git a/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/hydration.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/hydration.md new file mode 100644 index 000000000..0f82524f4 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/hydration.md @@ -0,0 +1,85 @@ +--- +title: Hydration +sidebar_position: 3 +sidebar_label: Hydration +summary: Migration guide for OHIF 3.11's hydration system changes, including the transition to a centralized hydration dialog and command-based hydration for secondary display sets. +--- + +## Update Hydration Logic: + * The `promptHydrateSEG` and `promptHydrateRT` functions have been updated to use the generic `utils.promptHydrationDialog` from `@ohif/extension-cornerstone`. + * The actual hydration is now often triggered by the `hydrateSecondaryDisplaySet` command. + + *Example: `promptHydrateRT` change* + + ```diff + // extensions/cornerstone-dicom-rt/src/utils/promptHydrateRT.ts + - const RESPONSE = { + - NO_NEVER: -1, + - CANCEL: 0, + - HYDRATE_SEG: 5, + - }; + + import { utils, Types } from '@ohif/extension-cornerstone'; + + function promptHydrateRT({ + servicesManager, + rtDisplaySet, + viewportId, + preHydrateCallbacks, + hydrateRTDisplaySet, + -}: withAppTypes) { + - const { uiViewportDialogService, customizationService } = servicesManager.services; + - // ... lots of old promise and dialog logic + - return new Promise(async function (resolve, reject) { + - // ... + - }); + -} + - + -function _askHydrate( + - // ... + -) { + - // ... + -} + +}: { + + servicesManager: AppTypes.ServicesManager; + + rtDisplaySet: AppTypes.DisplaySet; + + viewportId: string; + + preHydrateCallbacks?: Types.HydrationCallback[]; + + hydrateRTDisplaySet: Types.HydrationCallback; + +}) { + + return utils.promptHydrationDialog({ + + servicesManager, + + viewportId, + + displaySet: rtDisplaySet, + + preHydrateCallbacks, + + hydrateCallback: hydrateRTDisplaySet, + + type: 'RTSTRUCT', + + }); + } + ``` + The `hydrateRTDisplaySet` callback passed to this function would now typically involve the `hydrateSecondaryDisplaySet` command. + ```diff + // extensions/cornerstone-dicom-rt/src/viewports/OHIFCornerstoneRTViewport.tsx + useEffect(() => { + if (rtIsLoading) { + return; + } + promptHydrateRT({ + servicesManager, + viewportId, + rtDisplaySet, + - preHydrateCallbacks: [storePresentationState], + - hydrateRTDisplaySet, + - }).then(isHydrated => { + - if (isHydrated) { + - setIsHydrated(true); + - } + + hydrateRTDisplaySet: async () => { + + return commandsManager.runCommand('hydrateSecondaryDisplaySet', { + + displaySet: rtDisplaySet, + + viewportId, + + }); + + }, + }); + - }, [servicesManager, viewportId, rtDisplaySet, rtIsLoading]); + + }, [servicesManager, viewportId, rtDisplaySet, rtIsLoading, commandsManager]); + ``` diff --git a/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/index.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/index.md new file mode 100644 index 000000000..d91498504 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/index.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 1 +sidebar_label: 3.10 -> 3.11 +--- + +# Migration Guide + +This guide provides information about migrating from OHIF version 3.10 to version 3.11. diff --git a/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/other.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/other.md new file mode 100644 index 000000000..c16431951 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/other.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 2 +sidebar_label: Other Changes +summary: Migration guide for OHIF 3.11 additional changes +--- + + +**Key Changes:** + +* **`connectToolsToMeasurementService` parameters:** The `connectToolsToMeasurementService` function from the `@ohif/cornerstone-extensions` now take different arguments. +* **`data-viewportId`** The `data-viewportId` naming was not compliant with react and was causing warnings. Rename references to `data-viewportid`. +* **`setIsReferenceViewable`** is no longer available or required by ViewportGridService. Instead, the cornerstone viewports + themselves provide the isReferenceViewable. This occurs because there were a lot more deciding issues to navigate to viewports than could be added to viewport grid service. +* **`JUMP_TO_MEASUREMENT_VIEWPORT` and `JUMP_TO_MEASUREMENT_LAYOUT`** are combined into `JUMP_TO_MEASUREMENT` with no + consume event. Only the single event is fired. This will need to be handled to redirect the changes to the appropriate viewport type as it was not possible to figure that out with generic information available in `ViewportGridService` + +**Migration Steps:** + +1. **Update `connectToolsToMeasurementService` Method Calls:** + * Now the connectToolsToMeasurementService receives all service object arguments (servicesManager, commandsManager and extensionManager). + + ```diff + // Before + - connectToolsToMeasurementService(servicesManager); + + // After + + connectToolsToMeasurementService({ + + servicesManager, + + commandsManager, + + extensionsManager + + }); + ``` + +**Images sort by position patient** + +The ImageSet sort has been modified: images are now sorted by ImagePositionPatient by default. If ImagePositionPatient is not available, the sort will fall back to InstanceNumber. + +**To revert to the previous sorting method, you can add the customization instanceSortingCriteria as shown below:** + +``` + customizationService.setCustomizations({ + 'instanceSortingCriteria': { + $set: {defaultSortFunctionName: 'default'}, + }, + }); +``` diff --git a/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/toolbarService.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/toolbarService.md new file mode 100644 index 000000000..15e53ac9e --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/toolbarService.md @@ -0,0 +1,178 @@ +--- +sidebar_position: 2 +sidebar_label: Toolbar Service +summary: Migration guide for OHIF 3.11's toolbar service changes, including the transition from `ViewportActionCornersService` to `ToolbarService` +--- + + +**Key Changes:** + +* **`ViewportActionCornersService` Removed:** The `ViewportActionCornersService` and its associated provider (`ViewportActionCornersProvider`) and hook (`useViewportActionCorners`) have been removed. Functionality for viewport corner items is now integrated into the `ToolbarService` and standard toolbar components. +* **Viewport Corner Items as Toolbar Buttons:** Items previously managed by `ViewportActionCornersService` are now configured as regular toolbar buttons. They are assigned to specific toolbar sections (e.g., `viewportActionMenu.topLeft`) and rendered using `Toolbar` components within the viewport corners. +* **`ToolbarService` API Updates:** + * `ToolbarService.addButtons()` has been renamed to `ToolbarService.register()` to better reflect its purpose of registering button definitions rather than just adding them. + * `ToolbarService.createButtonSection()` has been renamed to `ToolbarService.updateSection()` to better reflect that it is not about creating new sections but updating existing ones. + * `ToolbarService` now has a `sections` property (e.g., `toolbarService.sections.viewportActionMenu.topLeft`) providing predefined section names. +* **Enhanced `useToolbar` Hook:** + * The `useToolbar` hook now returns additional state management functions for toolbar items: + * `openItem`, `closeItem`, `isItemOpen` (for managing dropdown/popover states). + * `lockItem`, `unlockItem`, `toggleLock`, `isItemLocked`. + * `showItem`, `hideItem`, `toggleVisibility`, `isItemVisible`. + * The `onInteraction` callback now receives `itemId` and `viewportId`. +* **Toolbar Button Configuration:** + * The `groupId` prop in button configurations (e.g., for `ohif.toolButtonList`, `ohif.toolBoxButtonGroup`) is generally replaced by directly using `buttonSection` to define the set of buttons. + * Button `evaluate` functions can now leverage `evaluateProps.hideWhenDisabled` to automatically hide a button when it's disabled. +* **New UI Components & Hooks for Viewport Corners:** + * Specialized components like `ModalityLoadBadge`, `NavigationComponent`, `TrackingStatus`, `ViewportDataOverlayMenuWrapper`, `ViewportOrientationMenuWrapper`, `WindowLevelActionMenuWrapper` are now used as toolbar buttons, typically in viewport action menu sections. + * `useViewportHover` hook can be used to determine if a viewport is hovered or active, controlling the visibility of corner toolbars. +* **`IconPresentationProvider`:** A new `IconPresentationProvider` and `useIconPresentation` hook have been introduced to standardize icon sizing and styling within toolbars and related components. +* **Legacy Toolbar Components Removed:** `ToolbarSplitButtonWithServicesLegacy` and `ToolbarButtonGroupWithServicesLegacy` have been removed. + +**Migration Steps:** + +1. **Update `ToolbarService` Method Calls:** + * Although the previous method also works but gives warning in the console when used. + * Replace all instances of `toolbarService.addButtons(...)` with `toolbarService.register(...)`. + * Replace all instances of `toolbarService.createButtonSection(...)` with `toolbarService.updateSection(...)`. + + ```diff + // Before + - toolbarService.addButtons(toolbarButtons); + - toolbarService.createButtonSection('primary', ['Zoom', 'Pan']); + + // After + + toolbarService.register(toolbarButtons); + + toolbarService.updateSection('primary', ['Zoom', 'Pan']); + ``` + +2. **Migrate Viewport Action Corner Items:** + * Remove any direct usage of the old `ViewportActionCornersService`, `useViewportActionCorners`, or `ViewportActionCornersProvider`. + * Define your viewport corner items (like orientation menu, W/L menu, data overlay menu) as standard toolbar buttons using `toolbarService.register()`. + * Assign these buttons to the new dedicated viewport action menu sections. You can access these section names via `toolbarService.sections.viewportActionMenu.`, e.g., `toolbarService.sections.viewportActionMenu.topLeft`. + + ```diff + // Before: Customization in viewportActionMenuCustomizations.ts (now deleted) + // or direct use of ViewportActionCornersService.addComponent + - // Example: viewportActionCornersService.addComponent({ viewportId, id: 'orientationMenu', component: MyOrientationMenu, location: 'topLeft' }); + + // After: In your mode's onModeEnter or similar setup + + const myViewportCornerButtons = [ + + { + + id: 'orientationMenu', + + uiType: 'ohif.orientationMenu', // Or your custom component registered as a UI type + + props: { /* ... props for your component ... */ } + + }, + + // ... other corner buttons + + ]; + + toolbarService.register(myViewportCornerButtons); + + toolbarService.updateSection( + + toolbarService.sections.viewportActionMenu.topLeft, + + ['orientationMenu', /* other button IDs */] + + ); + ``` + * The `OHIFViewportActionCorners.tsx` component now internally uses `Toolbar` components for each corner, which are populated by these sections. + * For custom components that act as menus (e.g., popovers), use the `onOpen`, `onClose`, `isOpen` props passed down by the `Toolbar` component (which get these from `useToolbar`). + + ```diff + // Before: Custom component might have managed its own open state + - // const [isMenuOpen, setIsMenuOpen] = useState(false); + - // const handleOpenChange = (open) => setIsMenuOpen(open); + + // After: Custom component receives isOpen, onOpen, onClose from Toolbar + + function MyCustomMenuButton({ isOpen, onOpen, onClose, ...rest }) { + + const handleOpenChange = (openState: boolean) => { + + if (openState) { + + onOpen?.(); + + } else { + + onClose?.(); + + } + + }; + + + + return ( + + + + {/* ... PopoverTrigger and PopoverContent ... */} + + + + ); + + } + ``` + +3. **Adapt Toolbar Button and Component Configurations:** + + The configuration of toolbar buttons, especially how they relate to sections + + * **Button Section Association via `props.buttonSection`:** + + The toolbar service now offers two ways to define this association: + + * **A. Simple Approach: `buttonSection: true` (Implicitly Uses Button's Own ID)** + + If a button definition includes `props: { buttonSection: true }`, the `ToolbarService` automatically sets the effective `buttonSection` ID to be the same as the button's own `id`. + + ```javascript + // Example: A ToolButtonList component's definition in toolbarButtons.ts + // { + // id: 'MeasurementTools', // ID of this ToolButtonList component + // uiType: 'ohif.toolButtonList', + // props: { + // buttonSection: true // This ToolButtonList will render the section named 'MeasurementTools' + // } + // } + ``` + + later you can use it like + + + ```javascript + toolbarService.updateSection('MeasurementTools', ['Length', 'Bidirectional', ...]); + ``` + + * **B. Flexible Approach: `buttonSection: 'customSectionName'` (Explicit Section ID)** + + You can explicitly provide a string for `props.buttonSection` if the button should be associated with a section ID that is different from its own `id`, or if you prefer explicit naming. + + ```javascript + // Example: A ToolButtonList component's definition + // { + // id: 'MySpecialToolList', // ID of this ToolButtonList component + // uiType: 'ohif.toolButtonList', + // props: { + // buttonSection: 'toolsForAdvancedUsers', // This list renders 'toolsForAdvancedUsers' section + // } + // } + ``` + + * **`evaluate` Function Enhancement:** + * Button `evaluate` functions can now leverage `evaluateProps: { hideWhenDisabled: true }` in your button definition to automatically hide a button when it's disabled. + + * **Wrapper Component `onInteraction` (e.g., `ToolButtonListWrapper`):** + * Update wrappers like `ToolBoxButtonGroupWrapper` and `ToolButtonListWrapper`: + * The `groupId` prop is replaced by `id` (which is the ID of the wrapper button component itself). + * The `onInteraction` callback in these wrappers now provides `id` (the wrapper's ID) instead of `groupId`. + + +4. **Adopt `IconPresentationProvider` (Optional but Recommended):** + * For consistent icon styling across your application's toolbars, wrap a high-level component (like your main `Header` or layout component) with ``. + * Custom tool button components can then use the `useIconPresentation` hook to get appropriate class names for icons or a pre-styled `IconContainer`. + + ```diff + // In your main App.tsx or Header.tsx + + import { IconPresentationProvider, ToolButton } from '@ohif/ui-next'; + // ... + + + {/* Your Header content including Toolbars */} + + + + // In a custom tool button using icons + + import { useIconPresentation, Icons } from '@ohif/ui-next'; + + function MyCustomToolButton({ iconName }) { + + const { className: iconClassName } = useIconPresentation(); + + return ; + + } + ``` + +5. **Remove Legacy Component Usage:** + * Replace any usage of `ToolbarSplitButtonWithServicesLegacy` and `ToolbarButtonGroupWithServicesLegacy` with the newer patterns, typically by configuring individual buttons and using `ToolButtonList` or `ButtonGroup` from `@ohif/ui-next` directly, driven by `useToolbar`. diff --git a/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/ui.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/ui.md new file mode 100644 index 000000000..074790e5d --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/ui.md @@ -0,0 +1,60 @@ +--- +sidebar_position: 5 +sidebar_label: UI +summary: Migration guide for OHIF 3.11's UI changes, including the transition from `ViewportActionCornersService` to `ToolbarService` and the introduction of `useToolbar` hook. +--- + + +## New useIconPresentation hook + +This section details the introduction of the `IconPresentationProvider` and `useIconPresentation` hook, offering an optional way to manage icon size and container styling within the UI. + +### Key Changes: + +* **New Context and Hook:** Introduction of `IconPresentationProvider` and `useIconPresentation` to provide a standardized way to control the size and potentially the container component/props for icons and related interactive elements (like `ToolButton`). + +### Migration Steps: + +Using the `IconPresentationProvider` is **entirely optional**. If you do not wrap your components with this provider, components like `ToolButton` will continue to use their explicit `size` prop and default styling. + +However, if you wish to centrally manage the presentation of icons within a specific part of your application's component tree, follow these steps: + +1. **Identify the component subtree:** Determine which section of your UI you want to apply consistent icon styling to. + +2. **Wrap with `IconPresentationProvider`:** Wrap the root of that component subtree with the `IconPresentationProvider`. Pass the desired `size` prop. You can also optionally provide a custom `IconContainer` component and `containerProps` if you want to change the wrapper around the icon itself (e.g., switching from a `Button` to a `ToolButton` or applying specific styling). + + ```jsx + import { IconPresentationProvider, ToolButton } from '@ohif/ui-next'; + + function MyComponentTree() { + return ( + // Icons and ToolButtons within this provider will inherit 'large' size + + {/* Any components inside that consume the context */} + + {/* ... other components ... */} + + ); + } + ``` + +3. **Consume the context in components (if building custom components):** If you are building a custom component that renders an icon and want it to respect the provider's settings, use the `useIconPresentation` hook within that component. This hook provides the configured size, a calculated CSS class name (`className`), the specified `IconContainer` component, and its `containerProps`. + + ```jsx + import React from 'react'; + import { useIconPresentation, Icons } from '@ohif/ui-next'; + + function MyCustomIconButton({ iconName, ...rest }) { + // This hook reads the nearest IconPresentationProvider context + const { className, IconContainer, containerProps } = useIconPresentation(); + + // Use the provided IconContainer and its props + return ( + + {/* Use the calculated className for the icon */} + + + ); + } + ``` + *Note: Built-in components like `ToolButton` in `@ohif/ui-next` have been updated internally to consume this context automatically if a provider is available.* diff --git a/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/viewport-action-menu.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/viewport-action-menu.md new file mode 100644 index 000000000..b2b1fd307 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p10-to-3p11/viewport-action-menu.md @@ -0,0 +1,124 @@ +--- +sidebar_position: 1 +sidebar_label: Viewport Corners +summary: Migration guide for OHIF 3.11's viewport corners customization changes, including the transition from individual item configurations to location-based arrays and the removal of index priorities. +--- + + +Okay, here's a migration guide based on the provided diff, focusing on the introduction of `TrackingStatus`, `ModalityLoadBadge`, and `NavigationComponent`. + +**Key Changes:** + +* **Deprecated `ViewportActionCornersService`**: The `ViewportActionCornersService` and its associated provider (`ViewportActionCornersProvider`) have been removed. UI elements previously managed by this service are now typically handled by dedicated components integrated via the `ToolbarService`. +* **New Centralized UI Components**: + * `ModalityLoadBadge`: A new component in `@ohif/extension-cornerstone` that displays the status (e.g., SEG/RT/SR loaded or requiring hydration) and a "LOAD" button for secondary display sets (SEG, RTSTRUCT, SR). This replaces the inline status and load logic within individual viewport components like `OHIFCornerstoneSEGViewport` and `OHIFCornerstoneRTViewport`. + * `TrackingStatus`: A new component in `@ohif/extension-cornerstone` to indicate if measurements in a viewport are being tracked. This replaces inline tracking status indicators previously in `OHIFCornerstoneSRMeasurementViewport` and `TrackedCornerstoneViewport`. + * `NavigationComponent`: A new component in `@ohif/extension-cornerstone` that provides navigation arrows (e.g., for segments in SEG/RT or measurements in SR/tracked series). This replaces the `ViewportActionArrows` previously instantiated directly within viewport components. +* **Viewport Simplification**: Viewport components like `OHIFCornerstoneSEGViewport`, `OHIFCornerstoneRTViewport`, and `OHIFCornerstoneSRMeasurementViewport` have been simplified. They no longer manage their own status indicators, load buttons, or navigation arrows. They now primarily delegate rendering to `OHIFCornerstoneViewport`. +* **Refactored Hydration Prompts**: Utility functions like `promptHydrateSEG` and `promptHydrateRT` now use a centralized `utils.promptHydrationDialog` from `@ohif/extension-cornerstone`. +* **Centralized Hydration Command**: A new command `hydrateSecondaryDisplaySet` has been added to `@ohif/extension-cornerstone` to handle the hydration logic for SEG, RTSTRUCT, and SR display sets. +* **New Hooks**: Several new hooks have been introduced in `@ohif/extension-cornerstone` (e.g., `useViewportDisplaySets`, `useMeasurementTracking`, `useViewportSegmentations`, `useViewportHover`) to provide data and state for these new UI components. + +**Migration Steps:** + +1. **Remove `ViewportActionCornersService` Usage**: + * If you were using `ViewportActionCornersService` to add custom components to viewport corners, you will need to refactor this. The recommended approach is to define these components as toolbar buttons and place them in designated viewport action menu sections (e.g., `viewportActionMenu.topLeft`) using the `ToolbarService`. + * The internal status components (`_getStatusComponent`) and `ViewportActionArrows` within specific viewports (SEG, RT, SR) have been removed. Their functionality is now provided by `ModalityLoadBadge`, `TrackingStatus`, and `NavigationComponent`. + + +3. **Integrate New UI Components via `ToolbarService`**: + * The `ModalityLoadBadge`, `TrackingStatus`, and `NavigationComponent` are now registered with the `ToolbarService` within the `@ohif/extension-cornerstone`'s `getToolbarModule`. + * Modes (e.g., `longitudinal`) should define toolbar sections for viewport corners and add these components to those sections. + + *Example: Adding components to viewport corners in `longitudinal` mode* + ```diff + // modes/longitudinal/src/index.ts + function modeFactory({ modeConfiguration }) { + return { + // ... + onModeEnter: ({ servicesManager, extensionManager, commandsManager }: withAppTypes) => { + // ... + toolbarService.addButtons(toolbarButtons); + toolbarService.createButtonSection('primary', [ + // ... primary tools + ]); + + + toolbarService.updateSection(toolbarService.sections.viewportActionMenu.topLeft, [ + + 'orientationMenu', + + 'dataOverlayMenu', + + 'windowLevelMenu', + + ]); + + toolbarService.updateSection(toolbarService.sections.viewportActionMenu.topRight, [ + + 'modalityLoadBadge', + + 'trackingStatus', + + 'navigationComponent', + + ]); + // ... + }, + ``` + And ensure these buttons are defined in your mode's `toolbarButtons.ts`: + ```diff + // modes/longitudinal/src/toolbarButtons.ts + + { + + id: 'modalityLoadBadge', + + uiType: 'ohif.modalityLoadBadge', + + props: { + + // ... props like icon, label, tooltip, evaluate + + evaluate: { + + name: 'evaluate.modalityLoadBadge', + + hideWhenDisabled: true, + + }, + + }, + + }, + + { + + id: 'navigationComponent', + + uiType: 'ohif.navigationComponent', + + props: { + + // ... props + + evaluate: { + + name: 'evaluate.navigationComponent', + + hideWhenDisabled: true, + + }, + + }, + + }, + + { + + id: 'trackingStatus', + + uiType: 'ohif.trackingStatus', + + props: { + + // ... props + + evaluate: { + + name: 'evaluate.trackingStatus', + + hideWhenDisabled: true, + + }, + + }, + + }, + ``` + + +5. **Direct Import of `OHIFCornerstoneViewport`**: + * Extensions that were previously getting the cornerstone viewport component dynamically via `extensionManager.getModuleEntry('@ohif/extension-cornerstone.viewportModule.cornerstone')` should now import `OHIFCornerstoneViewport` directly from `@ohif/extension-cornerstone`. + + ```diff + // extensions/cornerstone-dicom-pmap/src/viewports/OHIFCornerstonePMAPViewport.tsx + import PropTypes from 'prop-types'; + import React, { useCallback, useEffect, useRef, useState } from 'react'; + import { useViewportGrid } from '@ohif/ui-next'; + +import { OHIFCornerstoneViewport } from '@ohif/extension-cornerstone'; + + function OHIFCornerstonePMAPViewport(props: withAppTypes) { + // ... + const getCornerstoneViewport = useCallback(() => { + - const { component: Component } = extensionManager.getModuleEntry( + - '@ohif/extension-cornerstone.viewportModule.cornerstone' + - ); + // ... + return ( + - + + /> + ); + // ... + ``` diff --git a/platform/docs/versioned_docs/version-3.11/migration-guide/3p11-to-3p12/index.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p11-to-3p12/index.md new file mode 100644 index 000000000..24c79d596 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p11-to-3p12/index.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 1 +sidebar_label: 3.11 -> 3.12 beta +--- + +# Migration Guide + +This guide provides information about migrating from OHIF version 3.11 to version 3.12 beta diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/0-general.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/0-general.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/0-general.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/0-general.md index 3439456b0..5159f5249 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/0-general.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/0-general.md @@ -1,6 +1,7 @@ --- id: 0-general title: General +summary: General migration changes from OHIF 3.8 to 3.9, including removing SharedArrayBuffer requirements, React 18 updates, Polyfill removal, webpack changes, scroll utility relocation, Crosshairs improvements, and toolbar button evaluation enhancements. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md similarity index 87% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md index c8a92efa0..2f89a7b4d 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/1-Architecture.md @@ -1,6 +1,7 @@ --- id: seg-new-arch title: New Architecture +summary: Overview of the new viewport-centric segmentation architecture in OHIF 3.9, which replaces the previous toolGroup-centric approach and introduces clearer separation between segmentation data and its visual representation. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md index 06601b7cd..3bb7356a6 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/2-segmentationService-basic.md @@ -1,6 +1,7 @@ --- id: seg-api title: SegmentationService API +summary: Detailed guide to the SegmentationService API changes in OHIF 3.9, covering the transition from toolGroup to viewport-centric segmentation management, updates to key methods like getActiveSegmentation, setActiveSegmentation, and addSegment. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md index 522259276..4e6e6f8f3 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/3-segmentationserice-representation.md @@ -1,6 +1,7 @@ --- id: seg-representation title: Segmentation Representations +summary: Migration guide for segmentation representation management in OHIF 3.9, explaining the transition from toolGroup-based to viewport-centric representation handling, and introducing the new specifier pattern for more flexible API usage. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md similarity index 94% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md index c70021e33..7d3b65b7f 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-creation.md @@ -1,6 +1,7 @@ --- id: seg-creation -title: Segmentation Creation +title: Segmentation Creation +summary: Migration guide for segmentation creation methods in OHIF 3.9, covering renamed methods like createLabelmapForViewport and createLabelmapForDisplaySet, updated parameter structures, and transition from tool group to viewport-centric approach. --- ## createEmptySegmentationForViewport diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md index ebe16f7c1..f63f41df2 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/4-segmentationserice-modification.md @@ -1,6 +1,7 @@ --- id: seg-service-mod title: SegmentationService Modifications +summary: Migration guide for segmentation representation management API changes in OHIF 3.9, showing how to transition from tool group-based methods to viewport-centric approaches for adding, removing, and querying segmentation representations. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md index 266206bf1..44afef24c 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/5-segmentationserice-style.md @@ -1,6 +1,7 @@ --- id: seg-style title: SegmentationService Style +summary: Migration guide for segmentation styling API changes in OHIF 3.9, covering the transition to viewport-specific visibility controls, new style specification system using the specifier pattern, and updated methods for setting colors and toggling visibility. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md index 1236787e1..a13cd718f 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/6-segmentationserice-other.md @@ -1,6 +1,7 @@ --- id: seg-other title: Other Changes +summary: Migration guide for additional segmentation service changes in OHIF 3.9, covering updates to addOrUpdateSegmentation with new data structures, loadSegmentationsForViewport, highlightSegment, and jumpToSegmentCenter methods with viewport-centric approach. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/index.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/index.md similarity index 72% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/index.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/index.md index f4a7a6744..b6fa29f88 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/1-segmentation/index.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/1-segmentation/index.md @@ -2,6 +2,7 @@ id: segmentation-index title: Segmentation sidebar_position: 1 +summary: Migration guide for segmentation architecture changes in OHIF 3.9, covering the shift from tool group-centric to viewport-centric architecture to support advanced visualization capabilities and more flexible segmentation handling. --- import DocCardList from '@theme/DocCardList'; diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/2-Renamings.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/2-Renamings.md similarity index 80% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/2-Renamings.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/2-Renamings.md index 6c0763f3c..95866fe74 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/2-Renamings.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/2-Renamings.md @@ -2,6 +2,7 @@ id: 2-renamings title: Renamings sidebar_position: 2 +summary: Migration guide for renamed components in OHIF 3.9, including the Panel Measurements name change from 'measure' to 'panelMeasurement' and addIcon utility changes to support both UI packages. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/3-DataSources.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/3-DataSources.md similarity index 82% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/3-DataSources.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/3-DataSources.md index 2d14adf53..26f7c97cf 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/3-DataSources.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/3-DataSources.md @@ -2,6 +2,7 @@ id: 3-data-sources title: Data Sources sidebar_position: 3 +summary: Migration guide for BulkDataURI configuration changes in OHIF 3.9, explaining the transition from a simple boolean flag to a more flexible configuration object with additional control options. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/4-Measurements.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/4-Measurements.md similarity index 89% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/4-Measurements.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/4-Measurements.md index d4b89faf3..8db5dd774 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/4-Measurements.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/4-Measurements.md @@ -1,5 +1,6 @@ --- title: Measurements +summary: Migration guide for measurement changes in OHIF 3.9, covering the new structured 'displayText' object with primary and secondary arrays for better organization, and the renaming of 'selected' property to 'isSelected'. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md similarity index 88% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md index 7b85dafc0..74a02af61 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/4-ViewportActionCorner.md @@ -1,6 +1,7 @@ --- id: viewport-action-corner title: ViewportActionCorner +summary: Migration guide for ViewportActionCornerService in OHIF 3.9, introducing the new addComponent and addComponents methods that provide more reliable positioning of multiple components within viewport corners. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/5-StateSyncService.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/5-StateSyncService.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/5-StateSyncService.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/5-StateSyncService.md index 230683c85..d12144406 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/5-StateSyncService.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/5-StateSyncService.md @@ -1,6 +1,7 @@ --- id: state-sync-service title: StateSyncService +summary: Migration guide for transitioning from StateSyncService to Zustand stores in OHIF 3.9, covering all store types including LutPresentationStore, PositionPresentationStore, ViewportGridStore, and more with examples of old and new API usage. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/6-RTSTRUCT.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/6-RTSTRUCT.md similarity index 71% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/6-RTSTRUCT.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/6-RTSTRUCT.md index f13bf9130..4ecc3ad6e 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/6-RTSTRUCT.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/6-RTSTRUCT.md @@ -2,6 +2,7 @@ id: 6-rtstruct title: RTSTRUCT sidebar_position: 6 +summary: Migration guide for RT Structure Set rendering in OHIF 3.9, explaining the transition from VTK-based rendering to SVG-based rendering for improved stability and speed while maintaining stack viewports instead of converting to volume viewports. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/7-UI.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/7-UI.md similarity index 94% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/7-UI.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/7-UI.md index 2be4fabf0..74fd307e7 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/7-UI.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/7-UI.md @@ -1,5 +1,6 @@ --- title: UI +summary: Migration guide for UI changes in OHIF 3.9, covering the new UI components from @ohif/ui-next, UINotificationService updates with Sonner integration, viewport pane Tailwind class changes, Header component refactoring, and managing both UI libraries. --- ## New Components diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/8-Refactorings.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/8-Refactorings.md similarity index 90% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/8-Refactorings.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/8-Refactorings.md index c90717d88..2a6fab362 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/8-Refactorings.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/8-Refactorings.md @@ -1,5 +1,6 @@ --- title: Refactoring +summary: Migration guide for refactored components in OHIF 3.9, including the move of PanelSegmentation from cornerstone-dicom-seg extension to cornerstone extension, centralization of dialog utilities, and improved customization ID structure for better modularity. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/9-other.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/9-other.md similarity index 94% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/9-other.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/9-other.md index 5bd8b735d..8c2a3cebd 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/9-other.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/9-other.md @@ -1,5 +1,6 @@ --- title: Other Changes +summary: Migration guide for additional changes in OHIF 3.9, covering external library loading with browserImport function, the pluginConfig.json format for dynamic imports, and improvements to viewport navigation using ViewReference methods. --- import Tabs from '@theme/Tabs'; diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/index.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/index.md similarity index 51% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/index.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/index.md index c962a5d55..c6f3393c3 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p8-to-3p9/index.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p8-to-3p9/index.md @@ -2,6 +2,7 @@ id: 3p8-to-3p9 title: 3.8 -> 3.9 sidebar_position: 2 +summary: Migration guide for upgrading from OHIF 3.8 to 3.9, covering segmentation architecture changes, renamings, data sources, measurements, viewport action corners, state sync service, RT structure improvements, UI changes, and other refactorings. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/commands.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/commands.md similarity index 88% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/commands.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/commands.md index 814692669..0f2198be5 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/commands.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/commands.md @@ -1,5 +1,6 @@ --- title: Commands +summary: Migration guide for commands in OHIF 3.10, covering the replacement of deleteMeasurement with removeMeasurement and setSourceViewportForReferenceLinesTool with the more generic setViewportForToolConfiguration command. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/general-m.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/general-m.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/general-m.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/general-m.md index 22b7512ac..6ff64c941 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/general-m.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/general-m.md @@ -1,6 +1,7 @@ --- sidebar_position: 1 title: General +summary: General migration changes from OHIF 3.9 to 3.10, including Node.js version update, HTML template modifications, bundled Google Fonts, docs updates, faster development builds with rsbuild, and webpack configuration changes for AI segmentation support. --- ## Node.js Version Update diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/hotkeys.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/hotkeys.md similarity index 94% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/hotkeys.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/hotkeys.md index 80fc94a31..b2a01d617 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/hotkeys.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/hotkeys.md @@ -1,6 +1,7 @@ --- sidebar_position: 2 title: Hotkeys +summary: Migration guide for hotkeys management in OHIF 3.10, explaining the transition from defining hotkeys in mode factory to using the customizationService, with examples of replacing, adding, and modifying hotkey bindings. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/routerBaseName.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/routerBaseName.md similarity index 92% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/routerBaseName.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/routerBaseName.md index de39916ac..e6eb0b3c4 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/1-General/routerBaseName.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/1-General/routerBaseName.md @@ -1,5 +1,6 @@ --- title: routerBaseName +summary: Migration guide for router configuration in OHIF 3.10, covering the updated default behavior of routerBasename and its interaction with PUBLIC_URL, with scenario-based examples for both root and subpath hosting. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/2-CustomizationService/index.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/2-CustomizationService/index.md similarity index 98% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/2-CustomizationService/index.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/2-CustomizationService/index.md index ad3252fc6..9d2db05b0 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/2-CustomizationService/index.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/2-CustomizationService/index.md @@ -1,6 +1,7 @@ --- sidebar_position: 2 title: Customization Service +summary: Migration guide for OHIF's Customization Service from 3.9 to 3.10, covering unified customization getters, simplified registration, new commands, renamed customizations, and updated patterns for modifying UI components. --- # CustomizationService diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md similarity index 73% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md index 230c78d3a..39c2335e0 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/1-Introduction.md @@ -1,6 +1,7 @@ --- title: Introduction position: 1 +summary: Introduction to UI changes in OHIF 3.10, covering the migration of the image viewer to the @ohif/ui-next library, a complete rewrite of UI components offering extensibility, accessibility, and a modern design, with guidance on updating custom panels. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md similarity index 89% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md index 17e8a9689..45c4cef3c 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/10-Migration-3p10-Tests.md @@ -1,5 +1,6 @@ --- title: Tests +summary: Migration guide for test updates in OHIF 3.10, covering changes to how tools are identified and tested, including the transition from class-based to data-attribute-based selection in Cypress tests. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md index ea98850b0..14b7313b4 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/1a-Colors.md @@ -1,5 +1,6 @@ --- title: Colors +summary: Migration guide for OHIF 3.10's new color system, explaining the transition from custom color names to a semantic color palette using CSS variables, with detailed mapping of old color classes to new Tailwind equivalents. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md similarity index 89% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md index 7a2afed4d..fab2d3982 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/2-Migration-3p10-Icons.md @@ -1,5 +1,6 @@ --- title: Icons +summary: Migration guide for OHIF 3.10's Icon component updates, covering the transition from @ohif/ui to @ohif/ui-next with new PascalCase naming conventions, legacy fallback options, and a comprehensive renaming table for all icons. --- ## Migration Guide: Icon Component Updates @@ -132,6 +133,67 @@ import { Icons } from '@ohif/ui-next'; ``` + + +### Creating New Custom Icons + +This section explains how to migrate your custom icons from the old SVG import method to the new React component-based system in `@ohif/ui-next`. The new approach improves consistency, allows for better tree-shaking, and provides type safety. + +The process involves converting your existing SVG files into React components and then registering them. + +#### 1. Convert SVG to a React Component + +First, take your raw SVG file and convert it into a `.tsx` React functional component. + +**Before: Raw SVG File** + +Previously, you might have had a file like `Baseline.svg`: + +```xml +// Baseline.svg + + < some svg content> + +``` + +**After: React Icon Component** + +Now, create a `.tsx` file that exports a React component. Note the following changes: +- SVG attributes like `text-anchor` and `stroke-width` are converted to camel case (i.e. `textAnchor`, `strokeWidth`). +- The component accepts `IconProps` and spreads them onto the root `` element. + +```typescript +// Baseline.tsx +import React from 'react'; +import type { IconProps } from '../types'; + +export const Baseline = (props: IconProps) => ( + + < some svg content> + +); + +export default Baseline; +``` + +#### 2. Register the New Icon + +After creating the component, you must register it with the `Icons` service from `@ohif/ui-next`. This is typically done in a centralized location where you initialize your UI components (for example, an extension's preRegistration is a good spot for this). You'll need a unique name for the icon, which can be managed with an enum for consistency. + +```typescript +// Example: in your setup/initialization code +import { Icons, IconNameEnum } from '@ohif/ui-next'; +import Baseline from './sources/Baseline'; // Import your new icon component + +// Add the icon to the registry +Icons.addIcon(IconNameEnum.BASELINE, Baseline); +``` + +By following these steps, your custom icon will be available for use throughout the application just like any of the default icons. + + + + ### Detailed Renaming Table | Old Icon Name | New Icon Component Name | Example Usage (`Icons.`) | Notes | diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md index 887966a14..a1acdb739 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/2a-Migration-3p10-Button.md @@ -1,5 +1,6 @@ --- title: Button +summary: Migration guide for Button components in OHIF 3.10, explaining the transition from @ohif/ui to @ohif/ui-next, the replacement of ButtonEnums with string-based variants, and changes to IconButton, ButtonGroup, and styling approach. --- ## Key Changes: diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md similarity index 98% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md index bc4816cea..a2b2e57aa 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/3-Migration-3p10-Input.md @@ -1,5 +1,6 @@ --- title: Input +summary: Migration guide for input components in OHIF 3.10, covering the transition from Input, InputNumber, InputRange, InputDoubleRange and others to the new Numeric component system and updated input patterns in @ohif/ui-next. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md similarity index 87% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md index 80a33acaa..90796a2ca 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/4-Migration-3p10-Tooltip.md @@ -1,5 +1,6 @@ --- title: Tooltip +summary: Migration guide for Tooltip components in OHIF 3.10, explaining the new composable structure with TooltipTrigger and TooltipContent, and replacement of TooltipClipboard with the Clipboard component. --- ## Tooltip Updates diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md index 27e5cdf28..ee708385f 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Select.md @@ -1,5 +1,6 @@ --- -title: Tooltip +title: Select +summary: Migration guide for Select components in OHIF 3.10, explaining the transition from @ohif/ui to @ohif/ui-next, with details on the new Select.Root, Select.Trigger, Select.Content, and Select.Item structure replacing the old dropdown approach. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md index 981958eee..1f26ea69f 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/4a-Migration-3p10-Switch.md @@ -1,5 +1,6 @@ --- title: Switch +summary: Migration guide for Switch component in OHIF 3.10, covering the transition from custom Toggle and CinePlayPauseButton components to the standardized Switch component, with details on prop changes and usage patterns. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md index ae4041cc0..4c6c8ee1b 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/5-Migration-3p10-Toolbar.md @@ -1,5 +1,6 @@ --- title: Toolbar +summary: Migration guide for toolbar components in OHIF 3.10, covering the new uiType values (ohif.toolButton and ohif.toolButtonList), section-based definitions replacing nested structures, ToolBox updates, and changes to tool option handlers. --- # Toolbar diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md similarity index 92% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md index 713f44ec3..a02fef59c 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/6-Migration-3p10-SegmentationTable.md @@ -1,5 +1,6 @@ --- title: Segmentation Table +summary: Migration guide for the refactored SegmentationTable component in OHIF 3.10, covering changes to the context system, compound component pattern adoption, replacement of SelectorHeader, and introduction of segment statistics features. --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md similarity index 85% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md index 16ac94663..d18dce99e 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/7-Migration-3p10-Tours.md @@ -1,5 +1,6 @@ --- title: Tours and Onboarding +summary: Migration guide for Tours and Onboarding features in OHIF 3.10, explaining the transition from defining tours directly in window.config.tours to using the customization service, enabling mode-specific tours and better organization. --- ## Migration Guide: Tours diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md similarity index 65% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md index 960029bda..835cd828c 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/8-Migration-3p10-DialogService.md @@ -1,5 +1,6 @@ --- title: uiDialogService +summary: Migration guide for uiDialogService in OHIF 3.10, covering the transition from create/dismiss to show/hide methods, changes to dialog definition structure, and updates to utility functions like callInputDialog and colorPickerDialog. --- @@ -59,6 +60,32 @@ This guide details the migration steps for the `uiDialogService` API changes, ba | `shouldCloseOnOverlayClick` | Default off for dialogs - Controls whether clicking the overlay background will close the dialog. | +### Frequently Asked Questions + +**Q: Why did my dialog's background color change?** + +A: This can happen if you were previously setting the background color on the dialog's content directly. With the new API, the dialog's content is wrapped in a container. You should now pass any background or text color classes using the `containerClassName` property. + +For example: +```diff +- containerClassName: 'w-[70%] max-w-[900px]', ++ containerClassName: 'w-[70%] max-w-[900px] bg-primary-dark text-foreground', +``` + +**Q: How do I create a dialog without the default container, like for a context menu?** + +A: If you need to render dialog content without the standard dialog container (e.g., for a context menu), you can use the `unstyled: true` prop. This will render your component without the default dialog wrapper, giving you full control over its appearance. + +```javascript +uiDialogService.show({ + id: 'context-menu', + content: MyContextMenuComponent, + contentProps: { /* ... */ }, + unstyled: true, +}); +``` + + **Migration Steps:** 1. **Replace `.create()` with `.show()`:** @@ -117,47 +144,109 @@ This guide details the migration steps for the `uiDialogService` API changes, ba } ``` +6. **Update Footer Action Buttons:** + + Previously, footer buttons might have been implemented using generic `

{message}

, - onClose: () => uiDialogService.dismiss({ id: dialogId }), + title: 'Action Completed', + noCloseButton: true, + onClose: dismiss, + onSubmit: dismiss, + actions: [ + { id: 'proceed', text: 'Proceed', type: 'primary' }, + ], + body: () => ( +
{successMessage}
+ ), }, }); }; +``` + +**After: Using a Dedicated Component** + +The new pattern involves creating a dedicated React component for your dialog's content. This component encapsulates its own layout, logic, and actions, leading to cleaner and more maintainable code. + +**1. Create a dedicated component for your dialog's content.** + +This component receives `hide` and any custom data via props. It manages its own UI, including the footer buttons, and handles the logic for what happens when a user interacts with it. + +```javascript +// After: MyCompletionDialog.tsx +function MyCompletionDialog({ hide, successMessage }) { + const closeAndProceed = () => { + hide(); + // You can now handle any post-dialog logic here, + // such as navigating to a different page. + // navigate('/next-page'); + }; -// After (using new API) -function AlertDialog({ message, hide }) { return ( -
-

{message}

- +
+
{successMessage}
+ + + + Proceed + + +
); } - -const showAlert = (message) => { - uiDialogService.show({ - id: 'alert-dialog', - title: 'Alert', - content: AlertDialog, - contentProps: { message }, - }); -}; - ``` +**2. Call `uiDialogService.show` with the new component.** + +The call to show the dialog is now much simpler. You pass the component itself to the `content` property and any necessary data through `contentProps`. + +```javascript +// After: Calling the service +const showCompletionDialog = (successMessage) => { + uiDialogService.show({ + id: 'my-complex-dialog', + title: 'Action Completed', + content: MyCompletionDialog, + contentProps: { + successMessage, + }, + }); +}; +``` --- diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md similarity index 59% rename from platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md index 1cd2d9022..09746de95 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/3-UI/9-Migration-3p10-ModalService.md @@ -1,5 +1,6 @@ --- title: uiModalService +summary: Migration guide for the uiModalService in OHIF 3.10, covering props that remain unchanged, renamed props (containerDimensions to containerClassName), removed props (movable, isOpen, contentDimensions), and automatic handling of modal closing. --- @@ -35,6 +36,17 @@ title: uiModalService | `closeButton` | The component now manages modal closing internally. If you need a close button, you can add one, perhaps by checking out the `FooterActions` component. | +### Frequently Asked Questions + +**Q: Why did my dialog's background color change?** + +A: This can happen if you were previously setting the background color on the dialog's content directly. With the new API, the dialog's content is wrapped in a container. You should now pass any background or text color classes using the `containerClassName` property. + +For example: +```diff +- containerClassName: 'w-[70%] max-w-[900px]', ++ containerClassName: 'w-[70%] max-w-[900px] bg-primary-dark text-foreground', +``` **Migration Steps:** @@ -102,3 +114,60 @@ Previously, you had to pass in the `onClose` as `hide` function automatically ad + }, + }); ``` + +6. **Update Footer Action Buttons:** + + Previously, footer buttons might have been implemented using generic ` + + + + + + Cancel + + + + + ``` + +**Example: Simple Alert Modal** + +This example shows how to migrate a simple alert modal. + +*Before:* + +```js +uiModalService.show({ + title: 'Untrack Series', + content: UntrackSeriesModal, + contentProps: { + onConfirm, + hide, // passed in automatically in the background + }, +}); +``` + +*After:* + +```js +function UntrackSeriesModal({ onConfirm, hide }) { + return ( +
+ {/* Modal content */} +
+ ); +} + +// Show the modal +uiModalService.show({ + title: 'Untrack Series', + content: UntrackSeriesModal, + contentProps: { + onConfirm, + hide, // passed in automatically in the background + }, +}); +``` diff --git a/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/index.md b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/index.md new file mode 100644 index 000000000..e2da5ae32 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/3p9-to-3p10/index.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 1 +sidebar_label: 3.9 -> 3.10 +title: Migration Guide from 3.9 to 3.10 beta +summary: Migration guide for upgrading from OHIF 3.9 to 3.10 beta, covering general changes, customization service improvements, UI component upgrades, command handling, hotkey updates, routing changes, and testing strategies. +--- + +# Migration Guide + + +## General diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/_category_.json b/platform/docs/versioned_docs/version-3.11/migration-guide/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/migration-guide/_category_.json rename to platform/docs/versioned_docs/version-3.11/migration-guide/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/from-3p7-to-3p8.md b/platform/docs/versioned_docs/version-3.11/migration-guide/from-3p7-to-3p8.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/migration-guide/from-3p7-to-3p8.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/from-3p7-to-3p8.md index b07d8ffe0..0b460dc33 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/from-3p7-to-3p8.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/from-3p7-to-3p8.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: 3.7 -> 3.8 +title: Migration Guide from 3.7 to 3.8 +summary: Migration guide for upgrading from OHIF 3.7 to 3.8, covering changes to toolbar button definitions, active tool handling, button evaluators, tool listeners, leftPanel/rightPanel naming, URL parameters, UI components, and refactoring of enums. --- # Migration Guide diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/from-v2.md b/platform/docs/versioned_docs/version-3.11/migration-guide/from-v2.md similarity index 99% rename from platform/docs/versioned_docs/version-3.10/migration-guide/from-v2.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/from-v2.md index 920f4d095..aa5c531ed 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/from-v2.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/from-v2.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: 2.x -> 3.5 +title: Migration Guide from 2.x to 3.5 +summary: Comprehensive migration guide for upgrading from OHIF 2.x to 3.5, covering architectural changes, UI improvements, extensions, modes, cornerstone3D integration, configuration changes, and build process updates. --- # Migration Guide diff --git a/platform/docs/versioned_docs/version-3.10/migration-guide/index.md b/platform/docs/versioned_docs/version-3.11/migration-guide/index.md similarity index 58% rename from platform/docs/versioned_docs/version-3.10/migration-guide/index.md rename to platform/docs/versioned_docs/version-3.11/migration-guide/index.md index 85d2af849..a293b5cf4 100644 --- a/platform/docs/versioned_docs/version-3.10/migration-guide/index.md +++ b/platform/docs/versioned_docs/version-3.11/migration-guide/index.md @@ -1,5 +1,7 @@ --- id: index +title: Migration Guides Overview +summary: Introduction to OHIF migration guides covering the upgrade paths between different versions of the platform, with links to version-specific guides for migrating from one OHIF version to another. --- diff --git a/platform/docs/versioned_docs/version-3.10/platform/_category_.json b/platform/docs/versioned_docs/version-3.11/platform/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/platform/_category_.json rename to platform/docs/versioned_docs/version-3.11/platform/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/platform/browser-support.md b/platform/docs/versioned_docs/version-3.11/platform/browser-support.md similarity index 86% rename from platform/docs/versioned_docs/version-3.10/platform/browser-support.md rename to platform/docs/versioned_docs/version-3.11/platform/browser-support.md index fa31439c3..e98426213 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/browser-support.md +++ b/platform/docs/versioned_docs/version-3.11/platform/browser-support.md @@ -1,5 +1,7 @@ --- sidebar_position: 2 +title: Browser Support +summary: Documentation of OHIF's browser compatibility standards, including supported browsers (IE11, Firefox, Chrome, Safari, Edge), transpilation and polyfill strategies, and development priorities focused on modern evergreen browsers. --- # Browser Support diff --git a/platform/docs/versioned_docs/version-3.10/platform/environment-variables.md b/platform/docs/versioned_docs/version-3.11/platform/environment-variables.md similarity index 76% rename from platform/docs/versioned_docs/version-3.10/platform/environment-variables.md rename to platform/docs/versioned_docs/version-3.11/platform/environment-variables.md index df5da9e03..a316c9ed9 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/environment-variables.md +++ b/platform/docs/versioned_docs/version-3.11/platform/environment-variables.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Environment Variables +title: Environment Variables +summary: Documentation of the environment variables used in OHIF during build time to configure application behavior, including application settings, internationalization options, and methods for setting these variables. --- # Environment Variables diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/_category_.json b/platform/docs/versioned_docs/version-3.11/platform/extensions/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/_category_.json rename to platform/docs/versioned_docs/version-3.11/platform/extensions/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/extension.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/extension.md similarity index 86% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/extension.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/extension.md index 148b82a9f..706a7b049 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/extension.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/extension.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Extension Manager +title: OHIF Extension Manager +summary: Documentation for OHIF's ExtensionManager class, which manages the registration and access of extensions, providing methods to retrieve module entries, access data sources, and handle extension configurations. --- # Extension Manager diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/index.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/index.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/index.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/index.md index d9c630ecb..1a1801ae4 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/index.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: OHIF Extensions Introduction +summary: Comprehensive introduction to the OHIF viewer extension system, explaining how extensions provide modular functionality through different module types, and how they're configured and accessed in modes to build customized viewer experiences. --- # Introduction diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/installation.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/installation.md similarity index 58% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/installation.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/installation.md index 2e5fb81c2..af49ed17c 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/installation.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/installation.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Installation +title: Extension Installation +summary: Instructions for installing external OHIF extensions using the OHIF CLI tool, which allows adding both local and published extensions from NPM to the viewer application. --- # Extension: Installation diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/lifecycle.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/lifecycle.md similarity index 92% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/lifecycle.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/lifecycle.md index 27868888c..489694c9c 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/lifecycle.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/lifecycle.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Lifecycle Hooks +title: Extension Lifecycle Hooks +summary: Documentation for OHIF extension lifecycle hooks including preRegistration, onModeEnter, and onModeExit, which allow extensions to initialize resources, handle mode transitions, and clean up data when needed. --- # Extensions: Lifecycle Hooks diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/_category_.json b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/_category_.json rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/commands.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/commands.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/commands.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/commands.md index b37202bf6..840c5bc48 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/commands.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/commands.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Commands +title: Commands Module +summary: Documentation for OHIF Commands Module, which allows extensions to register functions that can be called by tools, UI components, or hotkeys, with context-specific implementations and flexible command definitions. --- # Module: Commands diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/contextModule.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/contextModule.md similarity index 75% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/contextModule.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/contextModule.md index 35de381a3..f1bfe48b6 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/contextModule.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/contextModule.md @@ -1,6 +1,8 @@ --- sidebar_position: 9 sidebar_label: Context +title: Context Module +summary: Documentation for OHIF Context Module, which enables component communication via React Context, allowing viewport and panel components to share state and synchronize through a common provider mechanism. --- # Module: Context diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/data-source.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/data-source.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/data-source.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/data-source.md index 5f682ff9c..3c8004219 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/data-source.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/data-source.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Data Source +title: Data Source Module +summary: Documentation for OHIF Data Source Module, which defines ways to fetch and map data into OHIF's native format, covering built-in sources like dicomweb and dicomjson, and explaining how to create custom data sources for proprietary backends. --- # Module: Data Source diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/hpModule.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/hpModule.md similarity index 98% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/hpModule.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/hpModule.md index 8920ccc25..1fb26c3a6 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/hpModule.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/hpModule.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: Hanging Protocol +title: Hanging Protocol Module +summary: Documentation for OHIF Hanging Protocol Module, which controls image arrangement in viewports based on matching rules, with capabilities for layout configuration, viewport settings, synchronization, and advanced study comparison workflows. --- # Module: Hanging Protocol diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/layout-template.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/layout-template.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/layout-template.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/layout-template.md index 821444975..f5d1fcfdd 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/layout-template.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/layout-template.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: Layout Template +title: Layout Template Module +summary: Documentation for OHIF Layout Template Module, which defines the structural organization of the viewer interface, controlling toolbar positioning, panel arrangement, and viewport grid placement through React components. --- # Module: Layout Template diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/panel.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/panel.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/panel.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/panel.md index 9a9235cee..2b48ebd4f 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/panel.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/panel.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Panel +title: Panel Module +summary: Documentation for OHIF Panel Module, which provides UI components for the application's side panels, allowing extensions to contribute content that appears in left and right sidebars with proper event triggering and state management. --- # Module: Panel diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/sop-class-handler.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/sop-class-handler.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/sop-class-handler.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/sop-class-handler.md index cf70fb42f..5d8757e57 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/sop-class-handler.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/sop-class-handler.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: SOP Class Handler +title: SOP Class Handler Module +summary: Documentation for OHIF SOP Class Handler Module, which processes specific DICOM SOP classes into displayable sets, supporting various medical imaging formats and defining how different types of DICOM data are prepared for viewing. --- # Module: SOP Class Handler diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/toolbar.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/toolbar.md similarity index 98% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/toolbar.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/toolbar.md index 6d772b930..63197d6b2 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/toolbar.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/toolbar.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Toolbar +title: Toolbar Module +summary: Documentation for OHIF Toolbar Module, which provides UI components and evaluators for the application's toolbar, supporting custom button types, advanced state management, and conditional rendering based on viewport and modality requirements. --- # Module: Toolbar diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/utility.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/utility.md similarity index 85% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/utility.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/utility.md index fbb975d1a..bc44a9f9c 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/utility.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/utility.md @@ -1,6 +1,8 @@ --- sidebar_position: 9 sidebar_label: Utility +title: Utility Module +summary: Documentation for OHIF Utility Module, which exposes reusable functionality from one extension to others, allowing for sharing of internal methods, services, and enumerations across the application architecture. --- # Module: Utility diff --git a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/viewport.md b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/viewport.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/platform/extensions/modules/viewport.md rename to platform/docs/versioned_docs/version-3.11/platform/extensions/modules/viewport.md index b64a13e33..782594c07 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/extensions/modules/viewport.md +++ b/platform/docs/versioned_docs/version-3.11/platform/extensions/modules/viewport.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Viewport +title: Viewport Module +summary: Documentation for OHIF Viewport Module, which provides React components that consume displaySets for viewing medical images and documents, with examples of 2D image viewing, structured reports, PDFs, and performance optimization techniques. --- # Module: Viewport diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/index.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/index.md new file mode 100644 index 000000000..52cc5ee47 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/index.md @@ -0,0 +1,33 @@ +--- +title: Hooks +summary: List of React hooks available in the platform, these are custom hooks that are used to access the state of the platform +--- + +# Hooks + +## [useMeasurements](./useMeasurements.md) +A React hook that provides mapped measurements from the measurement service with automatic updates when measurements change. + +## [useViewportSegmentations](./useViewportSegmentations.md) +A React hook that provides segmentation data and representations for the active viewport with automatic updates when segmentations change. + +## [useMeasurementTracking](./useMeasurementTracking.md) +A React hook that provides measurement tracking information for a specific viewport, including tracking state and tracked measurement UIDs. + +## [useViewportDisplaySets](./useViewportDisplaySets.md) +A React hook that provides access to display sets associated with a viewport, including background, foreground, overlay, and potential display sets. + +## [useViewportHover](./useViewportHover.md) +A React hook that tracks mouse hover state and active status for a specific viewport. + +## [usePatientInfo](./usePatientInfo.md) +A React hook that provides patient information from the active display sets and detects when multiple patients are loaded. + +## [useSearchParams](./useSearchParams.md) +A React hook that provides access to URL search parameters from both the query string and hash fragment. + +## [useDynamicMaxHeight](./useDynamicMaxHeight.md) +A React hook that calculates the maximum height for an element based on its position in the viewport, with automatic recalculation on window resize or data changes. + +## [useSessionStorage](./useSessionStorage.md) +A React hook that provides sessionStorage access with automatic JSON parsing/stringifying and an option to clear data when the page unloads. \ No newline at end of file diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/useDynamicMaxHeight.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/useDynamicMaxHeight.md new file mode 100644 index 000000000..95854c173 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/useDynamicMaxHeight.md @@ -0,0 +1,65 @@ +--- +title: useDynamicMaxHeight +summary: A React hook that calculates the maximum height for an element based on its position in the viewport, with automatic recalculation on window resize or data changes. +--- + +# useDynamicMaxHeight + +The `useDynamicMaxHeight` hook calculates the maximum height an element can have based on its position relative to the bottom of the viewport, ensuring it doesn't overflow or get cut off by the viewport edge. + +## Overview + +This hook is useful for creating responsive UI elements that need to fit within the visible area of the screen without causing scrolling or content overflow. It automatically recalculates the maximum height when the window is resized or when specified data changes, ensuring the element always fits properly. + +## Import + +```js +import { useDynamicMaxHeight } from '@ohif/ui-next'; +``` + +## Usage + +```jsx +function DynamicHeightPanel({ data, children }) { + const { ref, maxHeight } = useDynamicMaxHeight(data, 30, 200); + + return ( +
+ {children} +
+ ); +} +``` + +## Parameters + +- `data` (required): Any data that, when changed, should trigger a recalculation of the maximum height. This can be an array, object, or primitive value. +- `buffer` (optional): Additional space (in pixels) to leave below the element. Defaults to 20px. +- `minHeight` (optional): Minimum height (in pixels) for the element. Defaults to 100px. + +## Returns + +An object containing: + +- `ref`: A React ref object that must be attached to the target DOM element +- `maxHeight`: A CSS-compatible string value for the calculated maximum height (e.g., "500px") + +## Implementation Details + +- The hook uses `window.innerHeight` and the element's position to calculate the available space between the element's top edge and the bottom of the viewport. +- It subtracts the specified buffer from the available height to ensure there's space below the element. +- The calculated height is constrained by the specified minimum height to prevent the element from becoming too small. +- The hook uses `requestAnimationFrame` to ensure the initial calculation happens after the component has been rendered and positioned in the DOM. +- It automatically recalculates the maximum height when: + - The window is resized + - The `data`, `buffer`, or `minHeight` dependencies change +- The hook properly cleans up event listeners and animation frame requests when the component unmounts. + +This hook is particularly useful for panels, menus, and content areas that need to dynamically adjust their height based on their position in the viewport, ensuring a good user experience without unexpected scrolling or content clipping. \ No newline at end of file diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/useMeasurementTracking.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/useMeasurementTracking.md new file mode 100644 index 000000000..b488e86d0 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/useMeasurementTracking.md @@ -0,0 +1,79 @@ +--- +title: useMeasurementTracking +summary: A React hook that provides measurement tracking information for a specific viewport, including tracking state and tracked measurement UIDs. +--- + +# useMeasurementTracking + +The `useMeasurementTracking` hook provides measurement tracking information for a specific viewport, including the tracking state and UIDs of tracked measurements associated with the viewport's series. + +## Overview + +This hook gives components access to tracking information for measurements in a viewport. It monitors the tracked measurements service and measurement service to provide up-to-date tracking states and the list of measurement UIDs associated with the series displayed in the viewport. + +## Import + +```js +import { useMeasurementTracking } from '@ohif/extension-cornerstone'; +``` + +## Usage + +```jsx +function MeasurementTrackingInfo({ viewportId }) { + const { + isTracked, + isLocked, + seriesInstanceUID, + trackedMeasurementUIDs + } = useMeasurementTracking({ + viewportId, + }); + + return ( +
+
Series UID: {seriesInstanceUID}
+
Tracking Status: {isTracked ? 'Tracked' : 'Not Tracked'}
+
Locked: {isLocked ? 'Yes' : 'No'}
+
Tracked Measurements: {trackedMeasurementUIDs.length}
+
    + {trackedMeasurementUIDs.map(uid => ( +
  • {uid}
    • + ))} +
+
+ ); +} +``` + +## Parameters + +- `options` - Configuration options: + - `viewportId` (required): The ID of the viewport to track + +## Returns + +An object containing the following properties: + +- `isTracked`: Boolean indicating if the series in the viewport is currently tracked +- `isLocked`: Boolean indicating if tracking is enabled (locked) globally +- `seriesInstanceUID`: The Series Instance UID of the background display set in the viewport +- `trackedMeasurementUIDs`: Array of measurement UIDs that are associated with the tracked series in the viewport + +## Events + +The hook automatically updates when any of these events occur: + +From the tracked measurements service: +- `TRACKING_ENABLED` +- `TRACKING_DISABLED` +- `TRACKED_SERIES_CHANGED` +- `SERIES_ADDED` +- `SERIES_REMOVED` + +From the measurement service: +- `MEASUREMENT_ADDED` +- `RAW_MEASUREMENT_ADDED` +- `MEASUREMENT_UPDATED` +- `MEASUREMENT_REMOVED` +- `MEASUREMENTS_CLEARED` diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/useMeasurements.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/useMeasurements.md new file mode 100644 index 000000000..d1336d0c7 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/useMeasurements.md @@ -0,0 +1,68 @@ +--- +title: useMeasurements +summary: A React hook that provides mapped measurements from the measurement service with automatic updates when measurements change. +--- + +# useMeasurements + +The `useMeasurements` hook provides access to measurements from the measurement service, with automatic updates when measurements are added, updated, or removed. + +## Overview + +This hook retrieves measurements from the measurement service and maps them to a display-friendly format. It monitors various measurement service events and updates the returned measurements automatically when changes occur. + +## Import + +```js +import { useMeasurements } from '@ohif/extension-cornerstone'; +``` + +## Usage + +```jsx +function MeasurementPanel() { + const measurementFilter = measurements => measurements.someFilter; + + const measurements = useMeasurements({ + measurementFilter, + }); + + return ( +
+ {measurements.map(measurement => ( +
+ {measurement.label} +
+ {measurement.displayText.primary.map((text, i) => ( +

{text}

+ ))} +
+
+ ))} +
+ ); +} +``` + +## Parameters + +- `options` - Configuration options: + - `measurementFilter` - Optional function to filter measurements returned by the measurement service. + +## Returns + +An array of mapped measurements with the following structure: + + +## Events + +The hook automatically updates when any of these measurement service events occur: +- `MEASUREMENT_ADDED` +- `RAW_MEASUREMENT_ADDED` +- `MEASUREMENT_UPDATED` +- `MEASUREMENT_REMOVED` +- `MEASUREMENTS_CLEARED` + +## Implementation Details + +The hook uses debouncing to prevent excessive re-renders when multiple measurement events occur in rapid succession. It also performs a deep comparison of the measurements to avoid unnecessary state updates when the data hasn't actually changed. diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/usePatientInfo.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/usePatientInfo.md new file mode 100644 index 000000000..62bc9b9ae --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/usePatientInfo.md @@ -0,0 +1,68 @@ +--- +title: usePatientInfo +summary: A React hook that provides patient information from the active display sets and detects when multiple patients are loaded. +--- + +# usePatientInfo + +The `usePatientInfo` hook provides access to basic patient demographic information from the active display sets and also detects when display sets from multiple patients are loaded simultaneously. + +## Overview + +This hook retrieves patient information from the first instance of the first display set added to the viewer. It monitors when new display sets are added and updates the patient information accordingly. It also checks if any of the active display sets are from different patients and provides this information through the `isMixedPatients` flag. + +## Import + +```js +import { usePatientInfo } from '@ohif/extension-default'; +``` + +## Usage + +```jsx +function PatientBanner() { + const { patientInfo, isMixedPatients } = usePatientInfo(); + + return ( +
+ {isMixedPatients && ( +
Multiple patients loaded
+ )} +
{patientInfo.PatientName}
+
+ ID: {patientInfo.PatientID} + Sex: {patientInfo.PatientSex} + DOB: {patientInfo.PatientDOB} +
+
+ ); +} +``` + +## Parameters + +This hook doesn't take any parameters. + +## Returns + +An object containing: + +- `patientInfo`: Object with the following properties: + - `PatientName`: Formatted patient name + - `PatientID`: Patient identifier + - `PatientSex`: Patient sex + - `PatientDOB`: Formatted patient date of birth +- `isMixedPatients`: Boolean indicating whether multiple patients are loaded in the viewer + +## Events + +The hook subscribes to the following display set service events: + +- `DISPLAY_SETS_ADDED`: Updates patient information when new display sets are added to the viewer + +## Implementation Details + +- Patient name and date of birth are formatted using OHIF utility functions. +- The hook checks all active display sets to determine if they belong to different patients. +- Patient information is initialized with empty strings and updated when display sets are added. +- When no instances are available in a display set, the hook attempts to get information from the `instance` property as a fallback. \ No newline at end of file diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/useSearchParams.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/useSearchParams.md new file mode 100644 index 000000000..909c1b0bc --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/useSearchParams.md @@ -0,0 +1,69 @@ +--- +title: useSearchParams +summary: A React hook that provides access to URL search parameters from both the query string and hash fragment. +--- + +# useSearchParams + +The `useSearchParams` hook provides access to URL search parameters, combining both query string parameters and hash fragment parameters into a single URLSearchParams object. + +## Overview + +This hook extends the standard React Router `useLocation` functionality by merging search parameters from both the query string and the hash fragment of the URL. It also provides an option to normalize parameter keys to lowercase for case-insensitive parameter handling. + +## Import + +```js +import { useSearchParams } from '@ohif/app'; +``` + +## Usage + +```jsx +function RouteParameterReader() { + const searchParams = useSearchParams(); + // Or with lowercase keys option + const lowerCaseParams = useSearchParams({ lowerCaseKeys: true }); + + const studyInstanceUID = searchParams.get('StudyInstanceUID'); + // With lowerCaseKeys: true + const sameStudyUID = lowerCaseParams.get('studyinstanceuid'); + + return ( +
+
Study UID: {studyInstanceUID}
+
All Parameters:
+
    + {Array.from(searchParams.entries()).map(([key, value]) => ( +
  • + {key}: {value} +
    • + ))} +
+
+ ); +} +``` + +## Parameters + +- `options` (optional): Configuration options + - `lowerCaseKeys` - Boolean indicating whether to convert all parameter keys to lowercase (default: false) + +## Returns + +A `URLSearchParams` object containing all parameters from both: +- The query string (e.g., `?param1=value1¶m2=value2`) +- The hash fragment (e.g., `#param3=value3¶m4=value4`) + +If parameters with the same key exist in both the query string and hash fragment, the hash fragment values take precedence. + +## Implementation Details + +- The hook uses React Router's `useLocation` to access the current URL. +- It first creates a URLSearchParams object from the location's search property. +- It then creates another URLSearchParams object from the location's hash property (excluding the leading '#'). +- The parameters from the hash are added to the search parameters, overriding any duplicate keys. +- If the `lowerCaseKeys` option is enabled, it creates a new URLSearchParams object with all keys converted to lowercase. + +This is particularly useful in OHIF where parameters may be specified in either the query string or hash fragment, and where case-sensitivity of parameter names might vary across different systems. diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/useSessionStorage.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/useSessionStorage.md new file mode 100644 index 000000000..8eed706d5 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/useSessionStorage.md @@ -0,0 +1,84 @@ +--- +title: useSessionStorage +summary: A React hook that provides sessionStorage access with automatic JSON parsing/stringifying and an option to clear data when the page unloads. +--- + +# useSessionStorage + +The `useSessionStorage` hook provides a convenient way to store and retrieve data from the browser's sessionStorage with automatic JSON serialization and deserialization. It also offers the option to automatically clear the stored data when a page unloads. + +## Overview + +This hook wraps the browser's sessionStorage API to provide a more React-friendly interface. It handles JSON serialization/deserialization automatically and maintains the stored values in local state for reactive updates. The hook also includes a unique feature to clear specific items from sessionStorage when the page unloads, which is useful for temporary session data that shouldn't persist. + +## Import + +```js +import { useSessionStorage } from '@ohif/ui-next'; +``` + +## Usage + +```jsx +function UserPreferencesPanel() { + const [preferences, setPreferences] = useSessionStorage({ + key: 'viewer-preferences', + defaultValue: { theme: 'dark', fontSize: 'medium' }, + clearOnUnload: false, + }); + + const updateTheme = (theme) => { + setPreferences({ ...preferences, theme }); + }; + + return ( +
+

User Preferences

+
Current Theme: {preferences.theme}
+ + +
+ ); +} + +function TemporaryWorkspace() { + const [workspace, setWorkspace] = useSessionStorage({ + key: 'temp-workspace', + defaultValue: { annotations: [] }, + clearOnUnload: true, // This data will be cleared when the page unloads + }); + + return ( +
+

Temporary Workspace

+

This workspace will be cleared when you leave the page

+ {/* Workspace UI components */} +
+ ); +} +``` + +## Parameters + +An options object with the following properties: + +- `key` (required): The sessionStorage key under which to store the data +- `defaultValue` (optional): The default value to use if no data exists in sessionStorage for the given key. Defaults to an empty object (`{}`) +- `clearOnUnload` (optional): Whether to clear this item from sessionStorage when the page unloads. Defaults to `false` + +## Returns + +An array containing: + +1. The current value from sessionStorage (parsed from JSON) +2. A function to update the value in both state and sessionStorage + +The update function automatically handles JSON stringification of the data. + +## Implementation Details + +- The hook uses a global Map (`sessionItemsToClearOnUnload`) to track items that should be cleared when the page unloads. +- It utilizes the browser's `visibilitychange` event to implement the clearOnUnload feature. When the page becomes hidden (which happens both when switching tabs and when unloading), items marked for clearing are removed from sessionStorage. +- If the page later becomes visible again (e.g., when switching back to the tab), the items are restored from the Map. +- The hook's update function merges the new value with the current state using the spread operator, maintaining a similar behavior to React's `setState`. +- All data is automatically serialized to JSON before storing in sessionStorage and deserialized when retrieving. diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportDisplaySets.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportDisplaySets.md new file mode 100644 index 000000000..7c3a99f5e --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportDisplaySets.md @@ -0,0 +1,98 @@ +--- +title: useViewportDisplaySets +summary: A React hook that provides access to display sets associated with a viewport, including background, foreground, overlay, and potential display sets. +--- + +# useViewportDisplaySets + +The `useViewportDisplaySets` hook provides access to display sets associated with a viewport, organized into categories based on their role and potential usage. + +## Overview + +This hook retrieves all display sets associated with a specific viewport and categorizes them into background, foreground, overlays, and potential display sets that could be added to the viewport in different roles. It allows components to efficiently access and manage viewport display sets for various UI interactions like layer menus and display set selectors. + +## Import + +```js +import { useViewportDisplaySets } from '@ohif/extension-cornerstone'; +``` + +## Usage + +```jsx +function ViewportLayerControls({ viewportId }) { + const { + backgroundDisplaySet, + foregroundDisplaySets, + overlayDisplaySets, + potentialOverlayDisplaySets, + potentialForegroundDisplaySets, + potentialBackgroundDisplaySets, + } = useViewportDisplaySets(viewportId); + + return ( +
+
+

Background

+
{backgroundDisplaySet?.SeriesDescription}
+
+ +
+

Foreground ({foregroundDisplaySets.length})

+ {foregroundDisplaySets.map(ds => ( +
{ds.SeriesDescription}
+ ))} +
+ +
+

Overlays ({overlayDisplaySets.length})

+ {overlayDisplaySets.map(ds => ( +
{ds.SeriesDescription}
+ ))} +
+ +
+

Available Overlays ({potentialOverlayDisplaySets.length})

+ {potentialOverlayDisplaySets.map(ds => ( +
{ds.SeriesDescription}
+ ))} +
+
+ ); +} +``` + +## Parameters + +- `viewportId` (optional): The ID of the viewport to get display sets for. If not provided, uses the active viewport. +- `options` (optional): Configuration options to control which display sets to include: + - `includeBackground`: Whether to include the background display set (default: true) + - `includeForeground`: Whether to include foreground display sets (default: true) + - `includeOverlay`: Whether to include overlay display sets (default: true) + - `includePotentialOverlay`: Whether to include potential overlay display sets (default: true) + - `includePotentialForeground`: Whether to include potential foreground display sets (default: true) + - `includePotentialBackground`: Whether to include potential background display sets (default: true) + +## Returns + +An object containing requested display set collections based on options: + +- `allDisplaySets`: All display sets in the viewer (only if requested) +- `viewportDisplaySets`: The display sets currently in the viewport +- `backgroundDisplaySet`: The primary display set for the viewport (base image) +- `foregroundDisplaySets`: Display sets currently shown with background (non-overlay layers) +- `overlayDisplaySets`: Segmentation display sets currently applied as overlays +- `potentialOverlayDisplaySets`: Display sets that could be toggled on as overlays (derived modalities) +- `potentialForegroundDisplaySets`: Display sets that could be added as foreground layers +- `potentialBackgroundDisplaySets`: Display sets that could replace the current background + +Each property is only included if the corresponding option is true. + +## Implementation Details + +- The hook automatically adapts to viewport changes through the `useViewportGrid` hook. +- It only fetches and processes display sets that are needed based on the provided options. +- Display sets are categorized based on their modality and properties. +- Potential display sets are sorted by priority to present the most relevant options first. +- Derived overlay modalities (like SEG, SR) are treated differently than other display sets. +- The hook uses memoization extensively to optimize performance and prevent unnecessary recalculations. diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportHover.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportHover.md new file mode 100644 index 000000000..867778284 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportHover.md @@ -0,0 +1,57 @@ +--- +title: useViewportHover +summary: A React hook that tracks mouse hover state and active status for a specific viewport. +--- + +# useViewportHover + +The `useViewportHover` hook provides information about whether the mouse is currently hovering over a specific viewport and whether that viewport is active. + +## Overview + +This hook monitors mouse movement to track hover state over a viewport element by its ID. It also checks whether the viewport is currently active (selected) in the viewer. This is useful for implementing conditional UI elements or behaviors that depend on user interaction with viewports. + +## Import + +```js +import { useViewportHover } from '@ohif/extension-cornerstone'; +``` + +## Usage + +```jsx +function ViewportOverlay({ viewportId }) { + const { isHovered, isActive } = useViewportHover(viewportId); + + return ( +
+ {isHovered && !isActive && ( + + )} + {isActive && ( +
Active viewport controls
+ )} +
+ ); +} +``` + +## Parameters + +- `viewportId` (required): The ID of the viewport to track hover state for + +## Returns + +An object containing the following properties: + +- `isHovered`: Boolean indicating if the mouse is currently hovering over the viewport +- `isActive`: Boolean indicating if the viewport is currently the active viewport in the grid + +## Implementation Details + +- The hook uses the DOM to find the viewport element by its `data-viewportid` attribute. +- It calculates and maintains the viewport's bounding rectangle to efficiently determine if the mouse is within the viewport's bounds. +- The viewport element's rectangle is updated when the window is resized. +- Global mouse movement is tracked to determine hover state, rather than relying on traditional mouseenter/mouseleave events. +- The hook automatically cleans up event listeners when the component unmounts or the viewport ID changes. +- Active viewport state is derived from the viewport grid state using the `useViewportGrid` hook. diff --git a/platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportSegmentations.md b/platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportSegmentations.md new file mode 100644 index 000000000..26d59e931 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/hooks/useViewportSegmentations.md @@ -0,0 +1,95 @@ +--- +title: useViewportSegmentations +summary: A React hook that provides segmentation data and representations for the active viewport with automatic updates when segmentations change. +--- + +# useViewportSegmentations + +The `useViewportSegmentations` hook provides access to segmentation data and their representations for a specific viewport, with automatic updates when segmentations are modified, removed, or representations change. + +## Overview + +This hook retrieves all segmentations and their representations for a given viewport from the segmentation service. It maps the segmentation data to a display-friendly format, including readable text for statistics. The hook monitors various segmentation and viewport events to update automatically when changes occur. + +## Import + +```js +import { useViewportSegmentations } from '@ohif/extension-cornerstone'; +``` + +## Usage + +```jsx +function SegmentationPanel({ viewportId }) { + const { segmentationsWithRepresentations, disabled } = useViewportSegmentations({ + viewportId, + subscribeToDataModified: true, + debounceTime: 100, + }); + + if (disabled) { + return
Segmentations not available for this modality
; + } + + if (!segmentationsWithRepresentations.length) { + return
No segmentations available
; + } + + return ( +
+ {segmentationsWithRepresentations.map(({ segmentation, representation }) => ( +
+

{segmentation.label}

+ {Object.entries(segmentation.segments).map(([segmentIndex, segment]) => ( +
+

{segment.label}

+ {segment.displayText.primary.map((text, i) => ( +

{text}

+ ))} +
+ ))} +
+ ))} +
+ ); +} +``` + +## Parameters + +- `options` - Configuration options: + - `viewportId` (required): The ID of the viewport to get segmentations for + - `subscribeToDataModified` (optional): Whether to subscribe to segmentation data modifications (default: false) + - `debounceTime` (optional): Debounce time in milliseconds for updates (default: 0) + +## Returns + +An object with the following properties: + +- `segmentationsWithRepresentations`: An array of objects with each containing: + - `representation`: The segmentation representation in the viewport + - `segmentation`: The mapped segmentation data with display-friendly properties: + - `label`: The segmentation label + - `segments`: Object mapping segment indices to segment data: + - `label`: Segment label + - `color`: Segment color + - `displayText`: Organized text for display with `primary` and `secondary` arrays + +- `disabled`: Boolean indicating if segmentations are disabled for the current modality + +## Events + +The hook automatically updates when any of these events occur: +- `SEGMENTATION_MODIFIED` +- `SEGMENTATION_REMOVED` +- `SEGMENTATION_REPRESENTATION_MODIFIED` +- `ACTIVE_VIEWPORT_ID_CHANGED` +- `GRID_STATE_CHANGED` +- `SEGMENTATION_DATA_MODIFIED` (only if `subscribeToDataModified` is true) + +## Implementation Details + +- The hook excludes certain modalities from segmentation display: 'SM', 'OT', 'DOC', 'ECG'. +- It uses debouncing to prevent excessive re-renders when multiple segmentation events occur in rapid succession. +- Segmentation statistics are automatically mapped to readable text using the customization service. +- Nested statistics are displayed with indentation to maintain hierarchy. diff --git a/platform/docs/versioned_docs/version-3.10/platform/internationalization.md b/platform/docs/versioned_docs/version-3.11/platform/internationalization.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/platform/internationalization.md rename to platform/docs/versioned_docs/version-3.11/platform/internationalization.md index 8caf9a729..c849f6fde 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/internationalization.md +++ b/platform/docs/versioned_docs/version-3.11/platform/internationalization.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Internationalization +title: Internationalization +summary: Documentation of OHIF's internationalization (i18n) implementation, including how to change languages, extend existing languages, add new languages, and contribute translations, using the @ohif/i18n package powered by i18next. --- # Viewer: Internationalization diff --git a/platform/docs/versioned_docs/version-3.10/platform/managers/_category_.json b/platform/docs/versioned_docs/version-3.11/platform/managers/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/platform/managers/_category_.json rename to platform/docs/versioned_docs/version-3.11/platform/managers/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/platform/managers/commands.md b/platform/docs/versioned_docs/version-3.11/platform/managers/commands.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/platform/managers/commands.md rename to platform/docs/versioned_docs/version-3.11/platform/managers/commands.md index 8727f9893..bb5957bd1 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/managers/commands.md +++ b/platform/docs/versioned_docs/version-3.11/platform/managers/commands.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Commands Manager +title: Commands Manager +summary: Documentation for the CommandsManager class which tracks named functions scoped to specific contexts, allowing OHIF to execute commands with appropriate context prioritization across the application. --- # Commands Manager diff --git a/platform/docs/versioned_docs/version-3.10/platform/managers/extension.md b/platform/docs/versioned_docs/version-3.11/platform/managers/extension.md similarity index 90% rename from platform/docs/versioned_docs/version-3.10/platform/managers/extension.md rename to platform/docs/versioned_docs/version-3.11/platform/managers/extension.md index a31f22442..69e566850 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/managers/extension.md +++ b/platform/docs/versioned_docs/version-3.11/platform/managers/extension.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Extension Manager +title: Extension Manager +summary: Documentation for the ExtensionManager class which aggregates and exposes extension modules throughout the OHIF application, manages data sources, and provides a centralized registry for accessing extension functionality. --- # Extension Manager diff --git a/platform/docs/versioned_docs/version-3.10/platform/managers/hotkeys.md b/platform/docs/versioned_docs/version-3.11/platform/managers/hotkeys.md similarity index 89% rename from platform/docs/versioned_docs/version-3.10/platform/managers/hotkeys.md rename to platform/docs/versioned_docs/version-3.11/platform/managers/hotkeys.md index 75d4ead30..81b54f2d8 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/managers/hotkeys.md +++ b/platform/docs/versioned_docs/version-3.11/platform/managers/hotkeys.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Hotkeys Manager +title: Hotkeys Manager +summary: Documentation for the HotkeysManager class which handles keyboard shortcut bindings to commands, allowing configuration of global and mode-specific keyboard shortcuts with user customization capabilities. --- # Hotkeys Managers diff --git a/platform/docs/versioned_docs/version-3.10/platform/managers/index.md b/platform/docs/versioned_docs/version-3.11/platform/managers/index.md similarity index 87% rename from platform/docs/versioned_docs/version-3.10/platform/managers/index.md rename to platform/docs/versioned_docs/version-3.11/platform/managers/index.md index ee6d6b2fc..7638a0bd8 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/managers/index.md +++ b/platform/docs/versioned_docs/version-3.11/platform/managers/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: Managers Introduction +summary: Overview of OHIF's manager system, which handles critical application infrastructure including extension registration, service management, command execution, and hotkey binding to coordinate functionality across the platform. --- # Managers diff --git a/platform/docs/versioned_docs/version-3.10/platform/managers/service.md b/platform/docs/versioned_docs/version-3.11/platform/managers/service.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/platform/managers/service.md rename to platform/docs/versioned_docs/version-3.11/platform/managers/service.md index d9269e46c..9e185f225 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/managers/service.md +++ b/platform/docs/versioned_docs/version-3.11/platform/managers/service.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Service Manager +title: Service Manager +summary: Documentation for the ServicesManager class which provides central registration and access to application services, with details on built-in services, service architecture, lifecycle management, and implementation of custom services. --- # Services Manager diff --git a/platform/docs/versioned_docs/version-3.10/platform/modes/_category_.json b/platform/docs/versioned_docs/version-3.11/platform/modes/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/platform/modes/_category_.json rename to platform/docs/versioned_docs/version-3.11/platform/modes/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/platform/modes/index.md b/platform/docs/versioned_docs/version-3.11/platform/modes/index.md similarity index 98% rename from platform/docs/versioned_docs/version-3.10/platform/modes/index.md rename to platform/docs/versioned_docs/version-3.11/platform/modes/index.md index aded22bd0..7fdd3e39a 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/modes/index.md +++ b/platform/docs/versioned_docs/version-3.11/platform/modes/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: Modes Introduction +summary: Overview of OHIF Modes, which are specialized viewer configurations for specific clinical workflows, allowing multiple purpose-specific applications to coexist within a single OHIF deployment. --- # Modes diff --git a/platform/docs/versioned_docs/version-3.10/platform/modes/installation.md b/platform/docs/versioned_docs/version-3.11/platform/modes/installation.md similarity index 57% rename from platform/docs/versioned_docs/version-3.10/platform/modes/installation.md rename to platform/docs/versioned_docs/version-3.11/platform/modes/installation.md index 08c456d29..20af3d0b2 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/modes/installation.md +++ b/platform/docs/versioned_docs/version-3.11/platform/modes/installation.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Installation +title: Mode Installation +summary: Documentation for installing OHIF Modes, including how to use the OHIF CLI to add both local and NPM-published modes to extend the viewer with custom clinical workflows. --- # Modes: Installation diff --git a/platform/docs/versioned_docs/version-3.10/platform/modes/lifecycle.md b/platform/docs/versioned_docs/version-3.11/platform/modes/lifecycle.md similarity index 92% rename from platform/docs/versioned_docs/version-3.10/platform/modes/lifecycle.md rename to platform/docs/versioned_docs/version-3.11/platform/modes/lifecycle.md index 8c0ec41ce..c3bd0e707 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/modes/lifecycle.md +++ b/platform/docs/versioned_docs/version-3.11/platform/modes/lifecycle.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Lifecycle Hooks +title: Mode Lifecycle Hooks +summary: Documentation for OHIF Mode's lifecycle hooks (onModeInit, onModeEnter, and onModeExit), which allow customization of initialization, resource setup, and cleanup when entering or exiting viewer modes. --- # Modes: Lifecycle Hooks diff --git a/platform/docs/versioned_docs/version-3.10/platform/modes/routes.md b/platform/docs/versioned_docs/version-3.11/platform/modes/routes.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/platform/modes/routes.md rename to platform/docs/versioned_docs/version-3.11/platform/modes/routes.md index 5a3bdc6f3..1668142ee 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/modes/routes.md +++ b/platform/docs/versioned_docs/version-3.11/platform/modes/routes.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: Routes +title: Mode Routes +summary: Documentation for OHIF Mode routes, which define URL paths, initialization logic, and layout templates for specific viewer workflows, allowing multiple modes to coexist within a single application. --- # Mode: Routes diff --git a/platform/docs/versioned_docs/version-3.10/platform/modes/validity.md b/platform/docs/versioned_docs/version-3.11/platform/modes/validity.md similarity index 76% rename from platform/docs/versioned_docs/version-3.10/platform/modes/validity.md rename to platform/docs/versioned_docs/version-3.11/platform/modes/validity.md index e3f70af76..f95421b80 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/modes/validity.md +++ b/platform/docs/versioned_docs/version-3.11/platform/modes/validity.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Validity +title: Mode Validity +summary: Documentation for OHIF Mode validity checks, which determine when specific modes should be available for particular studies based on modalities, tags, or custom logic to ensure appropriate workflows for different types of imaging studies. --- # Mode: Validity diff --git a/platform/docs/versioned_docs/version-3.10/platform/pwa-vs-packaged.md b/platform/docs/versioned_docs/version-3.11/platform/pwa-vs-packaged.md similarity index 80% rename from platform/docs/versioned_docs/version-3.10/platform/pwa-vs-packaged.md rename to platform/docs/versioned_docs/version-3.11/platform/pwa-vs-packaged.md index bdc411e6c..0e6c4ebb0 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/pwa-vs-packaged.md +++ b/platform/docs/versioned_docs/version-3.11/platform/pwa-vs-packaged.md @@ -1,5 +1,7 @@ --- sidebar_position: 3 +title: PWA vs Packaged Application +summary: Explanation of OHIF's primary build process for Progressive Web Applications (PWAs), detailing how the application is built as a set of static assets with service worker support for enhanced performance across devices and network conditions. --- # PWA vs Packaged diff --git a/platform/docs/versioned_docs/version-3.10/platform/scope-of-project.md b/platform/docs/versioned_docs/version-3.11/platform/scope-of-project.md similarity index 90% rename from platform/docs/versioned_docs/version-3.10/platform/scope-of-project.md rename to platform/docs/versioned_docs/version-3.11/platform/scope-of-project.md index 95460e4bc..089803c40 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/scope-of-project.md +++ b/platform/docs/versioned_docs/version-3.11/platform/scope-of-project.md @@ -1,5 +1,7 @@ --- sidebar_position: 1 +title: Scope of Project +summary: Overview of the OHIF Viewer's scope as a web-based medical imaging viewer that functions as a "dumb client," explaining its capabilities as a Progressive Web Application (PWA), the separation of data from the viewer, and clarification about offline capabilities. --- # Scope of Project diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/_category_.json b/platform/docs/versioned_docs/version-3.11/platform/services/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/platform/services/_category_.json rename to platform/docs/versioned_docs/version-3.11/platform/services/_category_.json diff --git a/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/Measurements.md b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/Measurements.md new file mode 100644 index 000000000..2558e1f0a --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/Measurements.md @@ -0,0 +1,11 @@ +--- +title: Measurements Customization +summary: Documentation for customizing OHIF's measurement tools and displays, including how to modify display formats, annotation behaviors, and tracking interfaces for medical imaging measurements. +sidebar_position: 4 +--- + + + +import { measurementsCustomizations, TableGenerator } from './sampleCustomizations'; + +{TableGenerator(measurementsCustomizations)} diff --git a/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/Segmentation.md b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/Segmentation.md new file mode 100644 index 000000000..c363ab365 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/Segmentation.md @@ -0,0 +1,11 @@ +--- +title: Segmentation Customization +summary: Documentation for customizing OHIF's segmentation tools and visualization options, including configuration for segment rendering, color schemes, and interaction behaviors for medical image segmentation workflows. +sidebar_position: 5 +--- + + + +import { segmentationCustomizations, TableGenerator } from './sampleCustomizations'; + +{TableGenerator(segmentationCustomizations)} diff --git a/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/StudyBrowser.md b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/StudyBrowser.md new file mode 100644 index 000000000..30d65bbdc --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/StudyBrowser.md @@ -0,0 +1,13 @@ +--- +title: Study Browser Customization +summary: Documentation for customizing OHIF's Study Browser component, including configuration options for thumbnails, sorting functions, and display formats to enhance study navigation and selection workflows. +sidebar_position: 6 +--- + +# Study Browser + +The Study Browser is a component that allows users to browse and manage studies. + +import { studyBrowserCustomizations, TableGenerator } from './sampleCustomizations'; + +{TableGenerator(studyBrowserCustomizations)} diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/_category_.json b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/platform/services/customization-service/_category_.json rename to platform/docs/versioned_docs/version-3.11/platform/services/customization-service/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/advanced.md b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/advanced.md similarity index 93% rename from platform/docs/versioned_docs/version-3.10/platform/services/customization-service/advanced.md rename to platform/docs/versioned_docs/version-3.11/platform/services/customization-service/advanced.md index 7efe64df9..6f14b76c4 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/advanced.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/advanced.md @@ -1,5 +1,7 @@ --- title: Advanced Customization +summary: Documentation for advanced OHIF customization techniques, including inheritance patterns, transform functions, and dynamic assembly of customizations to create sophisticated configurations across the platform. +sidebar_position: 8 --- diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/contextMenu.md b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/contextMenu.md similarity index 73% rename from platform/docs/versioned_docs/version-3.10/platform/services/customization-service/contextMenu.md rename to platform/docs/versioned_docs/version-3.11/platform/services/customization-service/contextMenu.md index 345531087..278bdb749 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/contextMenu.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/contextMenu.md @@ -1,6 +1,8 @@ --- sidebar_label: Context Menu sidebar_position: 3 +title: Context Menu Customization +summary: Documentation for customizing OHIF's context menus, including defining menu structures and click interactions specific to different contexts like the Cornerstone viewport. --- # Context Menu diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/customRoutes.md b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/customRoutes.md similarity index 91% rename from platform/docs/versioned_docs/version-3.10/platform/services/customization-service/customRoutes.md rename to platform/docs/versioned_docs/version-3.11/platform/services/customization-service/customRoutes.md index cc52cae6c..24134dc0d 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/customRoutes.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/customRoutes.md @@ -1,6 +1,8 @@ --- sidebar_label: Custom Routes sidebar_position: 2 +title: Custom Routes +summary: Documentation for creating custom routes in OHIF, allowing extensions to define new URL paths and React components to extend the application with additional pages and navigation options. --- # customRoutes diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/customizationService.md b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/customizationService.md similarity index 98% rename from platform/docs/versioned_docs/version-3.10/platform/services/customization-service/customizationService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/customization-service/customizationService.md index afb57f2ff..b8284785f 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/customizationService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/customizationService.md @@ -1,6 +1,8 @@ --- sidebar_label: Introduction sidebar_position: 1 +title: Customization Service +summary: Documentation for OHIF's Customization Service, which provides a flexible framework for configuring and overriding viewer components across different scopes (default, mode, global), supporting dynamic customization of UI elements and behaviors. --- import { customizations, TableGenerator } from './sampleCustomizations'; diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/sampleCustomizations.tsx b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/sampleCustomizations.tsx similarity index 96% rename from platform/docs/versioned_docs/version-3.10/platform/services/customization-service/sampleCustomizations.tsx rename to platform/docs/versioned_docs/version-3.11/platform/services/customization-service/sampleCustomizations.tsx index 6ab5b84ee..8ac060dcb 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/sampleCustomizations.tsx +++ b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/sampleCustomizations.tsx @@ -23,7 +23,6 @@ import segDisplayEditingTrue from '../../../assets/img/segDisplayEditingTrue.png import segDisplayEditingFalse from '../../../assets/img/segDisplayEditingFalse.png'; import thumbnailMenuItemsImage from '../../../assets/img/thumbnailMenuItemsImage.png'; import studyMenuItemsImage from '../../../assets/img/studyMenuItemsImage.png'; -import windowLevelActionMenu from '../../../assets/img/windowLevelActionMenu.png'; import viewPortNotificationImage from '../../../assets/img/viewport-notification.png'; import captureViewportModal from '../../../assets/img/captureViewportModal.png'; import aboutModal from '../../../assets/img/aboutModal.png'; @@ -911,56 +910,6 @@ window.config = { }; `, }, - { - id: 'viewportActionMenu.windowLevelActionMenu', - description: - 'Configures the display and location of the window level action menu in the viewport.', - image: windowLevelActionMenu, - default: null, - configuration: ` - window.config = { - // rest of window config - customizationService: [ - { - 'viewportActionMenu.windowLevelActionMenu': { - $merge: { - location: 0, // Set the location of the menu in the viewport. - // 0: topLeft - // 1: topRight - // 2: bottomLeft - // 3: bottomRight - } - }, - }, - ], - }; - `, - }, - { - id: 'viewportActionMenu.segmentationOverlay', - description: 'Configures the display and location of the segmentation overlay in the viewport.', - image: segmentationOverlay, - default: null, - configuration: ` - window.config = { - // rest of window config - customizationService: [ - { - 'viewportActionMenu.segmentationOverlay': { - $merge: { - enabled: true, - location: 1, // Set the location of the overlay in the viewport. - // 0: topLeft - // 1: topRight - // 2: bottomLeft - // 3: bottomRight - } - }, - }, - ], - }; - `, - }, { id: 'viewportNotification.beginTrackingMessage', description: 'Define the content to be displayed in begin tracking prompt', @@ -1869,6 +1818,31 @@ window.config = { }; }, }], +}; + `, + }, + { + id: 'instanceSortingCriteria', + description: 'Defines the instance sorting criteria to sort the images', + default: `{ + sortFunctions: {}, + defaultSortFunctionName: '', + }`, + configuration: ` +window.config = { + // rest of window config + customizationService: [ + { + 'instanceSortingCriteria': { + $set: { + sortFunctions: { + sort: (a, b) => {} + }, + defaultSortFunctionName: 'sort', + }, + }, + } + ], }; `, }, diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/viewportOverlay.md b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/viewportOverlay.md similarity index 63% rename from platform/docs/versioned_docs/version-3.10/platform/services/customization-service/viewportOverlay.md rename to platform/docs/versioned_docs/version-3.11/platform/services/customization-service/viewportOverlay.md index 4804617b9..68af62c1c 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/customization-service/viewportOverlay.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/customization-service/viewportOverlay.md @@ -1,5 +1,8 @@ --- +sidebar_label: Viewport Overlay sidebar_position: 1 +title: Viewport Overlay Customization +summary: Documentation for customizing OHIF's viewport overlays, allowing configuration of the information displayed in each corner (top-right, top-left, bottom-left, bottom-right) of medical imaging viewports. --- import { viewportOverlayCustomizations , TableGenerator } from './sampleCustomizations'; diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/DicomMetadataStore.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/DicomMetadataStore.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/DicomMetadataStore.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/DicomMetadataStore.md index 927b8b8e5..841be46f7 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/DicomMetadataStore.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/DicomMetadataStore.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: DICOM Metadata Store +title: DICOM Metadata Store +summary: Documentation for OHIF's DicomMetadataStore service, which provides centralized storage and retrieval functions for DICOM metadata with hierarchical organization of studies, series, and instances. --- # DICOM Metadata Store diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/DisplaySetService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/DisplaySetService.md similarity index 80% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/DisplaySetService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/DisplaySetService.md index 8b8bcae67..3ed57273d 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/DisplaySetService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/DisplaySetService.md @@ -1,10 +1,11 @@ --- sidebar_position: 3 sidebar_label: DisplaySet Service +title: DisplaySet Service +summary: Documentation for OHIF's DisplaySetService, which converts instance metadata into displayable sets for visualization, allowing dynamic creation, updating, and management of display sets from various data sources. --- # DisplaySet Service - ## Overview `DisplaySetService` handles converting the `instanceMetadata` into `DisplaySet` that `OHIF` uses for the visualization. `DisplaySetService` gets initialized at service startup time, but is then cleared in the `Mode.jsx`. During the initialization `SOPClassHandlerIds` of the `modes` gets registered with the `DisplaySetService`. @@ -12,7 +13,9 @@ sidebar_label: DisplaySet Service DisplaySet is a general set of entities and contains links to bunch of displayable objects (images, etc.) Some series might get split up into different displaySets e.g., MG might have mixed views in a single series, but users might want to have separate LCC, RCC, etc. for hanging protocol usage. A viewport renders a display set into a displayable object. -imageSet is a particular implementation of image displays. +An imageSet is a particular implementation of image displays. +- Learn more about Study (https://www.dicomstandard.org/standards/view/information-object-definitions#sect_A.1.2.2) +- Learn more about Series (https://www.dicomstandard.org/standards/view/information-object-definitions#sect_A.1.2.3) ::: @@ -27,6 +30,18 @@ Then, the same process is used as was originally done to create new display sets NOTE: Any instances not matched are NOT added to any display set and will not be displayed. +:::::info[Clarification of Terminology] + +Display Sets, which are custom to OHIF, are often confused with different DICOM terms, including study, series, and instances. The following are definitions for these terms to alleviate confusion. +

+ +DICOM Terms: +* **Study**: A collection of series +* **Series**: A collection of images or objects +* **Instance**: Single image or object +* **Display Set**: Set of displayable objects (Can be anything shown to the user) +::::: + ## Adding `madeInClient` display sets It is possible to filter or combine display sets from different series by performing the filter operation desired, and then calling the `addActiveDisplaySets` diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/HangingProtocolService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/HangingProtocolService.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/HangingProtocolService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/HangingProtocolService.md index de33e9bbd..d12920e66 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/HangingProtocolService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/HangingProtocolService.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Hanging Protocol Service +title: Hanging Protocol Service +summary: Documentation for OHIF's HangingProtocolService, which manages the automatic arrangement of medical images in viewports based on matching criteria, with support for custom attributes, synchronization, and display set selection. --- # Hanging Protocol Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/MeasurementService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/MeasurementService.md similarity index 94% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/MeasurementService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/MeasurementService.md index f5ede2f14..f13f09bf8 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/MeasurementService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/MeasurementService.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Measurement Service +title: Measurement Service +summary: Documentation for OHIF's MeasurementService, which handles annotation representation with extensible sources and mappers, supporting various measurement tools and allowing custom implementations beyond the built-in CornerstoneTools integration. --- # Measurement Service @@ -29,8 +31,7 @@ There are seven events that get publish in `MeasurementService`: | RAW_MEASUREMENT_ADDED | Fires when a raw measurement is added (e.g., dicom-sr) | | MEASUREMENT_REMOVED | Fires when a measurement is removed | | MEASUREMENTS_CLEARED | Fires when all measurements are deleted | -| JUMP_TO_MEASUREMENT_VIEWPORT | Fires when a measurement is requested to be jumped to, applying to individual viewports. | -| JUMP_TO_MEASUREMENT_LAYOUT | Fires when a measurement is requested to be jumped to, applying to the overall layout. | +| JUMP_TO_MEASUREMENT | Fires when a measurement is requested to be jumped to | ## API diff --git a/platform/docs/versioned_docs/version-3.11/platform/services/data/MultiMonitorService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/MultiMonitorService.md new file mode 100644 index 000000000..97eb43686 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/MultiMonitorService.md @@ -0,0 +1,163 @@ +--- +sidebar_position: 5 +sidebar_label: Multi Monitor Service +title: Multi Monitor Service +summary: Documentation for OHIF's MultiMonitorService, which provides basic support for opening and managing multiple viewer windows, including split-screen options and cross-window communication capabilities. +--- + + +# Multi Monitor Service + +::: info + +We plan to enhance this service in the future. Currently, it offers a basic implementation of multi-monitor support, allowing you to manually open multiple windows on the same monitor. It is not yet a full multi-monitor solution! + +::: + + + + +The multi-monitor service provides detection, launch and communication support +for multiple monitors or windows/screens within a single monitor. + +:::info + +The multi-monitor service is currently applied via configuration file. + +```js +customizationService: ['@ohif/extension-default.customizationModule.multimonitor'], +``` + +::: + + + +## Configurations +The service supports two predefined configurations: + +1. **Split Screen (`multimonitor=split`)** + Splits the primary monitor into two windows. + +2. **Multi-Monitor (`multimonitor=2`)** + Opens windows across separate physical monitors. + +### Launch Methods +- Specify `&screenNumber=0` to designate the first window explicitly. +- Omit `screenNumber` to let the service handle window assignments dynamically. +- Use `launchAll` in the query parameters to launch all configured screens simultaneously. + +#### Example URLs: +- **Split Screen:** + `http://viewer.ohif.org/.....&multimonitor=split` + Splits the primary monitor into two windows when a study is viewed. + +- **Multi-Monitor with All Screens:** + `http://viewer.ohif.org/.....&multimonitor=2&screenNumber=0&launchAll` + Launches two monitors and opens all configured screens. + +--- + +## Configuration File Setting + +The `multimonitor` configuration setting in the +[configuration file](../../../configuration/configurationFiles.md) specifies various +properties for each of the OHIF windows opened when multimonitor is launched. The setting is +an array of properties for each [configuration](#configurations) defined. +Each entry in the array is an object with the following properties. + +- `id`: The id for the array item. Typically it corresponds to one of the +[configurations](#configurations) (e.g. `split` or `2`) +- `test`: A function that takes a single object argument containing the property +`multimontior` (i.e. the [configuration](#configurations)). The function should return `true` +if this array entry should be applied to the [configuration](#configurations). +- `screens`: An array of objects that define each of the OHIF screens to be opened + +Each `screen` array entry above has the following properties. + +- `id`: The unique screen identifier (e.g. `ohif0` or `radScreen0`) +- `screen`: The index of the physical screen. For the `split` configuration this can +be `null` because there is no specific physical screen for it. +- `location`: The normalized top, left position and size of the window +(i.e. `x`, `y`, `width`, `height`) relative to the physical screen for the window +- `options` Standard comma delimited string of popup +[window options](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#windowfeatures). + +Below is a snippet from a configuration file for multimonitor. +``` + ... + multimonitor: [ + { + id: 'split', + test: ({ multimonitor }) => multimonitor === 'split', // applies to the split multimonitor configuration + screens: [ + { + id: 'ohif0', + screen: null, + location: { + width: 0.5, + height: 1, + left: 0, + top: 0, + }, + options: 'location=no,menubar=no,scrollbars=no,status=no,titlebar=no', + }, + { + id: 'ohif1', + screen: null, + location: { + width: 0.5, + height: 1, + left: 0.5, + top: 0, + }, + options: 'location=no,menubar=no,scrollbars=no,status=no,titlebar=no', + }, + ], + }, + + { + id: '2', + test: ({ multimonitor }) => multimonitor === '2', // applies to the `2` multimonitor configuration + screens: [ + { + id: 'ohif0', + screen: 0, + location: { + width: 1, + height: 1, + left: 0, + top: 0, + }, + options: 'fullscreen=yes,location=no,menubar=no,scrollbars=no,status=no,titlebar=no', + }, + { + id: 'ohif1', + screen: 1, + location: { + width: 1, + height: 1, + left: 0, + top: 0, + }, + options: 'fullscreen=yes,location=no,menubar=no,scrollbars=no,status=no,titlebar=no', + }, + ], + }, + ], + ... +``` + +## Behavior + +### Refresh, Close and Open +If you refresh the base/original window, then all the other windows will also +refresh. However, you can safely refresh any single other window, and on the next +command to the other windows, it will re-create the other window links without +losing content in the other windows. You can also close any other window and +it will be reopened the next time you try to call to it. + + +## Executing Commands +The MultiMonitorService adds the ability to run commands on other specified windows. +This allows opening up a study on another window without needing to refresh +it's contents. The command below shows an example of how this can be done: diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/PanelService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/PanelService.md similarity index 89% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/PanelService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/PanelService.md index b0a530b85..d3bd7bca3 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/PanelService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/PanelService.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: Panel Service +title: Panel Service +summary: Documentation for OHIF's PanelService, which manages the activation and display of side panels registered via extension modules, with support for explicit activation or event-triggered display of panels. --- # Panel Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/SegmentationService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/SegmentationService.md similarity index 92% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/SegmentationService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/SegmentationService.md index c2eeb6080..031594862 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/SegmentationService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/SegmentationService.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: Segmentation Service +title: Segmentation Service +summary: Documentation for OHIF's SegmentationService, which provides tools for creating, managing, and interacting with image segmentations, including labelmap creation, segment operations, and visualization controls. --- # Segmentation Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/SyncGroupService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/SyncGroupService.md similarity index 94% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/SyncGroupService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/SyncGroupService.md index 835fd5621..13c7cb65f 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/SyncGroupService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/SyncGroupService.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: SyncGroup Service +title: SyncGroup Service +summary: Documentation for OHIF's SyncGroupService, which manages synchronization between multiple viewports based on various criteria like camera position, window level, and slice position, with both hanging protocol and manual configuration options. --- # Sync Group Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/ToolGroupService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/ToolGroupService.md similarity index 94% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/ToolGroupService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/ToolGroupService.md index 0d7a04cf0..37854e929 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/ToolGroupService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/ToolGroupService.md @@ -1,6 +1,8 @@ --- sidebar_position: 7 sidebar_label: ToolGroup Service +title: ToolGroup Service +summary: Documentation for OHIF's ToolGroupService, which manages tool groups and their associated tools, allowing organization and control of measurement, annotation, and manipulation tools across different viewports. --- # Tool Group Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/ToolbarService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/ToolbarService.md similarity index 97% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/ToolbarService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/ToolbarService.md index 3c8aff777..704e4cd2b 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/ToolbarService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/ToolbarService.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: Toolbar Service +title: Toolbar Service +summary: Documentation for OHIF's ToolbarService, which manages the viewer's toolbar UI components, including button creation, section organization, and command execution, with support for nested dropdowns and state management. --- # Toolbar **Service** diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/WorkflowStepService.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/WorkflowStepService.md similarity index 95% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/WorkflowStepService.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/WorkflowStepService.md index 7070cade4..68ae609ed 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/WorkflowStepService.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/WorkflowStepService.md @@ -1,6 +1,8 @@ --- sidebar_position: 9 sidebar_label: WorkflowStep Service +title: WorkflowStep Service +summary: Documentation for OHIF's WorkflowStepService, which enables structured multi-step clinical workflows with customizable hanging protocols, layouts, and toolbars for each step, providing guided navigation through complex imaging tasks. --- # Workflow Step Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/_category_.json b/platform/docs/versioned_docs/version-3.11/platform/services/data/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/_category_.json rename to platform/docs/versioned_docs/version-3.11/platform/services/data/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/data/index.md b/platform/docs/versioned_docs/version-3.11/platform/services/data/index.md similarity index 88% rename from platform/docs/versioned_docs/version-3.10/platform/services/data/index.md rename to platform/docs/versioned_docs/version-3.11/platform/services/data/index.md index 3253ba9ee..6a30a6fbc 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/data/index.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/data/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Overview +title: Data Services Overview +summary: Overview of OHIF's data services architecture, which replaced the Redux store with a more modular approach using service-specific state management and a pub/sub pattern for communication between components. --- # Overview diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/index.md b/platform/docs/versioned_docs/version-3.11/platform/services/index.md similarity index 94% rename from platform/docs/versioned_docs/version-3.10/platform/services/index.md rename to platform/docs/versioned_docs/version-3.11/platform/services/index.md index 1096ba6ff..814bd446b 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/index.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Introduction +title: OHIF Services +summary: Overview of OHIF's services architecture, which provides modular, concern-specific code components that manage state and operations throughout the application, including both data services and UI services that follow a pub/sub pattern to reduce coupling. --- # Services diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/pubsub.md b/platform/docs/versioned_docs/version-3.11/platform/services/pubsub.md similarity index 91% rename from platform/docs/versioned_docs/version-3.10/platform/services/pubsub.md rename to platform/docs/versioned_docs/version-3.11/platform/services/pubsub.md index 036e592ef..b1143b655 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/pubsub.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/pubsub.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: Pub Sub +title: Publish-Subscribe Pattern +summary: Documentation of the publish-subscribe pattern implementation in OHIF, which enables event-based communication between services, allowing components to subscribe to events and receive updates when they occur, reducing direct dependencies between modules. --- # Pub sub diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/ui/_category_.json b/platform/docs/versioned_docs/version-3.11/platform/services/ui/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/platform/services/ui/_category_.json rename to platform/docs/versioned_docs/version-3.11/platform/services/ui/_category_.json diff --git a/platform/docs/versioned_docs/version-3.11/platform/services/ui/cine-service.md b/platform/docs/versioned_docs/version-3.11/platform/services/ui/cine-service.md new file mode 100644 index 000000000..2908c02a7 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/platform/services/ui/cine-service.md @@ -0,0 +1,10 @@ +--- +sidebar_position: 7 +sidebar_label: CINE Service +title: CINE Service +summary: Documentation for OHIF's CINE Service, which provides animation capabilities for scrolling through image stacks at configurable frame rates, enabling dynamic review of multi-frame image series. +--- + +# CINE Service + +TODO... diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/ui/index.md b/platform/docs/versioned_docs/version-3.11/platform/services/ui/index.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/platform/services/ui/index.md rename to platform/docs/versioned_docs/version-3.11/platform/services/ui/index.md index 2a0203a74..ad8722033 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/ui/index.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/ui/index.md @@ -1,6 +1,8 @@ --- sidebar_position: 1 sidebar_label: Overview +title: UI Services Overview +summary: Overview of OHIF's UI services architecture, which enables consistent UI interactions across the application through React context providers and service implementations, allowing extensions to leverage components like modals, notifications, and dialogs. --- # Overview diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-dialog-service.md b/platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-dialog-service.md similarity index 86% rename from platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-dialog-service.md rename to platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-dialog-service.md index 152841ae6..09d9cc542 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-dialog-service.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-dialog-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 4 sidebar_label: UI Dialog Service +title: UI Dialog Service +summary: Documentation for OHIF's UI Dialog Service, which provides streamlined dialog windows for user attention, input collection, and information display, with methods for creating and dismissing multiple dialogs throughout the application. --- # UI Dialog Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-modal-service.md b/platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-modal-service.md similarity index 90% rename from platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-modal-service.md rename to platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-modal-service.md index 5fe5a643d..02512d5a6 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-modal-service.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-modal-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 3 sidebar_label: UI Modal Service +title: UI Modal Service +summary: Documentation for OHIF's UI Modal Service, which enables displaying centered, non-draggable modal windows for focused user interaction, with support for custom components and content throughout the application. --- # UI Modal Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-notification-service.md b/platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-notification-service.md similarity index 90% rename from platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-notification-service.md rename to platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-notification-service.md index 815ac6d8d..5f700b58f 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-notification-service.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-notification-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: UI Notification Service +title: UI Notification Service +summary: Documentation for OHIF's UI Notification Service, which provides a standardized way to display non-intrusive, contextual notifications for timely and relevant information to users throughout the application. --- # UI Notification Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-viewport-dialog-service.md b/platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-viewport-dialog-service.md similarity index 89% rename from platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-viewport-dialog-service.md rename to platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-viewport-dialog-service.md index b50e3e7e4..0d95b0c14 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/ui/ui-viewport-dialog-service.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/ui/ui-viewport-dialog-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 5 sidebar_label: UI Viewport Dialog Service +title: UI Viewport Dialog Service +summary: Documentation for OHIF's UI Viewport Dialog Service, which creates modal dialogs inside specific viewports for contextual user interactions, supporting different types of messages and action buttons for user input. --- # UI Viewport Dialog Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/ui/viewport-action-menu.md b/platform/docs/versioned_docs/version-3.11/platform/services/ui/viewport-action-menu.md similarity index 83% rename from platform/docs/versioned_docs/version-3.10/platform/services/ui/viewport-action-menu.md rename to platform/docs/versioned_docs/version-3.11/platform/services/ui/viewport-action-menu.md index 5a0592535..84b87f5c4 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/ui/viewport-action-menu.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/ui/viewport-action-menu.md @@ -1,6 +1,8 @@ --- sidebar_position: 8 sidebar_label: Viewport Action Corners +title: Viewport Action Corners Service +summary: Documentation for OHIF's Viewport Action Corners Service, which manages interactive UI components placed in viewport corners, enabling flexible positioning, priority ordering, and dynamic updates of components for viewport-specific control. --- # Viewport Action Corners Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/services/ui/viewport-grid-service.md b/platform/docs/versioned_docs/version-3.11/platform/services/ui/viewport-grid-service.md similarity index 91% rename from platform/docs/versioned_docs/version-3.10/platform/services/ui/viewport-grid-service.md rename to platform/docs/versioned_docs/version-3.11/platform/services/ui/viewport-grid-service.md index 186afc419..e197cb504 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/services/ui/viewport-grid-service.md +++ b/platform/docs/versioned_docs/version-3.11/platform/services/ui/viewport-grid-service.md @@ -1,6 +1,8 @@ --- sidebar_position: 6 sidebar_label: Viewport Grid Service +title: Viewport Grid Service +summary: Documentation for OHIF's Viewport Grid Service, which manages the layout and configuration of the viewer's viewport grid, handling active viewport selection, display set assignment, and layout changes with event broadcasting capabilities. --- # Viewport Grid Service diff --git a/platform/docs/versioned_docs/version-3.10/platform/themeing.md b/platform/docs/versioned_docs/version-3.11/platform/themeing.md similarity index 92% rename from platform/docs/versioned_docs/version-3.10/platform/themeing.md rename to platform/docs/versioned_docs/version-3.11/platform/themeing.md index 48a881c20..b74fe20b3 100644 --- a/platform/docs/versioned_docs/version-3.10/platform/themeing.md +++ b/platform/docs/versioned_docs/version-3.11/platform/themeing.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Theming +title: Theming the OHIF Viewer +summary: Documentation on customizing the visual appearance of the OHIF Viewer using Tailwind CSS and white-labeling capabilities, including how to modify the color scheme, add custom layouts via the LayoutTemplateModule, and replace the application logo with custom branding. --- # Viewer: Theming diff --git a/platform/docs/versioned_docs/version-3.10/release-notes.md b/platform/docs/versioned_docs/version-3.11/release-notes.md similarity index 51% rename from platform/docs/versioned_docs/version-3.10/release-notes.md rename to platform/docs/versioned_docs/version-3.11/release-notes.md index 48491be16..6898e651e 100644 --- a/platform/docs/versioned_docs/version-3.10/release-notes.md +++ b/platform/docs/versioned_docs/version-3.11/release-notes.md @@ -1,6 +1,8 @@ --- sidebar_position: 2 sidebar_label: Release Notes +title: OHIF Viewer Release Notes +summary: Information about OHIF Viewer version releases, including new features, improvements, and bug fixes, which can be found in detail on the official OHIF website. --- # Release Notes diff --git a/platform/docs/versioned_docs/version-3.10/resources.md b/platform/docs/versioned_docs/version-3.11/resources.md similarity index 96% rename from platform/docs/versioned_docs/version-3.10/resources.md rename to platform/docs/versioned_docs/version-3.11/resources.md index bbdd4a18f..edcedf760 100644 --- a/platform/docs/versioned_docs/version-3.10/resources.md +++ b/platform/docs/versioned_docs/version-3.11/resources.md @@ -1,6 +1,8 @@ --- sidebar_position: 13 sidebar_label: Resources +title: OHIF Viewer Educational Resources +summary: A comprehensive collection of presentations, slides, posters, and videos from conferences, hackathons, and community meetings where the OHIF team has shared knowledge about the viewer's development, features, and capabilities, organized chronologically from 2016 to present. --- # Resources diff --git a/platform/docs/versioned_docs/version-3.11/test-coverage.md b/platform/docs/versioned_docs/version-3.11/test-coverage.md new file mode 100644 index 000000000..169fed8ca --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/test-coverage.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 14 +sidebar_label: Test Coverage +title: OHIF Viewer Test Coverage +summary: Information about the automated testing infrastructure for the OHIF Viewer, with a focus on Playwright tests and access to the latest test coverage reports, which help ensure reliability and quality of the codebase. +--- + +# Test Coverage + +## Playwright + + +Here's the test coverage report for our Playwright tests. Keep in mind that this doesn't include our Cypress tests, so our actual test coverage is likely higher than what's shown. We're focusing on Playwright for future OHIF testing, and we're really pushing to improve that coverage number. + + +You can view our latest test coverage report here: +- [OHIF Playwright Test Coverage Report](https://docs.ohif.org/coverage) diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/_category_.json b/platform/docs/versioned_docs/version-3.11/user-guide/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/_category_.json rename to platform/docs/versioned_docs/version-3.11/user-guide/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/index.md b/platform/docs/versioned_docs/version-3.11/user-guide/index.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/index.md rename to platform/docs/versioned_docs/version-3.11/user-guide/index.md diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/viewer/Language.md b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/Language.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/viewer/Language.md rename to platform/docs/versioned_docs/version-3.11/user-guide/viewer/Language.md diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/viewer/_category_.json b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/_category_.json similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/viewer/_category_.json rename to platform/docs/versioned_docs/version-3.11/user-guide/viewer/_category_.json diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/viewer/hotkeys.md b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/hotkeys.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/viewer/hotkeys.md rename to platform/docs/versioned_docs/version-3.11/user-guide/viewer/hotkeys.md diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/viewer/index.md b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/index.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/viewer/index.md rename to platform/docs/versioned_docs/version-3.11/user-guide/viewer/index.md diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/viewer/measurement-panel.md b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/measurement-panel.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/viewer/measurement-panel.md rename to platform/docs/versioned_docs/version-3.11/user-guide/viewer/measurement-panel.md diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/viewer/measurement-tracking.md b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/measurement-tracking.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/viewer/measurement-tracking.md rename to platform/docs/versioned_docs/version-3.11/user-guide/viewer/measurement-tracking.md diff --git a/platform/docs/versioned_docs/version-3.11/user-guide/viewer/mpr.md b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/mpr.md new file mode 100644 index 000000000..fc7892a98 --- /dev/null +++ b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/mpr.md @@ -0,0 +1,18 @@ +# Multiplanar Reconstruction + + +## Crosshairs + + +
+ +
+ + + +# MPR Slab Oblique + + +
+ +
diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/viewer/study-panel.md b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/study-panel.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/viewer/study-panel.md rename to platform/docs/versioned_docs/version-3.11/user-guide/viewer/study-panel.md diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/viewer/toolbar.md b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/toolbar.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/viewer/toolbar.md rename to platform/docs/versioned_docs/version-3.11/user-guide/viewer/toolbar.md diff --git a/platform/docs/versioned_docs/version-3.10/user-guide/viewer/viewport.md b/platform/docs/versioned_docs/version-3.11/user-guide/viewer/viewport.md similarity index 100% rename from platform/docs/versioned_docs/version-3.10/user-guide/viewer/viewport.md rename to platform/docs/versioned_docs/version-3.11/user-guide/viewer/viewport.md diff --git a/platform/docs/versioned_sidebars/version-3.10-sidebars.json b/platform/docs/versioned_sidebars/version-3.11-sidebars.json similarity index 100% rename from platform/docs/versioned_sidebars/version-3.10-sidebars.json rename to platform/docs/versioned_sidebars/version-3.11-sidebars.json diff --git a/platform/docs/versions.json b/platform/docs/versions.json index 75608e321..a8dc0cebf 100644 --- a/platform/docs/versions.json +++ b/platform/docs/versions.json @@ -1 +1 @@ -["3.10"] +["3.11"]