Class RcsbFvInterface

Hierarchy

RcsbFvAbstractModule
- RcsbFvInterface

Constructors

constructor

new RcsbFvInterface(elementId, rcsbFv): RcsbFvInterface
Parameters
- elementId: string
- rcsbFv: RcsbFv<{}, {}, {}, {}>
Returns RcsbFvInterface
Inherited from RcsbFvAbstractModule.constructor
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:62

Properties

`Protected` alignmentCollector

alignmentCollector: AlignmentCollectorInterface = ...

`Protected` alignmentTracks

alignmentTracks: RcsbFvRowConfigInterface[] = []

`Protected` annotationCollector

annotationCollector: AnnotationCollectorInterface = ...

`Protected` annotationTracks

annotationTracks: RcsbFvRowConfigInterface[] = []

`Protected` boardConfigData

boardConfigData: RcsbFvBoardConfigInterface = ...

`Protected` buildConfig

buildConfig: RcsbFvModuleBuildInterface

`Protected` `Readonly` elementId

elementId: string

`Private` instanceId

instanceId: string

`Protected` polymerEntityInstance

polymerEntityInstance: PolymerEntityInstanceTranslate

`Protected` `Readonly` rcsbFv

rcsbFv: RcsbFv<{}, {}, {}, {}>

Type declaration

`Protected` referenceTrack

referenceTrack: RcsbFvRowConfigInterface

`Protected` rowConfigData

rowConfigData: RcsbFvRowConfigInterface[] = ...

Methods

activeDisplay

activeDisplay(): boolean
Returns boolean
Inherited from RcsbFvAbstractModule.activeDisplay
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:91

build

build(buildConfig): Promise<void>
Parameters
- buildConfig: RcsbFvModuleBuildInterface
Returns Promise<void>
Inherited from RcsbFvAbstractModule.build
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:116

`Protected` buildAlignmentTracks

buildAlignmentTracks(alignmentRequestContext, alignmentResponse, trackFactories?): Promise<void>
Parameters
- alignmentRequestContext: AlignmentRequestContextType
- alignmentResponse: AlignmentResponse
- Optional trackFactories: {
  alignmentTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, TargetAlignment]>;
  sequenceTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, string]>;
  }
  - Optional alignmentTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, TargetAlignment]>
  - Optional sequenceTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, string]>
Returns Promise<void>
Inherited from RcsbFvAbstractModule.buildAlignmentTracks
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:133

`Protected` buildAnnotationsTrack

buildAnnotationsTrack(annotationsRequestContext, annotationsFeatures, annotationConfigMap?): Promise<void>
Parameters
- annotationsRequestContext: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>
- annotationsFeatures: AnnotationFeatures[]
- Optional annotationConfigMap: AnnotationConfigInterface
Returns Promise<void>
Inherited from RcsbFvAbstractModule.buildAnnotationsTrack
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:151

`Protected` concatAlignmentAndAnnotationTracks

concatAlignmentAndAnnotationTracks(): void
Returns void
Overrides RcsbFvAbstractModule.concatAlignmentAndAnnotationTracks
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvInterface.ts:74

display

display(): Promise<void>
Returns Promise<void>
Inherited from RcsbFvAbstractModule.display
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:76

getAlignmentResponse

getAlignmentResponse(): Promise<AlignmentResponse>
Returns Promise<AlignmentResponse>
Inherited from RcsbFvAbstractModule.getAlignmentResponse
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:103

getAnnotationConfigData

getAnnotationConfigData(): Promise<RcsbFvRowConfigInterface[]>
Returns Promise<RcsbFvRowConfigInterface[]>
Inherited from RcsbFvAbstractModule.getAnnotationConfigData
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:112

`Protected` getBoardConfig

getBoardConfig(): Promise<RcsbFvBoardConfigInterface>
Returns Promise<RcsbFvBoardConfigInterface>
Inherited from RcsbFvAbstractModule.getBoardConfig
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:165

getFeatures

getFeatures(): Promise<Feature[]>
Returns Promise<Feature[]>
Inherited from RcsbFvAbstractModule.getFeatures
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:107

getFv

getFv(): RcsbFv<{}, {}, {}, {}>
Returns RcsbFv<{}, {}, {}, {}>
Inherited from RcsbFvAbstractModule.getFv
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:95

getPolymerEntityInstanceTranslator

getPolymerEntityInstanceTranslator(): PolymerEntityInstanceTranslate
Returns PolymerEntityInstanceTranslate
Inherited from RcsbFvAbstractModule.getPolymerEntityInstanceTranslator
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:72

`Protected` getRowsConfig

getRowsConfig(): Promise<RcsbFvRowConfigInterface[]>
Returns Promise<RcsbFvRowConfigInterface[]>
Inherited from RcsbFvAbstractModule.getRowsConfig
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:169

getTargets

getTargets(): Promise<string[]>
Returns Promise<string[]>
Inherited from RcsbFvAbstractModule.getTargets
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:99

`Protected` protectedBuild

protectedBuild(): Promise<void>
Returns Promise<void>
Overrides RcsbFvAbstractModule.protectedBuild
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvInterface.ts:36

setPolymerEntityInstanceTranslator

