0.0.304 • Published 8 months ago

@3cr/viewer-browser-next v0.0.304

Weekly downloads
-
License
-
Repository
bitbucket
Last release
8 months ago

@3cr/viewer-browser-next

npm.io npm.io

Ecosystem integration for installing and running 3DICOM Online Viewer (3CR-OV) within the Browser (client-side)

3DICOM Online Viewer (3CR-OV) Playground

Include @3cr/viewer-browser-next script

Choose one of the following ways

  • HTML Script Tag

    Insert this line into your index.html

    <script src="https://cdn.jsdelivr.net/npm/@3cr/viewer-browser-next@{{version}}/dist/Viewer3CR.umd.js"></script>

    Note: Please ensure you replace the {{version}} with the version of the viewer you want.

  • JS/TS way

    You can also include it dynamically within your code.

    Typescript (.ts)

    export async function loadViewerScript(version: string): Promise<void> {
      return new Promise<void>((resolve) => {
        const s = document.createElement('script');
        s.onload = () => {
          resolve();
        };
        s.src = `https://cdn.jsdelivr.net/npm/@3cr/viewer-browser-next@${version}/dist/Viewer3CR.umd.js`;
        document.head.appendChild(s);
      });
    }
    
    // ...
    
    await loadViewerScript('1.0.0');

    Javascript (.js)

    export async function loadViewerScript(version) {
      return new Promise((resolve) => {
        const s = document.createElement('script');
        s.onload = () => {
          resolve();
        };
        s.src = `https://cdn.jsdelivr.net/npm/@3cr/viewer-browser-next@${version}/dist/Viewer3CR.umd.js`;
        document.head.appendChild(s);
      });
    }
    
    // ...
    
    await loadViewerScript('1.0.0');

Using the Package

  1. Register 3DICOM Online Viewer version

    Call the mountViewer function with the version of 3CR you would like to view. This will generate a new container to load the viewer within and register the 3CR Instance.

    Typescript (.ts) / Javascript (.js)

    const VERSION_3CR: string = '1.0.0';
    
    await window.mountViewer(VERSION_3CR);
  2. Load in the 3VXL file

    Generate the 3VXL file and Decryption Key/Iv and supply that to the loadViewer function

    Note: You can supply undefined/nothing to the loadViewer() function to display a default scan for testing purposes.

    Typescript (.ts) / Javascript (.js)

    const payload = {
      Url: '<Some presigned URL to a 3VXL file.>',
      DecryptionKey: {
        Iv: '<Initialisation Vector of the Key>',
        Key: '<Decryption Key>'
      }
    };
    await window.loadViewer(payload);
    
    // OR
    
    await window.loadViewer();
  3. (Optional) Clean up

    In order to ensure the css namespace and data from the viewer is cleaned up and removed after execution, call unmountViewer

    Note: You may also want to clean up the initial script you loaded on your site, by removing the nodes of the script you created in Include @3cr/viewer-browser-next script

    Typescript (.ts) / Javascript (.js)

    await window.unmountViewer();

Contributing

Pull requests are welcome. For changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

0.0.279

11 months ago

0.0.274

11 months ago

0.0.273

11 months ago

0.0.272

11 months ago

0.0.271

11 months ago

0.0.278

11 months ago

0.0.277

11 months ago

0.0.276

11 months ago

0.0.275

11 months ago

0.0.292

9 months ago

0.0.270

11 months ago

0.0.291

9 months ago

0.0.290

9 months ago

0.0.304

8 months ago

0.0.303

8 months ago

0.0.269

11 months ago

0.0.268

11 months ago

0.0.285

11 months ago

0.0.263

11 months ago

0.0.284

11 months ago

0.0.283

11 months ago

0.0.261

11 months ago

0.0.282

11 months ago

0.0.260

12 months ago

0.0.289

10 months ago

0.0.267

11 months ago

0.0.288

10 months ago

0.0.266

11 months ago

0.0.287

11 months ago

0.0.265

11 months ago

0.0.286

11 months ago

0.0.264

11 months ago

0.0.281

11 months ago

0.0.280

11 months ago

0.0.259

12 months ago

0.0.258

12 months ago

0.0.257

1 year ago

0.0.252

1 year ago

0.0.251

1 year ago

0.0.250

1 year ago

0.0.254

1 year ago

0.0.253

1 year ago

0.0.239

1 year ago

0.0.238

1 year ago

0.0.237

1 year ago