Home

This wiki is intended to be used as a reference for the concepts and API's in cornerstone. If you are new to cornerstone, we recommend that you start by reviewing the concepts below and then looking at the various examples to see how cornerstone is used.

Concepts

• Enabled Elements
• ImageIds
• ImageLoaders
• Image Object
• Viewport
• Pixel Coordinate System
• Architecture

API Reference

Events

• CornerstoneImageRendered Event
• CornerstoneNewImage Event
• CornerstoneImageLoaded Event
• CornerstoneImageLoadProgress Event

Enable/Disable

• enable
• disable

Loading Images and Cache Management

• loadImage
• loadAndCacheImage
• setMaximumSizeBytes
• getCacheInfo
• purgeCache

Viewport

• displayImage
• setViewport
• getViewport
• fitToWindow
• updateImage
• resize

Coordinates

• pageToPixel
• setToPixelCoordinateSystem

Pixel Data

• getStoredPixels

Element Data (Tools)

• getElementData
• removeElementData

Image Loader

• registerImageLoader

Internal APIs

These API's are used internally by cornerstone and not intended to be called externally. These API's may change at any time and will likely be hidden in the future.

• getEnabledElement
• addEnabledElement
• putImagePromise
• getImagePromise
• storedPixelDataToCanvasImageData
• storedColorPixelDataToCanvasImageData
• ieVersion
• generateLut
• drawImage
• event
• getDefaultViewport
• registerUnknownImageLoader