Class UnitRings

Hierarchy

UnitRings

Index

Constructors

Properties

_aromaticRings? _byFingerprint? _index? all unit

Accessors

aromaticRings byFingerprint elementAromaticRingIndices elementRingIndices index ringComponentIndex ringComponents

Constructors

constructor

new UnitRings(all: readonly UnitRing[], unit: <internal>.Unit.Atomic): UnitRings
Parameters
- all: readonly UnitRing[]
- unit: <internal>.Unit.Atomic
Returns UnitRings
- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/rings.d.ts:29

Properties

`Private` `Optional` _aromaticRings

_aromaticRings?: any

`Private` `Optional` _byFingerprint

_byFingerprint?: any

`Private` `Optional` _index

_index?: any

`Readonly` all

all: readonly UnitRing[]

Each ring is specified as an array of indices in Unit.elements.

unit

unit: <internal>.Unit.Atomic

Accessors

aromaticRings

get aromaticRings(): readonly <internal>.UnitRings.Index[]
Returns readonly <internal>.UnitRings.Index[]
- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/rings.d.ts:28

byFingerprint

get byFingerprint(): ReadonlyMap<<internal>.UnitRing.Fingerprint, readonly <internal>.UnitRings.Index[]>
Returns ReadonlyMap<<internal>.UnitRing.Fingerprint, readonly <internal>.UnitRings.Index[]>
- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/rings.d.ts:21

elementAromaticRingIndices

get elementAromaticRingIndices(): ReadonlyMap<UnitIndex, <internal>.UnitRings.Index[]>
Returns ReadonlyMap<UnitIndex, <internal>.UnitRings.Index[]>
- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/rings.d.ts:24

elementRingIndices

get elementRingIndices(): ReadonlyMap<UnitIndex, <internal>.UnitRings.Index[]>
Maps atom index inside a Unit to ring indices (an atom can be part of more than one ring)

Returns ReadonlyMap<UnitIndex, <internal>.UnitRings.Index[]>
- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/rings.d.ts:23

`Private` index

get index(): any
Returns any
- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/rings.d.ts:20

ringComponentIndex

get ringComponentIndex(): readonly ComponentIndex[]
Maps UnitRings.Index to index to ringComponents

Returns readonly ComponentIndex[]
- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/rings.d.ts:26

ringComponents

get ringComponents(): readonly (readonly Index[])[]
Returns readonly (readonly Index[])[]
- Defined in node_modules/molstar/lib/mol-model/structure/structure/unit/rings.d.ts:27

Generated using TypeDoc