setPolymerEntityInstanceTranslator(polymerEntityInstance): void
Parameters
- polymerEntityInstance: PolymerEntityInstanceTranslate
Returns void
Inherited from RcsbFvAbstractModule.setPolymerEntityInstanceTranslator
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:68

`Private` titleSuffix

titleSuffix(rcsbContext?): ((ann, d) => Promise<undefined | string>)
Parameters
- Optional rcsbContext: Partial<{
      asymId: string;
      authId: string;
      chrId: string;
      entityId: string;
      entryId: string;
      operatorIds: string[];
      queryId: string;
      targetId: string;
      upAcc: string;
  }>
Returns ((ann, d) => Promise<undefined | string>)
- - (ann, d): Promise<undefined | string>
  - Parameters
    - ann: AnnotationFeatures
    - d: Feature
    Returns Promise<undefined | string>
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvInterface.ts:89

`Private` trackTitle

trackTitle(ann, d): Promise<undefined | string>
Parameters
- ann: AnnotationFeatures
- d: Feature
Returns Promise<undefined | string>
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvInterface.ts:117

`Private` typeSuffix

typeSuffix(ann, d): Promise<undefined | string>
Parameters
- ann: AnnotationFeatures
- d: Feature
Returns Promise<undefined | string>
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvInterface.ts:83

wait

wait(): Promise<void>
Returns Promise<void>
Inherited from RcsbFvAbstractModule.wait
- Defined in src/RcsbFvWeb/RcsbFvModule/RcsbFvAbstractModule.ts:126

Class RcsbFvInterface

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

elementId: string

rcsbFv: RcsbFv<{}, {}, {}, {}>

Returns RcsbFvInterface

Properties

Protected alignmentCollector

Protected alignmentTracks

Protected annotationCollector

Protected annotationTracks

Protected boardConfigData

Protected buildConfig

Protected Readonly elementId

Private instanceId

Protected polymerEntityInstance

Protected Readonly rcsbFv

Type declaration

Type declaration

Type declaration

Type declaration

Protected referenceTrack

Protected rowConfigData

Methods

activeDisplay

Returns boolean

build

Parameters

buildConfig: RcsbFvModuleBuildInterface

Returns Promise<void>

Protected buildAlignmentTracks

Parameters

alignmentRequestContext: AlignmentRequestContextType

alignmentResponse: AlignmentResponse

Optional trackFactories: { alignmentTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, TargetAlignment]>; sequenceTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, string]>; }

Optional alignmentTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, TargetAlignment]>

Optional sequenceTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, string]>

Returns Promise<void>

Protected buildAnnotationsTrack

Parameters

annotationsRequestContext: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>

annotationsFeatures: AnnotationFeatures[]

Optional annotationConfigMap: AnnotationConfigInterface

Returns Promise<void>

Protected concatAlignmentAndAnnotationTracks

Returns void

display

Returns Promise<void>

getAlignmentResponse

Returns Promise<AlignmentResponse>

getAnnotationConfigData

Returns Promise<RcsbFvRowConfigInterface[]>

Protected getBoardConfig

Returns Promise<RcsbFvBoardConfigInterface>

getFeatures

Returns Promise<Feature[]>

getFv

Returns RcsbFv<{}, {}, {}, {}>

getPolymerEntityInstanceTranslator

Returns PolymerEntityInstanceTranslate

Protected getRowsConfig

Returns Promise<RcsbFvRowConfigInterface[]>

getTargets

Returns Promise<string[]>

Protected protectedBuild

Returns Promise<void>

setPolymerEntityInstanceTranslator

Parameters

polymerEntityInstance: PolymerEntityInstanceTranslate

Returns void

Private titleSuffix

Parameters

Optional rcsbContext: Partial<{ asymId: string; authId: string; chrId: string; entityId: string; entryId: string; operatorIds: string[]; queryId: string; targetId: string; upAcc: string; }>

Returns ((ann, d) => Promise<undefined | string>)

`Protected` alignmentCollector

`Protected` alignmentTracks

`Protected` annotationCollector

`Protected` annotationTracks

`Protected` boardConfigData

`Protected` buildConfig

`Protected` `Readonly` elementId

`Private` instanceId

`Protected` polymerEntityInstance

`Protected` `Readonly` rcsbFv

`Protected` referenceTrack

`Protected` rowConfigData

`Protected` buildAlignmentTracks

`Optional` trackFactories: {
alignmentTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, TargetAlignment]>;
sequenceTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, string]>;
}

`Optional` alignmentTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, TargetAlignment]>

`Optional` sequenceTrackFactory?: TrackFactoryInterface<[AlignmentRequestContextType, string]>

`Protected` buildAnnotationsTrack

`Optional` annotationConfigMap: AnnotationConfigInterface

`Protected` concatAlignmentAndAnnotationTracks

`Protected` getBoardConfig

`Protected` getRowsConfig

`Protected` protectedBuild

`Private` titleSuffix

`Optional` rcsbContext: Partial<{
asymId: string;
authId: string;
chrId: string;
entityId: string;
entryId: string;
operatorIds: string[];
queryId: string;
targetId: string;
upAcc: string;
}>

`Private` trackTitle

`Private` typeSuffix