Skip to main content

AnnotationRegionsHelper

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

Extended by​

Constructors​

Constructor​

new AnnotationRegionsHelper(): AnnotationRegionsHelper

Returns​

AnnotationRegionsHelper

Accessors​

items​

Get Signature​

get items(): AnnotationRegion[]

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

Returns​

AnnotationRegion[]

Set Signature​

set items(value): void

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

Parameters​
ParameterType
valueAnnotationRegion[]
Returns​

void


storage​

Get Signature​

get abstract storage(): string

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

Returns​

string

Set Signature​

set abstract storage(value): void

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

Parameters​
ParameterType
valuestring
Returns​

void

Methods​

add()​

add(item): void

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

Parameters​

ParameterType
itemAnnotationRegion

Returns​

void


addAll()​

addAll(items): void

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

Parameters​

ParameterType
itemsAnnotationRegion[]

Returns​

void


clear()​

clear(): AnnotationRegionsHelper

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

Returns​

AnnotationRegionsHelper


removeAt()​

removeAt(idx, count?): void

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

Parameters​

ParameterTypeDefault value
idxnumberundefined
countnumber1

Returns​

void


removeWhere()​

removeWhere(predicate): void

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

Parameters​

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

Returns​

void


updateAt()​

updateAt(idx, value): void

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

Parameters​

ParameterType
idxnumber
valueAnnotationRegion

Returns​

void


getFillColor()​

static getFillColor(region): number

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

The ARGB color the viewers fill [region] with: AnnotationRegion.fill as is, or the deprecated AnnotationRegion.fillColor at AnnotationRegion.opacity (30% when missing).

Parameters​

ParameterType
regionAnnotationRegion

Returns​

number