Skip to main content

DataFrameAnnotationRegionsHelper

Defined in: js-api/src/dataframe/formula-helpers.ts:23

Extends​

Constructors​

Constructor​

new DataFrameAnnotationRegionsHelper(df): DataFrameAnnotationRegionsHelper

Defined in: js-api/src/dataframe/formula-helpers.ts:29

Parameters​

ParameterType
dfDataFrame

Returns​

DataFrameAnnotationRegionsHelper

Overrides​

AnnotationRegionsHelper.constructor

Properties​

PropertyModifierTypeDefined in
dfreadonlyDataFramejs-api/src/dataframe/formula-helpers.ts:24

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

Inherited from​

AnnotationRegionsHelper.items


storage​

Get Signature​

get storage(): string

Defined in: js-api/src/dataframe/formula-helpers.ts:26

Returns​

string

Set Signature​

set storage(value): void

Defined in: js-api/src/dataframe/formula-helpers.ts:27

Parameters​
ParameterType
valuestring
Returns​

void

Overrides​

AnnotationRegionsHelper.storage

Methods​

add()​

add(item): void

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

Parameters​

ParameterType
itemAnnotationRegion

Returns​

void

Inherited from​

AnnotationRegionsHelper.add


addAll()​

addAll(items): void

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

Parameters​

ParameterType
itemsAnnotationRegion[]

Returns​

void

Inherited from​

AnnotationRegionsHelper.addAll


clear()​

clear(): AnnotationRegionsHelper

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

Returns​

AnnotationRegionsHelper

Inherited from​

AnnotationRegionsHelper.clear


removeAt()​

removeAt(idx, count?): void

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

Parameters​

ParameterTypeDefault value
idxnumberundefined
countnumber1

Returns​

void

Inherited from​

AnnotationRegionsHelper.removeAt


removeWhere()​

removeWhere(predicate): void

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

Parameters​

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

Returns​

void

Inherited from​

AnnotationRegionsHelper.removeWhere


updateAt()​

updateAt(idx, value): void

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

Parameters​

ParameterType
idxnumber
valueAnnotationRegion

Returns​

void

Inherited from​

AnnotationRegionsHelper.updateAt


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

Inherited from​

AnnotationRegionsHelper.getFillColor