Class: annotationFrameRange

This class handles the annotation frame range values for multiframes. Mostly used for the Video viewport, it allows references to a range of frame values.

Constructors

new annotationFrameRange()

new annotationFrameRange(): annotationFrameRange

Returns

annotationFrameRange

Properties

frameRangeExtractor

protected static frameRangeExtractor: RegExp

Defined in

tools/src/utilities/annotationFrameRange.ts:13

Methods

framesToImageId()

protected static framesToImageId(imageId, range): string

Parameters

• imageId: string

• range: string | FramesRange

Returns

string

Defined in

tools/src/utilities/annotationFrameRange.ts:35

---

framesToString()

static framesToString(range): string

Parameters

• range: any

Returns

string

Defined in

tools/src/utilities/annotationFrameRange.ts:28

---

getFrameRange()

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

Parameters

• annotation: Annotation

Returns

number | [number, number]

Defined in

tools/src/utilities/annotationFrameRange.ts:73

---

imageIdToFrames()

protected static imageIdToFrames(imageId): FramesRange

Parameters

• imageId: string

Returns

FramesRange

Defined in

tools/src/utilities/annotationFrameRange.ts:16

---

setFrameRange()

static setFrameRange(annotation, range, eventBase?): void

Sets the range of frames to associate with the given annotation. The range can be a single frame number (1 based according to DICOM), or a range of values in the format min-max where min, max are inclusive Modifies the referencedImageID to specify the updated URL.

Parameters

• annotation: Annotation

• range: string | FramesRange

• eventBase?

• eventBase.renderingEngineId?: any

• eventBase.viewportId?: any

Returns

void

Defined in

tools/src/utilities/annotationFrameRange.ts:56