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
Set Signature
set items(
value):void
Defined in: js-api/src/helpers.ts:169
Parameters
| Parameter | Type |
|---|---|
value | AnnotationRegion[] |
Returns
void
storage
Get Signature
get
abstractstorage():string
Defined in: js-api/src/helpers.ts:157
Returns
string
Set Signature
set
abstractstorage(value):void
Defined in: js-api/src/helpers.ts:158
Parameters
| Parameter | Type |
|---|---|
value | string |
Returns
void
Methods
add()
add(
item):void
Defined in: js-api/src/helpers.ts:173
Parameters
| Parameter | Type |
|---|---|
item | AnnotationRegion |
Returns
void
addAll()
addAll(
items):void
Defined in: js-api/src/helpers.ts:177
Parameters
| Parameter | Type |
|---|---|
items | AnnotationRegion[] |
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
| Parameter | Type | Default value |
|---|---|---|
idx | number | undefined |
count | number | 1 |
Returns
void
removeWhere()
removeWhere(
predicate):void
Defined in: js-api/src/helpers.ts:193
Parameters
| Parameter | Type |
|---|---|
predicate | (value, index, array) => boolean |
Returns
void
updateAt()
updateAt(
idx,value):void
Defined in: js-api/src/helpers.ts:181
Parameters
| Parameter | Type |
|---|---|
idx | number |
value | AnnotationRegion |
Returns
void
getFillColor()
staticgetFillColor(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
| Parameter | Type |
|---|---|
region | AnnotationRegion |
Returns
number