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

Type Parameters

T
R
S
U

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, S, U>(config: RcsbFv3DAbstractInterface<T, R, S, U>): RcsbFv3DAbstract<T, R, S, U>
Type Parameters
- T
- R
- S
- U
Parameters
- config: RcsbFv3DAbstractInterface<T, R, S, U>
Returns RcsbFv3DAbstract<T, R, S, U>
- Defined in RcsbFv3D/RcsbFv3DAbstract.tsx:38

Properties

`Private` `Readonly` cssConfig

cssConfig: undefined | {
    rootPanel?: CSSProperties;
    sequencePanel?: CSSProperties;
    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, R, U>

`Private` `Readonly` structureConfig

structureConfig: RcsbFvStructureConfigInterface<R, S>

`Private` `Readonly` structureViewer

structureViewer: StructureViewerInterface<R, S>

`Private` `Readonly` structureViewerBehaviourObserver

structureViewerBehaviourObserver: StructureViewerBehaviourObserverInterface<R>

Methods

`Private` fullScreen

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

pluginCall

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

render

render(): void
Returns void
- Defined in RcsbFv3D/RcsbFv3DAbstract.tsx:47

unmount

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

updateConfig

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

Generated using TypeDoc