Class RcsbFv3DAbstract<T, R, L, S, U>`Abstract`

Type Parameters

Hierarchy

RcsbFv3DAbstract

Index

Constructors

Properties

cssConfig ctxManager elementId fullScreenFlag overflowStyle reactRoot sequenceConfig structureConfig structureViewer structureViewerBehaviourObserver

Methods

fullScreen pluginCall render unmount updateConfig

Constructors

`Protected` constructor

new RcsbFv3DAbstract<T, R, L, S, U>(config): RcsbFv3DAbstract<T, R, L, S, U>
Type Parameters
- T
- R
- L
- S
- U
Parameters
- config: RcsbFv3DAbstractInterface<T, R, L, S, U>
Returns RcsbFv3DAbstract<T, R, L, S, U>
- Defined in src/RcsbFv3D/RcsbFv3DAbstract.tsx:39

Properties

`Private` `Readonly` cssConfig

cssConfig: undefined | {
    rootPanel?: CSSProperties;
    sequencePanel?: CSSProperties;
    structurePanel?: CSSProperties;
}

Type declaration

Optional rootPanel?: CSSProperties
Optional sequencePanel?: CSSProperties
Optional structurePanel?: CSSProperties

`Private` `Readonly` ctxManager

ctxManager: RcsbFvContextManager<T, R, S, U> = ...

`Private` `Readonly` elementId

elementId: string

`Private` fullScreenFlag

fullScreenFlag: boolean = false

`Private` overflowStyle

overflowStyle: string = ""

`Private` reactRoot

reactRoot: Root

`Private` `Readonly` sequenceConfig

sequenceConfig: RcsbFvSequenceInterface<T, U>

`Private` `Readonly` structureConfig

structureConfig: RcsbFvStructureConfigInterface<R, S>

`Private` `Readonly` structureViewer

structureViewer: StructureViewerInterface<R, L, S>

`Private` `Readonly` structureViewerBehaviourObserver

structureViewerBehaviourObserver: StructureViewerBehaviourObserverInterface<R, L>

Methods

`Private` fullScreen

fullScreen(mode): void
Parameters
- mode: "off" | "on"
Returns void
- Defined in src/RcsbFv3D/RcsbFv3DAbstract.tsx:96

pluginCall

pluginCall(f): void
Parameters
- f: ((plugin) => void)
  - - (plugin): void
    - Parameters
      plugin: PluginContext
      Returns void
Returns void
- Defined in src/RcsbFv3D/RcsbFv3DAbstract.tsx:92

render

render(): Promise<void>
Returns Promise<void>
- Defined in src/RcsbFv3D/RcsbFv3DAbstract.tsx:48

unmount

unmount(removeHtmlElement?, unmountCallback?): void
Parameters
- Optional removeHtmlElement: boolean
- Optional unmountCallback: (() => {})
  - - (): {}
    - Returns {}
Returns void
- Defined in src/RcsbFv3D/RcsbFv3DAbstract.tsx:75

updateConfig

updateConfig(config): void
Parameters
- config: {
  sequencePanelConfig?: Partial<RcsbFvSequenceInterface<T, U>>;
  structurePanelConfig?: Partial<RcsbFvStructureConfigInterface<R, S>>;
  }
  - Optional sequencePanelConfig?: Partial<RcsbFvSequenceInterface<T, U>>
  - Optional structurePanelConfig?: Partial<RcsbFvStructureConfigInterface<R, S>>
Returns void
- Defined in src/RcsbFv3D/RcsbFv3DAbstract.tsx:88

Class RcsbFv3DAbstract<T, R, L, S, U>Abstract

Type Parameters

T

R

L

S

U

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type Parameters

T

R

L

S

U

Parameters

config: RcsbFv3DAbstractInterface<T, R, L, S, U>

Returns RcsbFv3DAbstract<T, R, L, S, U>

Properties

Private Readonly cssConfig

Type declaration

Optional rootPanel?: CSSProperties

Optional sequencePanel?: CSSProperties

Optional structurePanel?: CSSProperties

Private Readonly ctxManager

Private Readonly elementId

Private fullScreenFlag

Private overflowStyle

Private reactRoot

Private Readonly sequenceConfig

Private Readonly structureConfig

Private Readonly structureViewer

Private Readonly structureViewerBehaviourObserver

Methods

Private fullScreen

Parameters

mode: "off" | "on"

Returns void

pluginCall

Parameters

f: ((plugin) => void)

Parameters

plugin: PluginContext

Returns void

Returns void

render

Returns Promise<void>

unmount

Parameters

Optional removeHtmlElement: boolean

Optional unmountCallback: (() => {})

Returns {}

Returns void

updateConfig

Parameters

config: { sequencePanelConfig?: Partial<RcsbFvSequenceInterface<T, U>>; structurePanelConfig?: Partial<RcsbFvStructureConfigInterface<R, S>>; }

Optional sequencePanelConfig?: Partial<RcsbFvSequenceInterface<T, U>>

Optional structurePanelConfig?: Partial<RcsbFvStructureConfigInterface<R, S>>

Returns void

Settings

Member Visibility

Theme

On This Page

Class RcsbFv3DAbstract<T, R, L, S, U>`Abstract`

`Protected` constructor

`Private` `Readonly` cssConfig

`Optional` rootPanel?: CSSProperties

`Optional` sequencePanel?: CSSProperties

`Optional` structurePanel?: CSSProperties

`Private` `Readonly` ctxManager

`Private` `Readonly` elementId

`Private` fullScreenFlag

`Private` overflowStyle

`Private` reactRoot

`Private` `Readonly` sequenceConfig

`Private` `Readonly` structureConfig

`Private` `Readonly` structureViewer

`Private` `Readonly` structureViewerBehaviourObserver

`Private` fullScreen

`Optional` removeHtmlElement: boolean

`Optional` unmountCallback: (() => {})

config: {
sequencePanelConfig?: Partial<RcsbFvSequenceInterface<T, U>>;
structurePanelConfig?: Partial<RcsbFvStructureConfigInterface<R, S>>;
}

`Optional` sequencePanelConfig?: Partial<RcsbFvSequenceInterface<T, U>>

`Optional` structurePanelConfig?: Partial<RcsbFvStructureConfigInterface<R, S>>