Class RcsbAnnotationConfig

Hierarchy

RcsbAnnotationConfig

Index

Constructors

Properties

annotationConfigMap annotationMap annotationTypes mergedTypes

Methods

addMultipleProvenance addNewType addProvenance allTypes checkAndIncludeNewType entityOrder getAnnotationType getConfig getMergeConfig initTypes instanceOrder isMergedType uniprotOrder randomRgba

Constructors

constructor

new RcsbAnnotationConfig(acm?): RcsbAnnotationConfig
Parameters
- Optional acm: AnnotationConfigInterface
Returns RcsbAnnotationConfig
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:35

Properties

`Private` `Readonly` annotationConfigMap

annotationConfigMap: AnnotationConfigInterface

`Private` `Readonly` annotationMap

annotationMap: Map<string, RcsbAnnotationConfigInterface> = ...

`Private` `Readonly` annotationTypes

annotationTypes: {
    entity: Map<string, string[]>;
    external: Map<string, string[]>;
    instance: Map<string, string[]>;
} = ...

Type declaration

entity: Map<string, string[]>
external: Map<string, string[]>
instance: Map<string, string[]>

`Private` `Readonly` mergedTypes

mergedTypes: Map<string, RcsbMergedTypesInterface> = ...

Methods

addMultipleProvenance

addMultipleProvenance(type, provenanceList): void
Parameters
- type: string
- provenanceList: string[]
Returns void
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:190

`Private` addNewType

addNewType(newType, type, titleSuffix?): void
Parameters
- newType: string
- type: string
- Optional titleSuffix: string
Returns void
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:146

`Private` addProvenance

addProvenance(type, provenanceName): void
Parameters
- type: string
- provenanceName: string
Returns void
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:185

allTypes

allTypes(): Set<string>
Returns Set<string>
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:50

`Private` checkAndIncludeNewType

checkAndIncludeNewType(newType, type): void
Parameters
- newType: string
- type: string
Returns void
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:170

entityOrder

entityOrder(): string[]
Returns string[]
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:63

getAnnotationType

getAnnotationType(requestConfig, ann, feature): Promise<string>
Parameters
- requestConfig: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>
- ann: AnnotationFeatures
- feature: Feature
Returns Promise<string>
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:68

instanceOrder

instanceOrder(): string[]
Returns string[]
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:59

isMergedType

isMergedType(type): boolean
Parameters
- type: string
Returns boolean
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:138

uniprotOrder

uniprotOrder(): string[]
Returns string[]
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:55

`Static` randomRgba

randomRgba(str?): string
Parameters
- Optional str: string
Returns string
- Defined in src/RcsbAnnotationConfig/RcsbAnnotationConfig.ts:181

Class RcsbAnnotationConfig

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional acm: AnnotationConfigInterface

Returns RcsbAnnotationConfig

Properties

Private Readonly annotationConfigMap

Private Readonly annotationMap

Private Readonly annotationTypes

Type declaration

entity: Map<string, string[]>

external: Map<string, string[]>

instance: Map<string, string[]>

Private Readonly mergedTypes

Methods

addMultipleProvenance

Parameters

type: string

provenanceList: string[]

Returns void

Private addNewType

Parameters

newType: string

type: string

Optional titleSuffix: string

Returns void

Private addProvenance

Parameters

type: string

provenanceName: string

Returns void

allTypes

Returns Set<string>

Private checkAndIncludeNewType

Parameters

newType: string

type: string

Returns void

entityOrder

Returns string[]

getAnnotationType

Parameters

requestConfig: Partial<AnnotationsCollectConfig & CollectGroupAnnotationsInterface>

ann: AnnotationFeatures

feature: Feature

Returns Promise<string>

getConfig

Parameters

type: string

Returns undefined | RcsbAnnotationConfigInterface

getMergeConfig

Parameters

type: string

Returns undefined | RcsbMergedTypesInterface

Private initTypes

Returns void

instanceOrder

Returns string[]

isMergedType

Parameters

type: string

Returns boolean

uniprotOrder

Returns string[]

Static randomRgba

Parameters

Optional str: string

Returns string

Settings

Member Visibility

Theme

On This Page

`Optional` acm: AnnotationConfigInterface

`Private` `Readonly` annotationConfigMap

`Private` `Readonly` annotationMap

`Private` `Readonly` annotationTypes

`Private` `Readonly` mergedTypes

`Private` addNewType

`Optional` titleSuffix: string

`Private` addProvenance

`Private` checkAndIncludeNewType

`Private` initTypes

`Static` randomRgba

`Optional` str: string