Class AnnotationCollector

Hierarchy

AnnotationCollector

Implements

AnnotationCollectorInterface

Index

Constructors

constructor

new AnnotationCollector(): AnnotationCollector
Returns AnnotationCollector

Properties

`Private` annotationFeatures

annotationFeatures: AnnotationFeatures[]

`Private` `Readonly` annotationFeaturesSubject

annotationFeaturesSubject: Subject<AnnotationFeatures[]> = ...

`Private` rawFeatures

rawFeatures: Feature[]

`Private` `Readonly` rawFeaturesSubject

rawFeaturesSubject: Subject<Feature[]> = ...

`Readonly` rcsbFvQuery

rcsbFvQuery: RcsbClientClass = rcsbClient

`Private` requestStatus

requestStatus: "complete" | "pending" = "complete"

Methods

collect

collect(requestConfig): Promise<AnnotationFeatures[]>
Parameters
- requestConfig: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>
Returns Promise<AnnotationFeatures[]>
Implementation of AnnotationCollectorInterface.collect
- Defined in src/RcsbCollectTools/AnnotationCollector/AnnotationCollector.ts:21

`Private` complete

complete(): void
Returns void
- Defined in src/RcsbCollectTools/AnnotationCollector/AnnotationCollector.ts:79

getAnnotationFeatures

getAnnotationFeatures(): Promise<AnnotationFeatures[]>
Returns Promise<AnnotationFeatures[]>
Implementation of AnnotationCollectorInterface.getAnnotationFeatures
- Defined in src/RcsbCollectTools/AnnotationCollector/AnnotationCollector.ts:49

getFeatures

getFeatures(): Promise<Feature[]>
Returns Promise<Feature[]>
Implementation of AnnotationCollectorInterface.getFeatures
- Defined in src/RcsbCollectTools/AnnotationCollector/AnnotationCollector.ts:39

`Private` requestAnnotations

requestAnnotations(requestConfig): Promise<AnnotationFeatures[]>
Parameters
- requestConfig: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>
Returns Promise<AnnotationFeatures[]>
- Defined in src/RcsbCollectTools/AnnotationCollector/AnnotationCollector.ts:59

Class AnnotationCollector

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AnnotationCollector

Properties

`Private` annotationFeatures

`Private` `Readonly` annotationFeaturesSubject

`Private` rawFeatures

`Private` `Readonly` rawFeaturesSubject

`Readonly` rcsbFvQuery

`Private` requestStatus

Methods

collect

Parameters

requestConfig: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>

Returns Promise<AnnotationFeatures[]>

`Private` complete

Returns void

getAnnotationFeatures

Returns Promise<AnnotationFeatures[]>

getFeatures

Returns Promise<Feature[]>

`Private` requestAnnotations

Parameters

requestConfig: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>

Returns Promise<AnnotationFeatures[]>

Settings

Member Visibility

Theme

On This Page

Class AnnotationCollector

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AnnotationCollector

Properties

Private annotationFeatures

Private Readonly annotationFeaturesSubject

Private rawFeatures

Private Readonly rawFeaturesSubject

Readonly rcsbFvQuery

Private requestStatus

Methods

collect

Parameters

requestConfig: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>

Returns Promise<AnnotationFeatures[]>

Private complete

Returns void

getAnnotationFeatures

Returns Promise<AnnotationFeatures[]>

getFeatures

Returns Promise<Feature[]>

Private requestAnnotations

Parameters

requestConfig: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>

Returns Promise<AnnotationFeatures[]>

Settings

Member Visibility

Theme

On This Page

`Private` annotationFeatures

`Private` `Readonly` annotationFeaturesSubject

`Private` rawFeatures

`Private` `Readonly` rawFeaturesSubject

`Readonly` rcsbFvQuery

`Private` requestStatus

`Private` complete

`Private` requestAnnotations