Skip to main content

ViewerAnnotationRegionsHelper

Defined in: src/viewer.ts:859

Extends

Constructors

Constructor

new ViewerAnnotationRegionsHelper(viewer): ViewerAnnotationRegionsHelper

Defined in: src/viewer.ts:877

Parameters

ParameterType
viewerViewer

Returns

ViewerAnnotationRegionsHelper

Overrides

AnnotationRegionsHelper.constructor

Properties

PropertyModifierTypeDefined in
viewerreadonlyViewersrc/viewer.ts:860

Accessors

items

Get Signature

get items(): AnnotationRegion[]

Defined in: src/helpers.ts:150

Returns

AnnotationRegion[]

Set Signature

set items(value): void

Defined in: src/helpers.ts:155

Parameters
ParameterType
valueAnnotationRegion[]
Returns

void

Inherited from

AnnotationRegionsHelper.items


storage

Get Signature

get storage(): string

Defined in: src/viewer.ts:862

Returns

string

Set Signature

set storage(value): void

Defined in: src/viewer.ts:869

Parameters
ParameterType
valuestring
Returns

void

Overrides

AnnotationRegionsHelper.storage

Methods

add()

add(item): void

Defined in: src/helpers.ts:159

Parameters

ParameterType
itemAnnotationRegion

Returns

void

Inherited from

AnnotationRegionsHelper.add


addAll()

addAll(items): void

Defined in: src/helpers.ts:163

Parameters

ParameterType
itemsAnnotationRegion[]

Returns

void

Inherited from

AnnotationRegionsHelper.addAll


clear()

clear(): AnnotationRegionsHelper

Defined in: src/helpers.ts:181

Returns

AnnotationRegionsHelper

Inherited from

AnnotationRegionsHelper.clear


removeAt()

removeAt(idx, count?): void

Defined in: src/helpers.ts:173

Parameters

ParameterTypeDefault value
idxnumberundefined
countnumber1

Returns

void

Inherited from

AnnotationRegionsHelper.removeAt


removeWhere()

removeWhere(predicate): void

Defined in: src/helpers.ts:177

Parameters

ParameterType
predicate(value, index, array) => boolean

Returns

void

Inherited from

AnnotationRegionsHelper.removeWhere


updateAt()

updateAt(idx, value): void

Defined in: src/helpers.ts:167

Parameters

ParameterType
idxnumber
valueAnnotationRegion

Returns

void

Inherited from

AnnotationRegionsHelper.updateAt