Class StructureMeasurementManager

Hierarchy

StatefulPluginComponent<StructureMeasurementManagerState>
- StructureMeasurementManager

Index

Constructors

constructor

new StructureMeasurementManager(plugin: PluginContext): StructureMeasurementManager
Parameters
- plugin: PluginContext
Returns StructureMeasurementManager
Overrides StatefulPluginComponent.constructor
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/measurement.d.ts:67

Properties

`Private` _empty

_empty: any

`Readonly` behaviors

behaviors: { state: BehaviorSubject<StructureMeasurementManagerState> }

Type declaration

state: BehaviorSubject<StructureMeasurementManagerState>

`Private` getGroup

getGroup: any

`Private` getTransforms

getTransforms: any

`Private` plugin

plugin: any

`Private` stateUpdated

stateUpdated: any

`Private` sync

sync: 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

addAngle

addAngle(a: <internal>.Loci, b: <internal>.Loci, c: <internal>.Loci, options?: StructureMeasurementManagerAddOptions & { visualParams?: Partial<Normalize<{ alpha: number; arcScale: number; attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; background: boolean; backgroundColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; backgroundMargin: number; backgroundOpacity: number; borderColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; borderWidth: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; color: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; customText: string; dashLength: number; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; fontFamily: <internal>.FontFamily; fontQuality: number; fontStyle: <internal>.FontStyle; fontVariant: <internal>.FontVariant; fontWeight: <internal>.FontWeight; ignoreLight: boolean; instanceGranularity: boolean; lineSizeAttenuation: boolean; linesSize: number; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; offsetX: number; offsetY: number; offsetZ: number; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; sectorOpacity: number; sizeFactor: number; tether: boolean; tetherBaseWidth: number; tetherLength: number; textColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; textSize: number; transparentBackfaces: string; visuals: ("text" | "vectors" | "sector" | "arc")[]; xrayShaded: boolean }>> }): Promise<void>
Parameters
- a: <internal>.Loci
- b: <internal>.Loci
- c: <internal>.Loci
- Optional options: StructureMeasurementManagerAddOptions & { visualParams?: Partial<Normalize<{ alpha: number; arcScale: number; attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; background: boolean; backgroundColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; backgroundMargin: number; backgroundOpacity: number; borderColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; borderWidth: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; color: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; customText: string; dashLength: number; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; fontFamily: <internal>.FontFamily; fontQuality: number; fontStyle: <internal>.FontStyle; fontVariant: <internal>.FontVariant; fontWeight: <internal>.FontWeight; ignoreLight: boolean; instanceGranularity: boolean; lineSizeAttenuation: boolean; linesSize: number; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; offsetX: number; offsetY: number; offsetZ: number; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; sectorOpacity: number; sizeFactor: number; tether: boolean; tetherBaseWidth: number; tetherLength: number; textColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; textSize: number; transparentBackfaces: string; visuals: ("text" | "vectors" | "sector" | "arc")[]; xrayShaded: boolean }>> }
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/measurement.d.ts:52

addDihedral

addDihedral(a: <internal>.Loci, b: <internal>.Loci, c: <internal>.Loci, d: <internal>.Loci, options?: StructureMeasurementManagerAddOptions & { visualParams?: Partial<Normalize<{ alpha: number; arcScale: number; attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; background: boolean; backgroundColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; backgroundMargin: number; backgroundOpacity: number; borderColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; borderWidth: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; color: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; customText: string; dashLength: number; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; fontFamily: <internal>.FontFamily; fontQuality: number; fontStyle: <internal>.FontStyle; fontVariant: <internal>.FontVariant; fontWeight: <internal>.FontWeight; ignoreLight: boolean; instanceGranularity: boolean; lineSizeAttenuation: boolean; linesSize: number; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; offsetX: number; offsetY: number; offsetZ: number; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; sectorOpacity: number; sizeFactor: number; tether: boolean; tetherBaseWidth: number; tetherLength: number; textColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; textSize: number; transparentBackfaces: string; visuals: ("text" | "vectors" | "sector" | "arc" | "extenders" | "arms" | "connector")[]; xrayShaded: boolean }>> }): Promise<void>
Parameters
- a: <internal>.Loci
- b: <internal>.Loci
- c: <internal>.Loci
- d: <internal>.Loci
- Optional options: StructureMeasurementManagerAddOptions & { visualParams?: Partial<Normalize<{ alpha: number; arcScale: number; attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; background: boolean; backgroundColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; backgroundMargin: number; backgroundOpacity: number; borderColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; borderWidth: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; color: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; customText: string; dashLength: number; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; fontFamily: <internal>.FontFamily; fontQuality: number; fontStyle: <internal>.FontStyle; fontVariant: <internal>.FontVariant; fontWeight: <internal>.FontWeight; ignoreLight: boolean; instanceGranularity: boolean; lineSizeAttenuation: boolean; linesSize: number; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; offsetX: number; offsetY: number; offsetZ: number; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; sectorOpacity: number; sizeFactor: number; tether: boolean; tetherBaseWidth: number; tetherLength: number; textColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; textSize: number; transparentBackfaces: string; visuals: ("text" | "vectors" | "sector" | "arc" | "extenders" | "arms" | "connector")[]; xrayShaded: boolean }>> }
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/measurement.d.ts:55

addDistance

