Class PluginLayout

Hierarchy

StatefulPluginComponent<PluginLayoutStateProps>
- PluginLayout

Index

Constructors

constructor

new PluginLayout(context: PluginContext): PluginLayout
Parameters
- context: PluginContext
Returns PluginLayout
Overrides StatefulPluginComponent.constructor
- Defined in node_modules/molstar/lib/mol-plugin/layout.d.ts:37

Properties

`Private` context

context: any

`Readonly` events

events: { updated: Subject<unknown> }

Type declaration

updated: Subject<unknown>

`Private` expandedViewport

expandedViewport: any

`Private` getScrollElement

getScrollElement: any

`Private` handleExpand

handleExpand: any

root

root: undefined | HTMLElement

`Private` rootState

rootState: any

`Private` updateProps

updateProps: any

Accessors

`Protected` ev

get ev(): RxEventHelper
Returns RxEventHelper
Inherited from StatefulPluginComponent.ev
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:14

state

get state(): State
Returns State
Inherited from StatefulPluginComponent.state
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:20

Methods

dispose

dispose(): void
Returns void
Inherited from StatefulPluginComponent.dispose
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:15

setProps

setProps(props: Partial<<internal>.Values<{ controlsDisplay: <internal>.Value<PluginLayoutControlsDisplay>; isExpanded: BooleanParam; regionState: <internal>.Group<Normalize<{ bottom: "hidden" | "full"; left: "hidden" | "full" | "collapsed"; right: "hidden" | "full"; top: "hidden" | "full" }>>; showControls: BooleanParam }>>): void
Parameters
- props: Partial<<internal>.Values<{ controlsDisplay: <internal>.Value<PluginLayoutControlsDisplay>; isExpanded: BooleanParam; regionState: <internal>.Group<Normalize<{ bottom: "hidden" | "full"; left: "hidden" | "full" | "collapsed"; right: "hidden" | "full"; top: "hidden" | "full" }>>; showControls: BooleanParam }>>
Returns void
- Defined in node_modules/molstar/lib/mol-plugin/layout.d.ts:33

setRoot

setRoot(root: HTMLElement): void
Parameters
- root: HTMLElement
Returns void
- Defined in node_modules/molstar/lib/mol-plugin/layout.d.ts:34

`Protected` subscribe

subscribe<T>(obs: Observable<T>, action: ((v: T) => void)): { unsubscribe: (() => void) }
Type Parameters
- T
Parameters
- obs: Observable<T>
- action: ((v: T) => void)
  - - (v: T): void
    - Parameters
      
      v: T
      
      Returns void
Returns { unsubscribe: (() => void) }
- unsubscribe: (() => void)
  - - (): void
    - Returns void
Inherited from StatefulPluginComponent.subscribe
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:11

`Protected` updateState

updateState(...states: Partial<<internal>.Values<{ controlsDisplay: <internal>.Value<PluginLayoutControlsDisplay>; isExpanded: BooleanParam; regionState: <internal>.Group<Normalize<{ bottom: "hidden" | "full"; left: "hidden" | "full" | "collapsed"; right: "hidden" | "full"; top: "hidden" | "full" }>>; showControls: BooleanParam }>>[]): boolean
Parameters
- Rest ...states: Partial<<internal>.Values<{ controlsDisplay: <internal>.Value<PluginLayoutControlsDisplay>; isExpanded: BooleanParam; regionState: <internal>.Group<Normalize<{ bottom: "hidden" | "full"; left: "hidden" | "full" | "collapsed"; right: "hidden" | "full"; top: "hidden" | "full" }>>; showControls: BooleanParam }>>[]
Returns boolean
Inherited from StatefulPluginComponent.updateState
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:19

Class PluginLayout

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

context: PluginContext

Returns PluginLayout

Properties

Private context

Readonly events

Type declaration

updated: Subject<unknown>

Private expandedViewport

Private getScrollElement

Private handleExpand

root

Private rootState

Private updateProps

Accessors

Protected ev

Returns RxEventHelper

state

Returns State

Methods

dispose

Returns void

setProps

Parameters

Returns void

setRoot

Parameters

root: HTMLElement

Returns void

Protected subscribe

Type Parameters

T

Parameters

obs: Observable<T>

action: ((v: T) => void)

Parameters

v: T

Returns void

Returns { unsubscribe: (() => void) }

unsubscribe: (() => void)

Returns void

Protected updateState

Parameters

Returns boolean

Settings

Member Visibility

Theme

`Private` context

`Readonly` events

`Private` expandedViewport

`Private` getScrollElement

`Private` handleExpand

`Private` rootState

`Private` updateProps

`Protected` ev

`Protected` subscribe

`Protected` updateState