import StructureComponent from 'ngl/src/component/structure-component.js'

public class | source

StructureComponent

Extends:

Component → StructureComponent

Component wrapping a Structure object

Example:

// get a structure component by loading a structure file into the stage
stage.loadFile( "rcsb://4opj" ).then( function( structureComponent ){
    structureComponent.addRepresentation( "cartoon" );
    structureComponent.autoView();
} );

Constructor Summary

Public Constructor
public	constructor(stage: Stage, structure: Structure, params: ComponentParameters) Create structure component

Member Summary

Public Members
public	defaultAssembly
public	signals: StructureComponentSignals Events emitted by the component
public	structure: Structure The wrapped structure
public	structureView: StructureView View on StructureComponent#structure.
public	trajList
public get	type: String Component type

Private Members
private	selection: Selection Selection for StructureComponent#structureView

Method Summary

Public Methods
public	addRepresentation(type: String, params: StructureRepresentationParameters): RepresentationComponent Add a new structure representation to the component
public	addTrajectory(trajPath: String \| Frames, params: TrajectoryComponentParameters \| TrajectoryParameters): TrajectoryComponent Add a new trajectory component to the structure
public	autoView(sele: String \| Integer, duration: Integer): undefined Automatically center and zoom the component
public	dispose()
public	getBoxUntransformed()
public	getCenterUntransformed()
public	rebuildRepresentations(): undefined Rebuild all representations
public	rebuildTrajectories(): undefined Rebuild all trajectories
public	removeTrajectory()
public	setDefaultAssembly(value: String): undefined Set the default assembly
public	setSelection(string: String): StructureComponent Set selection of StructureComponent#structureView
public	setVisibility()
public	superpose()

Private Methods
private	initSelection(sele: String): undefined Initialize selection

Inherited Summary

From class Component
public get	type
public	annotationList
public	controls
public	matrix
public	name
public	position
public	quaternion
public	reprList
public	scale
public	signals: ComponentSignals Events emitted by the component
public	stage
public	status
public	transform
public	uuid
public	viewer
public	visible
public	addAnnotation(position: Vector3, content: String \| Element, params: Object): Annotation Add an anotation object
public	addBufferRepresentation()
public	addRepresentation(type: String, object: Object, params: RepresentationParameters): RepresentationComponent Add a new representation to the component
public	autoView(duration: Integer): undefined Automatically center and zoom the component
public	dispose()
public	eachAnnotation(callback: Function): undefined Iterator over each annotation and executing the callback
public	eachRepresentation(callback: Function): undefined Iterator over each representation and executing the callback
public	getBox(): Box3
public abstract	getBoxUntransformed(): Box3
public	getCenter(): Vector3
public	getCenterUntransformed()
public	getZoom()
public	hasRepresentation()
public	removeAllAnnotations(): undefined Remove all annotations from the component
public	removeAllRepresentations(): undefined Removes all representation components
public	removeAnnotation(annotation: Annotation): undefined Remove the give annotation from the component
public	removeRepresentation(repr: RepresentationComponent): undefined Removes a representation component
public	setName()
public	setPosition(p: Vector3 \| Array): Component Set position transform
public	setRotation(r: Quaternion \| Euler \| Array): Component Set rotation transform
public	setScale(s: Number): Component Set scale transform
public	setStatus()
public	setTransform(m: Matrix4): Component Set general transform.
public	setVisibility(value: Boolean): Component Set the visibility of the component, including added representations
public	updateMatrix()
public	updateRepresentations()

Public Constructors

public constructor(stage: Stage, structure: Structure, params: ComponentParameters) source

Create structure component

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
stage	Stage		stage object the component belongs to
structure	Structure		structure object to wrap
params	ComponentParameters		component parameters

Public Members

public defaultAssembly source

public signals: StructureComponentSignals source

Events emitted by the component

Override:

Component#signals

public structure: Structure source

The wrapped structure

public structureView: StructureView source

View on StructureComponent#structure. Change its selection via StructureComponent#setSelection.

public trajList source

public get type: String source

Component type

Override:

Component#type

Private Members

private selection: Selection source

Selection for StructureComponent#structureView

Public Methods

public addRepresentation(type: String, params: StructureRepresentationParameters): RepresentationComponent source

Add a new structure representation to the component

Override:

Component#addRepresentation

Params:

Name	Type	Attribute	Description
type	String		the name of the representation, one of: axes, backbone, ball+stick, base, cartoon, contact, distance, helixorient, hyperball, label, licorice, line surface, ribbon, rocket, rope, spacefill, trace, tube, unitcell.
params	StructureRepresentationParameters		representation parameters

Return:

RepresentationComponent

the created representation wrapped into a representation component object

public addTrajectory(trajPath: String | Frames, params: TrajectoryComponentParameters | TrajectoryParameters): TrajectoryComponent source

Add a new trajectory component to the structure

Params:

Name	Type	Attribute	Description
trajPath	String \| Frames		path or frames object
params	TrajectoryComponentParameters \| TrajectoryParameters		parameters

Return:

TrajectoryComponent

the created trajectory component object

public autoView(sele: String | Integer, duration: Integer): undefined source

Automatically center and zoom the component

Override:

Component#autoView

Params:

Name	Type	Attribute	Description
sele	String \| Integer	optional	selection string or duration if integer
duration	Integer	optional	duration of the animation, defaults to 0