AnnotationRegionsHelper

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

Extended by

• DataFrameAnnotationRegionsHelper
• ViewerAnnotationRegionsHelper

Constructors

Constructor

new AnnotationRegionsHelper(): AnnotationRegionsHelper

Returns

AnnotationRegionsHelper

Accessors

items

Get Signature

get items(): AnnotationRegion[]

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

Returns

AnnotationRegion[]

Set Signature

set items(value): void

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

Parameters

Parameter	Type
value	AnnotationRegion[]

Returns

void

---

storage

Get Signature

get abstract storage(): string

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

Returns

string

Set Signature

set abstract storage(value): void

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

Parameters

Parameter	Type
value	string

Returns

void

Methods

add()

add(item): void

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

Parameters

Parameter	Type
item	AnnotationRegion

Returns

void

---

addAll()

addAll(items): void

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

Parameters

Parameter	Type
items	AnnotationRegion[]

Returns

void

---

clear()

clear(): AnnotationRegionsHelper

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

Returns

AnnotationRegionsHelper

---

removeAt()

removeAt(idx, count?): void

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

Parameters

Parameter	Type	Default value
idx	number	undefined
count	number	1

Returns

void

---

removeWhere()

removeWhere(predicate): void

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

Parameters

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

Returns

void

---

updateAt()

updateAt(idx, value): void

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

Parameters

Parameter	Type
idx	number
value	AnnotationRegion

Returns

void