Skip to main content

Class: FrameRange

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 FrameRange()​

new FrameRange(): FrameRange

Returns​

FrameRange

Properties​

frameRangeExtractor​

protected static frameRangeExtractor: RegExp

Defined in​

packages/core/src/utilities/FrameRange.ts:9

Methods​

framesToImageId()​

protected static framesToImageId(imageId, range): string

Applies the range string to the given image id as a frame range.

Parameters​

• imageId: string

• range: string | FramesRange

Returns​

string

Defined in​

packages/core/src/utilities/FrameRange.ts:50


framesToString()​

static framesToString(range): string

Parameters​

• range: any

Returns​

string

A string range or single value representation of a range array or single instance image.

Defined in​

packages/core/src/utilities/FrameRange.ts:42


imageIdToFrameEnd()​

static imageIdToFrameEnd(imageId): number

Parameters​

• imageId: string

Returns​

number

Defined in​

packages/core/src/utilities/FrameRange.ts:28


imageIdToFrames()​

protected static imageIdToFrames(imageId): FramesRange

This method will extract a single frame number or range of frame numbers from a multiframe image id containing a frame range.

Parameters​

• imageId: string

Returns​

FramesRange

Defined in​

packages/core/src/utilities/FrameRange.ts:16


imageIdToFrameStart()​

static imageIdToFrameStart(imageId): number

Parameters​

• imageId: string

Returns​

number

Defined in​

packages/core/src/utilities/FrameRange.ts:33