Class InterUnitBonds

Hierarchy

InterUnitGraph<number, UnitIndex, InterUnitEdgeProps>
- InterUnitBonds

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InterUnitBonds(map: Map<number, <internal>.InterUnitGraph.UnitPairEdges<number, UnitIndex, InterUnitEdgeProps>[]>): InterUnitBonds

Inherited from InterUnitGraph.constructor
- Defined in node_modules/molstar/lib/mol-math/graph/inter-unit-graph.d.ts:26
Parameters
- map: Map<number, <internal>.InterUnitGraph.UnitPairEdges<number, UnitIndex, InterUnitEdgeProps>[]>
Returns InterUnitBonds

Properties

Readonly edgeCount

edgeCount: number

Number of inter-unit edges

Readonly edges

edges: readonly <internal>.InterUnitGraph.Edge<number, UnitIndex, InterUnitEdgeProps>[]

Array of inter-unit edges

Protected Readonly map

map: Map<number, <internal>.InterUnitGraph.UnitPairEdges<number, UnitIndex, InterUnitEdgeProps>[]>

Methods

getBondFromLocation

getBondFromLocation(l: <internal>.Location<<internal>.Unit>): undefined | <internal>.InterUnitGraph.Edge<number, UnitIndex, InterUnitEdgeProps>

- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/bonds/data.d.ts:28
Get inter-unit bond given a bond-location

Parameters
- l: <internal>.Location<<internal>.Unit>
Returns undefined | <internal>.InterUnitGraph.Edge<number, UnitIndex, InterUnitEdgeProps>

getBondIndexFromLocation

getBondIndexFromLocation(l: <internal>.Location<<internal>.Unit>): number

- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/bonds/data.d.ts:30
Get inter-unit bond index given a bond-location

Parameters
- l: <internal>.Location<<internal>.Unit>
Returns number

getConnectedUnits

getConnectedUnits(unit: number): readonly <internal>.InterUnitGraph.UnitPairEdges<number, UnitIndex, InterUnitEdgeProps>[]

Inherited from InterUnitGraph.getConnectedUnits
- Defined in node_modules/molstar/lib/mol-math/graph/inter-unit-graph.d.ts:17
Get an array of unit-pair-edges that are connected to the given unit

Parameters
- unit: number
Returns readonly <internal>.InterUnitGraph.UnitPairEdges<number, UnitIndex, InterUnitEdgeProps>[]

getEdge

getEdge(indexA: UnitIndex, unitA: number, indexB: UnitIndex, unitB: number): undefined | <internal>.InterUnitGraph.Edge<number, UnitIndex, InterUnitEdgeProps>

Inherited from InterUnitGraph.getEdge
- Defined in node_modules/molstar/lib/mol-math/graph/inter-unit-graph.d.ts:23
Get inter-unit edge given a pair of indices and units

Parameters
- indexA: UnitIndex
- unitA: number
- indexB: UnitIndex
- unitB: number
Returns undefined | <internal>.InterUnitGraph.Edge<number, UnitIndex, InterUnitEdgeProps>

getEdgeIndex

getEdgeIndex(indexA: UnitIndex, unitA: number, indexB: UnitIndex, unitB: number): number

Inherited from InterUnitGraph.getEdgeIndex
- Defined in node_modules/molstar/lib/mol-math/graph/inter-unit-graph.d.ts:19
Index into this.edges

Parameters
- indexA: UnitIndex
- unitA: number
- indexB: UnitIndex
- unitB: number
Returns number

getEdgeIndices

getEdgeIndices(index: UnitIndex, unit: number): readonly number[]

Inherited from InterUnitGraph.getEdgeIndices
- Defined in node_modules/molstar/lib/mol-math/graph/inter-unit-graph.d.ts:25
Indices into this.edges

Parameters
- index: UnitIndex
- unit: number
Returns readonly number[]

hasEdge

hasEdge(indexA: UnitIndex, unitA: number, indexB: UnitIndex, unitB: number): boolean

Inherited from InterUnitGraph.hasEdge
- Defined in node_modules/molstar/lib/mol-math/graph/inter-unit-graph.d.ts:21
Check if edge exists

Parameters
- indexA: UnitIndex
- unitA: number
- indexB: UnitIndex
- unitB: number
Returns boolean

Generated using TypeDoc