addDistance(a: <internal>.Loci, b: <internal>.Loci, options?: StructureMeasurementManagerAddOptions & { visualParams?: Partial<Normalize<{ alpha: number; attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; background: boolean; backgroundColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; backgroundMargin: number; backgroundOpacity: number; borderColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; borderWidth: number; clip: Normalize<{ objects: any; variant: any }>; customText: string; dashLength: number; fontFamily: <internal>.FontFamily; fontQuality: number; fontStyle: <internal>.FontStyle; fontVariant: <internal>.FontVariant; fontWeight: <internal>.FontWeight; instanceGranularity: boolean; lineSizeAttenuation: boolean; linesColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; linesSize: number; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; offsetX: number; offsetY: number; offsetZ: number; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; sizeFactor: number; tether: boolean; tetherBaseWidth: number; tetherLength: number; textColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; textSize: number; unitLabel: string; visuals: ("text" | "lines")[] }>> }): Promise<void>
Parameters
- a: <internal>.Loci
- b: <internal>.Loci
- Optional options: StructureMeasurementManagerAddOptions & { visualParams?: Partial<Normalize<{ alpha: number; attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; background: boolean; backgroundColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; backgroundMargin: number; backgroundOpacity: number; borderColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; borderWidth: number; clip: Normalize<{ objects: any; variant: any }>; customText: string; dashLength: number; fontFamily: <internal>.FontFamily; fontQuality: number; fontStyle: <internal>.FontStyle; fontVariant: <internal>.FontVariant; fontWeight: <internal>.FontWeight; instanceGranularity: boolean; lineSizeAttenuation: boolean; linesColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; linesSize: number; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; offsetX: number; offsetY: number; offsetZ: number; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; sizeFactor: number; tether: boolean; tetherBaseWidth: number; tetherLength: number; textColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; textSize: number; unitLabel: string; visuals: ("text" | "lines")[] }>> }
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/measurement.d.ts:49

addLabel

addLabel(a: <internal>.Loci, options?: Omit<StructureMeasurementManagerAddOptions, "customText" | "lineParams"> & { visualParams?: Partial<Normalize<{ alpha: number; attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; background: boolean; backgroundColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; backgroundMargin: number; backgroundOpacity: number; borderColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; borderWidth: number; clip: Normalize<{ objects: any; variant: any }>; customText: string; fontFamily: <internal>.FontFamily; fontQuality: number; fontStyle: <internal>.FontStyle; fontVariant: <internal>.FontVariant; fontWeight: <internal>.FontWeight; instanceGranularity: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; offsetX: number; offsetY: number; offsetZ: number; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; scaleByRadius: boolean; sizeFactor: number; tether: boolean; tetherBaseWidth: number; tetherLength: number; textColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; textSize: number; visuals: "text"[] }>> }): Promise<void>
Parameters
- a: <internal>.Loci
- Optional options: Omit<StructureMeasurementManagerAddOptions, "customText" | "lineParams"> & { visualParams?: Partial<Normalize<{ alpha: number; attachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"; background: boolean; backgroundColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; backgroundMargin: number; backgroundOpacity: number; borderColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; borderWidth: number; clip: Normalize<{ objects: any; variant: any }>; customText: string; fontFamily: <internal>.FontFamily; fontQuality: number; fontStyle: <internal>.FontStyle; fontVariant: <internal>.FontVariant; fontWeight: <internal>.FontWeight; instanceGranularity: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; offsetX: number; offsetY: number; offsetZ: number; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; scaleByRadius: boolean; sizeFactor: number; tether: boolean; tetherBaseWidth: number; tetherLength: number; textColor: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; textSize: number; visuals: "text"[] }>> }
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/measurement.d.ts:58

addOrderLabels

addOrderLabels(locis: <internal>.Loci[]): Promise<void>
Parameters
- locis: <internal>.Loci[]
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/measurement.d.ts:63

addOrientation

addOrientation(locis: <internal>.Loci[]): Promise<void>
Parameters
- locis: <internal>.Loci[]
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/measurement.d.ts:61

addPlane

addPlane(locis: <internal>.Loci[]): Promise<void>
Parameters
- locis: <internal>.Loci[]
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/measurement.d.ts:62

dispose

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

setOptions

setOptions(options: StructureMeasurementOptions): Promise<void>
Parameters
- options: StructureMeasurementOptions
Returns Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin-state/manager/structure/measurement.d.ts:48

`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<StructureMeasurementManagerState>[]): boolean
Parameters
- Rest ...states: Partial<StructureMeasurementManagerState>[]
Returns boolean
Inherited from StatefulPluginComponent.updateState
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:19

Class StructureMeasurementManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

plugin: PluginContext

Returns StructureMeasurementManager

Properties

Private _empty

Readonly behaviors

Type declaration

state: BehaviorSubject<StructureMeasurementManagerState>

Private getGroup

Private getTransforms

Private plugin

Private stateUpdated

Private sync

Accessors

Protected ev

Returns RxEventHelper

state

Returns State

Methods

addAngle

Parameters

a: <internal>.Loci

b: <internal>.Loci

c: <internal>.Loci

Returns Promise<void>

addDihedral

Parameters

a: <internal>.Loci

b: <internal>.Loci

c: <internal>.Loci

d: <internal>.Loci

Returns Promise<void>

addDistance

Parameters

a: <internal>.Loci

b: <internal>.Loci

Returns Promise<void>

addLabel

Parameters

a: <internal>.Loci

Returns Promise<void>

addOrderLabels

Parameters

locis: <internal>.Loci[]

Returns Promise<void>

addOrientation

Parameters

locis: <internal>.Loci[]

Returns Promise<void>

addPlane

Parameters

locis: <internal>.Loci[]

Returns Promise<void>

dispose

Returns void

setOptions

Parameters

options: StructureMeasurementOptions

Returns Promise<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

`Private` _empty

`Readonly` behaviors

`Private` getGroup

`Private` getTransforms

`Private` plugin

`Private` stateUpdated

`Private` sync

`Protected` ev

`Protected` subscribe

`Protected` updateState

`Rest` ...states: Partial<StructureMeasurementManagerState>[]