NGL@1.0.0-beta.7 Home Manual Reference Source Gallery
import StructureView from 'ngl/src/structure/structure-view.js'
public class | source

StructureView

Extends:

Structure → StructureView

View on the structure, restricted to the selection

Constructor Summary

Public Constructor
public

constructor(structure: Structure, selection: Selection)

Member Summary

Public Members
public
public get
public
public
public get
public get
public get
public get
public
public get
public
public get
public
public get
public
public get
public get
public get
public get

id

public get
public get
public get
public get
public get
public get
public
public get
public
public get
public get
public get
public get
Private Members
private

_ap

private

_bp

private

_cp

private

_rp

Method Summary

Public Methods
public
public
public
public
public
public
public

Not implemented

public
public
public
public
public

init()

public

Updates atomSet, bondSet, atomSetCache, atomCount, bondCount, boundingBox, center.

public
public

Inherited Summary

From class Structure
public get
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public

id

public
public
public
public
public
public
public

signals: {refreshed: Signal}

public
public
public
public
private

_ap

private

_bp

private

_cp

private

_rp

public

Gets the center of the (selected) structure atoms

public

Calls dispose() method of property objects.

public

eachAtom(callback: function(atom: AtomProxy), selection: Selection): undefined

Atom iterator

public

eachBond(callback: function(bond: BondProxy), selection: Selection): undefined

Bond iterator

public

eachChain(callback: function(chain: ChainProxy), selection: Selection): undefined

Chain iterator

public

eachEntity(callback: function(entity: Entity), type: EntityType): undefined

Entity iterator

public

eachModel(callback: function(model: ModelProxy), selection: Selection): undefined

Model iterator

public

eachPolymer(callback: function(polymer: Polymer), selection: Selection): undefined

Polymer iterator

public

eachResidue(callback: function(residue: ResidueProxy), selection: Selection): undefined

Residue iterator

public

eachResidueN(n: Integer, callback: function(residueList: ResidueProxy[])): undefined

Multi-residue iterator

public
public
public
public
public
public

Get a set of atoms

public

Get set of all atoms within the groups of a selection

public

Get set of atoms around a point

public

Get set of atoms around a set of atoms from a selection

public

getAtomSetWithinVolume(volume: Volume, radius: Number, minValue: [type], maxValue: [type], outside: [type]): BitArray

Get set of atoms within a volume

public
public
public
public
public
public
public

getBoundingBox(selection: Selection, box: Box3): Vector3

Gets the bounding box of the (selected) structure atoms

public
public

Get number of unique chainnames

public
public

Gets the principal axes of the (selected) structure atoms

public
public
public
public
public
public
public
public
public

init()

public
public

Public Constructors

public constructor(structure: Structure, selection: Selection) source

Override:

Structure#constructor

Params:

NameTypeAttributeDescription
structure Structure

the structure

selection Selection

the selection

Public Members

public atomCount source

Override:

Structure#atomCount

public get atomMap source

Override:

Structure#atomMap

public atomSet source

Override:

Structure#atomSet

public atomSetCache source

Override:

Structure#atomSetCache

public get atomSetDict source

Override:

Structure#atomSetDict

public get atomStore source

Override:

Structure#atomStore

public get backboneBondStore source

Override:

Structure#backboneBondStore

public get biomolDict source

Override:

Structure#biomolDict

public bondCount source

Override:

Structure#bondCount

public get bondHash source

Override:

Structure#bondHash

public bondSet source

Override:

Structure#bondSet

public get bondStore source

Override:

Structure#bondStore

public boundingBox source

Override:

Structure#boundingBox

public get boxes source

Override:

Structure#boxes

public center source

Override:

Structure#center

public get chainStore source

Override:

Structure#chainStore

public get entityList source

Override:

Structure#entityList

public get frames source

Override:

Structure#frames

public get id source

Override:

Structure#id

public get modelStore source

Override:

Structure#modelStore

public get name source

Override:

Structure#name

public get path source

Override:

Structure#path

public get residueMap source

Override:

Structure#residueMap

public get residueStore source

Override:

Structure#residueStore

public get rungBondStore source

Override:

Structure#rungBondStore

public selection source

public get spatialHash source

Override:

Structure#spatialHash

public structure source

public get title source

Override:

Structure#title

public get type source

Override:

Structure#type

public get unitcell source

Override:

Structure#unitcell

public get validation source

Override:

Structure#validation

Private Members

private _ap source

Override:

Structure#_ap

private _bp source

Override:

Structure#_bp

private _cp source

Override:

Structure#_cp

private _rp source

Override:

Structure#_rp

Public Methods

public dispose() source

Calls dispose() method of property objects. Unsets properties to help garbage collection.

Override:

Structure#dispose

public eachAtom() source

Atom iterator

Override:

Structure#eachAtom

public eachBond() source

Bond iterator

Override:

Structure#eachBond

public eachChain() source

Chain iterator

Override:

Structure#eachChain

public eachModel() source

Model iterator

Override:

Structure#eachModel

public eachResidue() source

Residue iterator

Override:

Structure#eachResidue

public eachResidueN(): undefined source

Not implemented

Override:

Structure#eachResidueN

Return:

undefined

public getAtomIndices() source

Override:

Structure#getAtomIndices

public getAtomSet() source

Get a set of atoms

Override:

Structure#getAtomSet

public getSelection() source

Override:

Structure#getSelection

public getStructure() source

Override:

Structure#getStructure

public init() source

Override:

Structure#init

public refresh(): undefined source

Updates atomSet, bondSet, atomSetCache, atomCount, bondCount, boundingBox, center.

Return:

undefined

Emit:

Structure.signals.refreshed

when refreshed

public refreshPosition() source

Override:

Structure#refreshPosition

public setSelection() source