import StructureRepresentation from 'ngl/src/representation/structure-representation.js'

public interface | source

StructureRepresentation

Extends:

Representation → StructureRepresentation

Direct Subclass:

AxesRepresentation, BallAndStickRepresentation, CartoonRepresentation, ContactRepresentation, HelixorientRepresentation, LabelRepresentation, LineRepresentation, MeasurementRepresentation, MolecularSurfaceRepresentation, PointRepresentation, RibbonRepresentation, RocketRepresentation, SpacefillRepresentation, TraceRepresentation, TrajectoryRepresentation, UnitcellRepresentation, ValidationRepresentation

Indirect Subclass:

AngleRepresentation, BackboneRepresentation, BaseRepresentation, DihedralRepresentation, DistanceRepresentation, HyperballRepresentation, LicoriceRepresentation, RopeRepresentation, TubeRepresentation

Structure representation

Constructor Summary

Public Constructor
public	constructor(structure: Structure, viewer: Viewer, params: StructureRepresentationParameters) Create Structure representation object

Member Summary

Public Members
public	assembly
public	defaultAssembly
public get	defaultScale
public	needsBuild
public	parameters
public	radius
public	scale
public	structure: Structure
public	structureView: StructureView
public	type

Private Members
private	dataList: Array
private	selection: Selection

Method Summary

Public Methods
public	attach()
public	clear()
public	create()
public	createData()
public	dispose()
public	getAssembly()
public	getAtomParams()
public	getBondParams()
public	getColorParams()
public	getParameters()
public	getQuality()
public	init()
public	setParameters(params: StructureRepresentationParameters, what: Object, rebuild: Boolean): StructureRepresentation Set representation parameters
public	setSelection(string: String, silent: Boolean): StructureRepresentation Set representation parameters
public	update()
public	updateData()

Inherited Summary

From class Representation
public	[name]
public	clipCenter
public	clipNear
public	clipRadius
public	colorDomain
public	colorMode
public	colorReverse
public	colorScale
public	colorScheme
public	colorValue
public	depthWrite
public	diffuse
public	disableImpostor
public	disablePicking
public	disposed
public	flatShaded
public	lazy
public	lazyProps
public	matrix
public	metalness
public	opacity
public	openEnded
public	parameters
public	quality
public	radialSegments
public	roughness
public	side
public	sphereDetail
public	tasks: Counter Counter that keeps track of tasks related to the creation of the representation, including surface calculations.
public	type
public	viewer: Viewer
public	visible
public	wireframe
private	bufferList: Array
private	queue: Queue
public	attach()
public	build()
public	clear()
public	create()
public	dispose()
public	getBufferParams()
public	getColorParams()
public	getParameters()
public	init()
public	make()
public	setColor()
public	setParameters(params: RepresentationParameters, what: Object, rebuild: Boolean): Representation Set the visibility of the representation
public	setVisibility(value: Boolean, noRenderRequest: Boolean): Representation Set the visibility of the representation
public	update()
public	updateParameters()

Public Constructors

public constructor(structure: Structure, viewer: Viewer, params: StructureRepresentationParameters) source

Create Structure representation object

Override:

Representation#constructor

Params:

Name	Type	Attribute	Description
structure	Structure		the structure to be represented
viewer	Viewer		a viewer object
params	StructureRepresentationParameters		structure representation parameters

Public Members

public assembly source

public defaultAssembly source

public get defaultScale source

public needsBuild source

public parameters source

Override:

Representation#parameters

public radius source

public scale source

public structure: Structure source

public structureView: StructureView source

public type source

Override:

Representation#type

Private Members

private dataList: Array source

private selection: Selection source

Public Methods

public attach() source

Override:

Representation#attach

public clear() source

Override:

Representation#clear

public create() source

Override:

Representation#create

public createData() source

public dispose() source

Override:

Representation#dispose

public getAssembly() source

public getAtomParams() source

public getBondParams() source

public getColorParams() source

Override:

Representation#getColorParams

public getParameters() source

Override:

Representation#getParameters

public getQuality() source

public init() source

Override:

Representation#init

public setParameters(params: StructureRepresentationParameters, what: Object, rebuild: Boolean): StructureRepresentation source

Set representation parameters

Override:

Representation#setParameters

Params:

Name	Type	Attribute	Description
params	StructureRepresentationParameters		structure parameter object
what	Object	optional	buffer data attributes to be updated, note that this needs to be implemented in the derived classes. Generally it allows more fine-grained control over updating than forcing a rebuild.
what.position	Boolean		update position data
what.color	Boolean		update color data
rebuild	Boolean	optional	whether or not to rebuild the representation

Return:

StructureRepresentation

this object

public setSelection(string: String, silent: Boolean): StructureRepresentation source

Set representation parameters

Params:

Name	Type	Attribute	Description
string	String		selection string, see {@tutorial selection-language}
silent	Boolean	optional	don't trigger a change event in the selection

Return:

StructureRepresentation

this object

public update() source

Override:

Representation#update

StructureRepresentation

Extends:

Direct Subclass:

Indirect Subclass:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(structure: Structure, viewer: Viewer, params: StructureRepresentationParameters) source

Override:

Params:

Public Members

public assembly source

public defaultAssembly source

public get defaultScale source

public needsBuild source

public parameters source

Override:

public radius source

public scale source

public structure: Structure source

public structureView: StructureView source

public type source

Override:

Private Members

private dataList: Array source

private selection: Selection source

Public Methods

public attach() source

Override:

public clear() source

Override:

public create() source

Override:

public createData() source

public dispose() source

Override:

public getAssembly() source

public getAtomParams() source

public getBondParams() source

public getColorParams() source

Override:

public getParameters() source

Override:

public getQuality() source

public init() source

Override:

public setParameters(params: StructureRepresentationParameters, what: Object, rebuild: Boolean): StructureRepresentation source

Override:

Params:

Return:

public setSelection(string: String, silent: Boolean): StructureRepresentation source

Params:

Return:

public update() source

Override:

public updateData() source