ViewerAnnotationRegionsHelper

Defined in: js-api/src/viewer.ts:1200

Extends

• AnnotationRegionsHelper

Constructors

Constructor

new ViewerAnnotationRegionsHelper(viewer): ViewerAnnotationRegionsHelper

Defined in: js-api/src/viewer.ts:1218

Parameters

Parameter	Type
viewer	Viewer

Returns

ViewerAnnotationRegionsHelper

Overrides

AnnotationRegionsHelper.constructor

Properties

Property	Modifier	Type	Defined in
viewer	readonly	Viewer	js-api/src/viewer.ts:1201

Accessors

items

Get Signature

get items(): AnnotationRegion[]

Defined in: js-api/src/helpers.ts:153

Returns

AnnotationRegion[]

Set Signature

set items(value): void

Defined in: js-api/src/helpers.ts:158

Parameters

Parameter	Type
value	AnnotationRegion[]

Returns

void

Inherited from

AnnotationRegionsHelper.items

---

storage

Get Signature

get storage(): string

Defined in: js-api/src/viewer.ts:1203

Returns

string

Set Signature

set storage(value): void

Defined in: js-api/src/viewer.ts:1210

Parameters

Parameter	Type
value	string

Returns

void

Overrides

AnnotationRegionsHelper.storage

Methods

add()

add(item): void

Defined in: js-api/src/helpers.ts:162

Parameters

Parameter	Type
item	AnnotationRegion

Returns

void

Inherited from

AnnotationRegionsHelper.add

---

addAll()

addAll(items): void

Defined in: js-api/src/helpers.ts:166

Parameters

Parameter	Type
items	AnnotationRegion[]

Returns

void

Inherited from

AnnotationRegionsHelper.addAll

---

clear()

clear(): AnnotationRegionsHelper

Defined in: js-api/src/helpers.ts:186

Returns

AnnotationRegionsHelper

Inherited from

AnnotationRegionsHelper.clear

---

removeAt()

removeAt(idx, count?): void

Defined in: js-api/src/helpers.ts:176

Parameters

Parameter	Type	Default value
idx	number	undefined
count	number	1

Returns

void

Inherited from

AnnotationRegionsHelper.removeAt

---

removeWhere()

removeWhere(predicate): void

Defined in: js-api/src/helpers.ts:182

Parameters

Parameter	Type
predicate	(value, index, array) => boolean

Returns

void

Inherited from

AnnotationRegionsHelper.removeWhere

---

updateAt()

updateAt(idx, value): void

Defined in: js-api/src/helpers.ts:170

Parameters

Parameter	Type
idx	number
value	AnnotationRegion

Returns

void

Inherited from

AnnotationRegionsHelper.updateAt