Skip to main content

Examples

We have already written plenty number of examples that you can access here. When you click on an example you will be taken to its example page. You can interact with each example and see how it works.

Click here to open examples page

Source Code and Debugging

If you are interested in looking into the source code for each example, we have added a link to the source code when you open the chrome developer tools. You can see the following video to see how to do this. In summary, after opening the chrome developer tools, click on the console and click on the index.ts that is shown in the console.

You can put breakpoints at any line of the code and investigate the variables and functions that are being called.

Run Examples Locally

You can also run each example locally. It should be noted that Cornerstone3D is a monorepo and contains three packages (core, tools, streaming-image-volume). Examples for each of these packages are included in the examples directory inside each package. You can run each example by using its name as an argument to the example script. For instance, It should be noted that the example name is not case sensitive, and even it can suggest the name of the example you are looking for if you make a typo.


1. Clone the repository
2. `yarn install`
3. `yarn run example petct` // this should be run from the root of the repository

Important

Use the root of the repository as the working directory when running the example. Previously, you had to run the example in each package directory. This is no longer the case.