Skip to main content

Class: AnnotationMultiSlice

This class handles the annotation multiple slice view references. Currently this only manages range values within a single stack, however, the intent is to support both range and multiple stack/multi slice indices.

Constructors​

new AnnotationMultiSlice()​

new AnnotationMultiSlice(): AnnotationMultiSlice

Returns​

AnnotationMultiSlice

Methods​

getFrameRange()​

static getFrameRange(annotation): number | [number, number]

Gets the frame range or single frame item from an annotation.

Parameters​

• annotation: Annotation

Returns​

number | [number, number]

Defined in​

tools/src/utilities/AnnotationMultiSlice.ts:109


getFrameRangeStr()​

static getFrameRangeStr(annotation): string

Parameters​

• annotation: Annotation

Returns​

string

Defined in​

tools/src/utilities/AnnotationMultiSlice.ts:120


setEndRange()​

static setEndRange(viewport, annotation, endRange): void

Sets the end of the range to the specified value. If that is a single image, will be set as a non-range value.

Parameters​

• viewport: any

• annotation: any

• endRange: any = ...

Returns​

void

Defined in​

tools/src/utilities/AnnotationMultiSlice.ts:30


setRange()​

static setRange(viewport, annotation, startRange?, endRange?): void

Sets a range of images in the current viewport to be selected. This only works on stack and video viewports currently.

Parameters​

• viewport: any

• annotation: any

• startRange?: number

• endRange?: number

Returns​

void

Defined in​

tools/src/utilities/AnnotationMultiSlice.ts:42


setSingle()​

static setSingle(viewport, annotation, current): void

Sets the annotation to display a single image rather than a range of images.

Parameters​

• viewport: any

• annotation: any

• current: any = ...

Returns​

void

Defined in​

tools/src/utilities/AnnotationMultiSlice.ts:98


setStartRange()​

static setStartRange(viewport, annotation, startRange): void

Sets the given annotation start slice index to the provided value (or the current image index).

Parameters​

• viewport: any

• annotation: any

• startRange: any = ...

Returns​

void

Defined in​

tools/src/utilities/AnnotationMultiSlice.ts:18


setViewportFrameRange()​

static setViewportFrameRange(viewport, specifier): void

This sets the viewport frame range if it has a frame range. This is the playback range for display.

Parameters​

• viewport: any

• specifier: any

Returns​

void

Defined in​

tools/src/utilities/AnnotationMultiSlice.ts:129