VintaSoft Imaging .NET SDK 12.5: Documentation for Web developer
In This Topic
    Add web DICOM viewer to an Angular and ASP.NET Core application
    In This Topic
    This tutorial shows how to create a blank Angular and ASP.NET Core application in Visual Studio .NET 2022 and add DICOM viewer to an Angular and ASP.NET Core application.


    Here are steps, which must be done:
    1. Create a blank Angular and ASP.NET Core application.

      Open Visual Studio .NET 2022 and create a new application of "Angular and ASP.NET Core" type:

      Configure the application to use .NET 8.0:

    2. Server side: Add references to the Vintasoft assemblies to "AngularApp1.Server" project.

      Copy Vintasoft.Shared.dll, Vintasoft.Imaging.dll, Vintasoft.Imaging.Dicom.dll, Vintasoft.Shared.Web.dll, Vintasoft.Imaging.Web.Services.dll, Vintasoft.Imaging.Dicom.Web.Services.dll, Vintasoft.Imaging.AspNetCore.ApiControllers.dll and Vintasoft.Imaging.Dicom.AspNetCore.ApiControllers.dll assemblies from "<SdkInstallPath>\VintaSoft Imaging .NET v12.5\Bin\DotNet8\AnyCPU\" directory to the "Bin" directory of "AngularApp1.Server" project and add references to assemblies in "AngularApp1.Server" project.



    3. Server side: Specify drawing engine, which should be used by VintaSoft Imaging .NET SDK for drawing of 2D graphics.

      If "AngularApp1.Server" project must be used in Windows or Linux, SkiaSharp drawing engine should be used.
      If "AngularApp1.Server" project must be used in Windows only, System.Drawing or SkiaSharp drawing engine should be used.

      Here are steps, which should be made for using SkiaSharp engine:
      • Add reference to the Vintasoft.Imaging.Drawing.SkiaSharp.dll assembly.
      • Add reference to the SkiaSharp nuget-package version 2.88.6.
      • Open "Program.cs" file in "AngularApp1.Server" project, add code line "Vintasoft.Imaging.Drawing.SkiaSharp.SkiaSharpDrawingFactory.SetAsDefault();" at the beginning of file - added code specifies that VintaSoft Imaging .NET SDK should use SkiaSharp library for drawing of 2D graphics.

      Here are steps, which should be made for using System.Drawing engine:
      • Add reference to the Vintasoft.Imaging.Gdi.dll assembly.
      • Open "Program.cs" file in "AngularApp1.Server" project, add code line "Vintasoft.Imaging.Drawing.Gdi.GdiGraphicsFactory.SetAsDefault();" at the beginning of file - added code specifies that VintaSoft Imaging .NET SDK should use System.Drawing library for drawing of 2D graphics.

    4. Server side: Create web services, which allow to upload/download file, manage image collection, get information about images, get thumbnails, render image tiles, extract/search text and annotate document.

      • Create web service that allows to upload/download file

        • Press the right mouse button on the "Controllers" folder and select the "Add => Controller..." menu from context menu
        • Select "Empty API controller" template, set the controller name to the "MyVintasoftFileApiController" and press the "Add" button
        • Specify that MyVintasoftFileApiController class is derived from Vintasoft.Imaging.AspNetCore.ApiControllers.VintasoftFileApiController class

          Here are source codes of MyVintasoftFileApiController class:
          namespace AngularApp1.Server.Controllers
          {
              public class MyVintasoftFileApiController : Vintasoft.Imaging.AspNetCore.ApiControllers.VintasoftFileApiController
              {
          
                  public MyVintasoftFileApiController(IWebHostEnvironment hostingEnvironment)
                      : base(hostingEnvironment)
                  {
                  }
          
              }
          }
          
          
      • Create web service that allows to work with DICOM images

        • Press the right mouse button on the "Controllers" folder and select the "Add => Controller..." menu from context menu
        • Select "Empty API controller" template, set the controller name to the "MyVintasoftDicomApiController" and press the "Add" button
        • Specify that MyVintasoftDicomApiController class is derived from Vintasoft.Imaging.Dicom.AspNetCore.ApiControllers.VintasoftDicomApiController class

          Here are source codes of MyVintasoftDicomApiController class:
          using Vintasoft.Imaging.Dicom.AspNetCore.ApiControllers;
          
          namespace AngularApp1.Server.Controllers
          {
              /// <summary>
              /// A Web API controller that handles HTTP requests from clients and
              /// allows to work with DICOM images.
              /// </summary>
              public class MyVintasoftDicomApiController : VintasoftDicomApiController
              {
          
                  /// <summary>
                  /// Initializes a new instance of the <see cref="MyVintasoftDicomApiController"/> class.
                  /// </summary>
                  public MyVintasoftDicomApiController(IWebHostEnvironment hostingEnvironment)
                      : base(hostingEnvironment)
                  {
                  }
          
              }
          }
          
    5. Server side: Create CORS-policy that allows to access web services from client side.

      • Open the "Program.cs" file in "AngularApp1.Server" project and add code that:
        • Creates CORS-policy that allows to access web services from "localhost"
        • Enables CORS usage in "AngularApp1.Server" project

        Here are source codes of "Program.cs" file after update:
        Vintasoft.Imaging.Drawing.SkiaSharp.SkiaSharpDrawingFactory.SetAsDefault();
        
        var builder = WebApplication.CreateBuilder(args);
        
        // Add services to the container.
        
        builder.Services.AddControllers();
        
        builder.Services.AddCors(options =>
        {
            options.AddPolicy(name: "CorsPolicy1", policy =>
            {
                policy.SetIsOriginAllowed(origin => new Uri(origin).Host == "localhost").AllowAnyHeader().AllowAnyMethod();
            });
        });
        
        var app = builder.Build();
        
        app.UseDefaultFiles();
        app.UseStaticFiles();
        
        // Configure the HTTP request pipeline.
        
        app.UseHttpsRedirection();
        
        app.UseAuthorization();
        
        app.UseCors("CorsPolicy1");
        
        app.MapControllers();
        
        app.MapFallbackToFile("/index.html");
        
        app.Run();
        
        
    6. Server side: Update launch URL in 'launchSettings.json' file.

      • Open file "Properties\launchSettings.json" in "AngularApp1.Server" and clear launch URL:
    7. Server side: Copy the default test DCM-file to a server side.

      • Create folder "UploadedImageFiles\SessionID" in "AngularApp1.Server" project and copy test DCM-file "<SdkInstallPath>\VintaSoft\Imaging .NET v12.5\Examples\ASP.NET Core\CSharp\AspNetCoreImagingDemo\wwwroot\UploadedImageFiles\LossyJpeg_Monochrome2_000.0000.dcm" to the folder. This file will be displayed in DICOM viewer.
    8. Compile the project for restoring dependencies using 'npm'.

    9. Client side: Delete files, which are not necessary in this tutorial.

      • Delete files "WeatherForecast.cs" and "Controllers\WeatherForecastController.cs" in "AngularApp1.Server" project - the WeatherForecast Web API controller is not necessary in this tutorial.

      • Delete files "src\app\app.component.css", "src\app\app.component.html", "src\app\app.component.spec.ts", "src\app\app.component.ts" in "angularapp1.client" project - this Angular-component is not necessary in this tutorial.
    10. Client side: Add JavaScript files and TypeScript modules to the "angularapp1.client" project.

      • Add the "assets" folder to the "src\app\" folder in "angularapp1.client" project.

      • Copy Vintasoft.Shared.js, Vintasoft.Shared.d.ts, Vintasoft.Imaging.js, Vintasoft.Imaging.d.ts, Vintasoft.Imaging.Dicom.js and Vintasoft.Imaging.Dicom.d.ts files from "<SdkInstallPath>\VintaSoft Imaging .NET v12.5\Bin\JavaScript\" folder to the "src\app\assets\" folder.

      • Specify, which "standard" dialogs (password dialog, print dialog, etc) should be used by web DICOM viewer
        • If web DICOM viewer should use ready-to-use "standard" Bootstrap dialogs:
          • Add "bootstrap" Node-module to the "package.json" file. Rebuild the project for refreshing Node-modules.
            Here are source codes of "package.json" file after update:
            {
              "name": "angularapp1.client",
              "version": "0.0.0",
              "scripts": {
                "ng": "ng",
                "start": "run-script-os",
                "build": "ng build",
                "watch": "ng build --watch --configuration development",
                "test": "ng test",
                "prestart": "node aspnetcore-https",
                "start:windows": "ng serve --ssl --ssl-cert \"%APPDATA%\\ASP.NET\\https\\%npm_package_name%.pem\" --ssl-key \"%APPDATA%\\ASP.NET\\https\\%npm_package_name%.key\" --host=127.0.0.1",
                "start:default": "ng serve --ssl --ssl-cert \"$HOME/.aspnet/https/${npm_package_name}.pem\" --ssl-key \"$HOME/.aspnet/https/${npm_package_name}.key\" --host=127.0.0.1"
              },
              "private": true,
              "dependencies": {
                "@angular/animations": "^18.0.0",
                "@angular/common": "^18.0.0",
                "@angular/compiler": "^18.0.0",
                "@angular/core": "^18.0.0",
                "@angular/forms": "^18.0.0",
                "@angular/platform-browser": "^18.0.0",
                "@angular/platform-browser-dynamic": "^18.0.0",
                "@angular/router": "^18.0.0",
                "bootstrap": "5.3.3",
                "rxjs": "~7.8.0",
                "tslib": "^2.3.0",
                "zone.js": "~0.14.3",
                "jest-editor-support": "*",
                "run-script-os": "*"
              },
              "devDependencies": {
                "@angular-devkit/build-angular": "^18.0.3",
                "@angular/cli": "^18.0.3",
                "@angular/compiler-cli": "^18.0.0",
                "@types/jasmine": "~5.1.0",
                "jasmine-core": "~5.1.0",
                "karma": "~6.4.0",
                "karma-chrome-launcher": "~3.2.0",
                "karma-coverage": "~2.2.0",
                "karma-jasmine": "~5.1.0",
                "karma-jasmine-html-reporter": "~2.1.0",
                "typescript": "~5.4.2"
              }
            }
            
            
          • Copy Vintasoft.Imaging.Dialogs.Bootstrap.js, Vintasoft.Imaging.Dialogs.Bootstrap.d.ts, Vintasoft.Imaging.Dicom.Dialogs.Bootstrap.js and Vintasoft.Imaging.Dicom.Dialogs.Bootstrap.d.ts files from "<InstallPath>\VintaSoft Imaging .NET v12.5\Bin\JavaScript\" folder into "src\app\assets\" folder.

        • If web DICOM viewer should use ready-to-use "standard" jQuery UI dialogs:
          • Add "jquery-ui-dist" Node-module to the "package.json" file. Rebuild the project for refreshing Node-modules.
          • Copy Vintasoft.Imaging.Dialogs.jQueryUI.js, Vintasoft.Imaging.Dialogs.jQueryUI.d.ts, Vintasoft.Imaging.Dicom.Dialogs.jQueryUI.js and Vintasoft.Imaging.Dicom.Dialogs.jQueryUI.d.ts files from "<InstallPath>\VintaSoft Imaging .NET v12.5\Bin\JavaScript\" folder into "src\app\assets\" folder.

        • If web DICOM viewer should use custom "standard" dialogs (for example, Angular+Bootstrap dialogs), please read how to create custom "standard" dialogs here.

      • Add references to used JavaScript libraries to the "projects => Demo => architect => build => options => scripts" section in "angular.json" file, add references to used CSS-files to the "projects => Demo => architect => build => options => styles" section in "angular.json" file.
        Here are source codes of "angular.json" file:
        {
          "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
          "version": 1,
          "newProjectRoot": "projects",
          "projects": {
            "angularapp1.client": {
              "projectType": "application",
              "schematics": {
                "@schematics/angular:component": {
                  "standalone": false
                },
                "@schematics/angular:directive": {
                  "standalone": false
                },
                "@schematics/angular:pipe": {
                  "standalone": false
                }
              },
              "root": "",
              "sourceRoot": "src",
              "prefix": "app",
              "architect": {
                "build": {
                  "builder": "@angular-devkit/build-angular:application",
                  "options": {
                    "outputPath": "dist/angularapp1.client",
                    "index": "src/index.html",
                    "browser": "src/main.ts",
                    "polyfills": [
                      "zone.js"
                    ],
                    "tsConfig": "tsconfig.app.json",
                    "assets": [
                      {
                        "glob": "**/*",
                        "input": "public"
                      }
                    ],
                    "styles": [
                      "node_modules/bootstrap/dist/css/bootstrap.css",
                      "src/Vintasoft.Imaging.css",
                      "src/Vintasoft.Imaging.Dicom.css",
                      "src/styles.css"
                    ],
                    "scripts": [
                      "src/app/assets/Vintasoft.Shared.js",
                      "src/app/assets/Vintasoft.Imaging.js",
                      "src/app/assets/Vintasoft.Imaging.Dicom.js",
                      "src/app/assets/Vintasoft.Imaging.Dialogs.Bootstrap.js",
                      "src/app/assets/Vintasoft.Imaging.Dicom.Dialogs.Bootstrap.js"
                    ]
                  },
                  "configurations": {
                    "production": {
                      "budgets": [
                        {
                          "type": "initial",
                          "maximumWarning": "500kB",
                          "maximumError": "1MB"
                        },
                        {
                          "type": "anyComponentStyle",
                          "maximumWarning": "2kB",
                          "maximumError": "4kB"
                        }
                      ],
                      "outputHashing": "all"
                    },
                    "development": {
                      "optimization": false,
                      "extractLicenses": false,
                      "sourceMap": true
                    }
                  },
                  "defaultConfiguration": "production"
                },
                "serve": {
                  "builder": "@angular-devkit/build-angular:dev-server",
                  "configurations": {
                    "production": {
                      "buildTarget": "angularapp1.client:build:production"
                    },
                    "development": {
                      "buildTarget": "angularapp1.client:build:development"
                    }
                  },
                  "defaultConfiguration": "development",
                  "options": {
                    "proxyConfig": "src/proxy.conf.js"
                  }
                },
                "extract-i18n": {
                  "builder": "@angular-devkit/build-angular:extract-i18n"
                },
                "test": {
                  "builder": "@angular-devkit/build-angular:karma",
                  "options": {
                    "polyfills": [
                      "zone.js",
                      "zone.js/testing"
                    ],
                    "tsConfig": "tsconfig.spec.json",
                    "assets": [
                      {
                        "glob": "**/*",
                        "input": "public"
                      }
                    ],
                    "styles": [
                      "src/styles.css"
                    ],
                    "scripts": [],
                    "karmaConfig": "karma.conf.js"
                  }
                }
              }
            }
          }
        }
        
        

      • Copy files "Vintasoft.Imaging.css" and "Vintasoft.Imaging.DocumentViewer.css" with CSS-styles of Vintasoft web DICOM viewer from "<SdkInstallPath>\VintaSoft\Imaging .NET v12.5\Bin\JavaScript\" folder to the "src\" folder.
        Add information about "Vintasoft.Imaging.DocumentViewer.css" file to the "styles" section of "app\angular.json" file.
    11. Client side: Create Angular-component that allows to display DICOM images.

      • Create "DICOM-viewer-demo.html" file that will contain HTML markup of Angular-component:
        • Select "Add => New Item..." context menu for folder "src\app\" => "Add new item" dialog will appear
        • Select "HTML Page" type for new item
        • Set "DICOM-viewer-demo.html" as element name
        • Click the "Add" button => dialog will be closed and file "DICOM-viewer-demo.html" will be added into folder "src\app\"

        Add HTML markup (page header and div-element for DICOM viewer) to the "DICOM-viewer-demo.html" file:


        Here is HTML-code of "DICOM-viewer-demo.html" file:
        <h1>VintaSoft DICOM Viewer Demo (Angular + ASP.NET Core)</h1>
        
        <div id="dicomControlContainer" class="dicomControlContainer"></div>
        
        

      • Create "DICOM-viewer-demo.css" file that will contain CSS-styles of Angular-component:
        • Select "Add => New Item..." context menu for folder "src\app\" => "Add new item" dialog will appear
        • Select "StyleSheet" type for new item
        • Set "DICOM-viewer-demo.css" as element name
        • Click the "Add" button => dialog will be closed and file "DICOM-viewer-demo.css" will be added into folder "src\app\"

        Add CSS-styles to the "DICOM-viewer-demo.css" file:


        Here is CSS-code of "DICOM-viewer-demo.css" file:
        h1 {
          width: 1200px;
          text-align: center;
        }
        
        .dicomControlContainer {
          width: 1200px;
          height: 800px;
        }
        
        

      • Create "DICOM-viewer-demo.ts" file that will contain code of Angular-component:
        • Select "Add => New Item..." context menu for folder "src\app\" => "Add new item" dialog will appear
        • Select "TypeScript File" type for new item
        • Set "DICOM-viewer-demo.ts" as element name
        • Click the "Add" button => dialog will be closed and file "DICOM-viewer-demo.ts" will be added into folder "src\app\"

        Add TypeScript code to the "DICOM-viewer-demo.ts" file:


        Important: Visual Studio uses randomized network port for ASP.NET Core API and you need to update JavaScript code and change web services URL from "https://localhost:7259/" to URL in your application.

        Here is TypeScript code of "DICOM-viewer-demo.ts" file:
        import { Component, OnInit } from '@angular/core';
        
        @Component({
          selector: 'app-root',
          templateUrl: './dicom-viewer-demo.html',
          styleUrl: './dicom-viewer-demo.css'
        })
        export class DicomViewerDemo implements OnInit {
          constructor() { }
        
          ngOnInit() {
            // set the session identifier
            Vintasoft.Shared.WebImagingEnviromentJS.set_SessionId("SessionID");
        
            // specify web services, which should be used by Vintasoft Web DICOM Viewer
            Vintasoft.Shared.WebServiceJS.defaultFileService =
              new Vintasoft.Shared.WebServiceControllerJS("https://localhost:7259/vintasoft/api/MyVintasoftFileApi");
            Vintasoft.Shared.WebServiceJS.defaultDicomService =
              new Vintasoft.Shared.WebServiceControllerJS("https://localhost:7259/vintasoft/api/MyVintasoftDicomApi");
        
            // create DICOM control settings
            var dicomControlSettings = new Vintasoft.Imaging.Dicom.WebDicomControlSettingsJS("dicomControlContainer", "dicomControl");
            // create DICOM control
            var dicomControl = new Vintasoft.Imaging.Dicom.WebDicomControlJS(dicomControlSettings);
        
            // subscribe to the "warningOccured" event of DICOM control
            Vintasoft.Shared.subscribeToEvent(dicomControl, "warningOccured", function (event: any, eventArgs: any) { alert(eventArgs.message); });
        
            // add DICOM file "LossyJpeg_Monochrome2_000.0000.dcm" to the DICOM control
            dicomControl.addFiles(["LossyJpeg_Monochrome2_000.0000.dcm"]);
          }
        
          title = 'VintaSoft Angular DICOM Viewer Demo';
        }
        
        

      • Add created Angular-component to the Angular-application module - "src\app\app.module.ts" file:


        Here are source codes of "app.module.ts" file after update:
        import { HttpClientModule } from '@angular/common/http';
        import { NgModule } from '@angular/core';
        import { BrowserModule } from '@angular/platform-browser';
        
        import { AppRoutingModule } from './app-routing.module';
        import { DicomViewerDemo } from './dicom-viewer-demo';
        
        @NgModule({
          declarations: [
            DicomViewerDemo
          ],
          imports: [
            BrowserModule, HttpClientModule,
            AppRoutingModule
          ],
          providers: [],
          bootstrap: [DicomViewerDemo]
        })
        export class AppModule { }
        
        

    12. Run Angular and ASP.NET Core application and see the result.