Skip to main content

Interface: ViewPresentation

A view presentation stores information about how the view is presented to the user, such as rotation, the displayed area, pan/zoom etc. This is represented as values which are independent of the view type or size as much as possible, by normalizing the values to the type of view presented. This allows remember or synchronizing values in a much wider variety of places than using the raw/underlying view data such as camera position.

Properties

displayArea?

optional displayArea: DisplayArea

The display area being shown. This is more consistent than applying a set of boundary areas.

Defined in

packages/core/src/types/IViewport.ts:298


flipHorizontal?

optional flipHorizontal: boolean

The flip horizontal value is true if the view is flipped horizontally.

Defined in

packages/core/src/types/IViewport.ts:319


flipVertical?

optional flipVertical: boolean

The flip vertical value is true if the view is flipped vertically.

Defined in

packages/core/src/types/IViewport.ts:324


pan?

optional pan: Point2

The pan value is how far the pan has moved relative to the fit to canvas or relative to the display area initial position/sizing. true is the default units, which is relative to the initial canvas setting, in zoom relative units.

Defined in

packages/core/src/types/IViewport.ts:314


rotation?

optional rotation: number

The rotation of the view - this is related to cameraViewUp, but is relative to the viewNormal and the default viewUp for that viewNormal.

Defined in

packages/core/src/types/IViewport.ts:292


slabThickness?

optional slabThickness: number

The slice thickness - in frames(true/default) it will be 1 for a frame distance of 1 pixel thickness, while for mm will be in mm distance.

Defined in

packages/core/src/types/IViewport.ts:286


zoom?

optional zoom: number

The zoom value is a zoom factor relative either to fit to canvas or relative to the display area. The default true units are relative to the initial camera scale to fit is used to get units relative to the scale to fit camera.

Defined in

packages/core/src/types/IViewport.ts:306