import DistanceRepresentation from 'ngl/src/representation/distance-representation.js'

public class | source

DistanceRepresentation

Extends:

Representation → StructureRepresentation → MeasurementRepresentation → DistanceRepresentation

Distance representation

Constructor Summary

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

Member Summary

Public Members
public	atomPair
public	cylinderBuffer
public	labelUnit
public	parameters
public	textBuffer
public	type

Method Summary

Public Methods
public	create()
public	getBondData()
public	getDistanceData()
public	init()
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()

From class StructureRepresentation
public get	defaultScale
public	assembly
public	defaultAssembly
public	needsBuild
public	parameters
public	radius
public	scale
public	structure: Structure
public	structureView: StructureView
public	type
private	dataList: Array
private	selection: Selection
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()

From class MeasurementRepresentation
public	labelAttachment
public	labelBackground
public	labelBackgroundColor
public	labelBackgroundMargin
public	labelBackgroundOpacity
public	labelBorder
public	labelBorderColor
public	labelBorderWidth
public	labelColor
public	labelFontFamily
public	labelFontStyle
public	labelFontWeight
public	labelSize
public	labelVisible
public	labelXOffset
public	labelYOffset
public	labelZOffset
public	labelsdf
public	n
public	parameters
public	getLabelBufferParams()
public	init()
public	setParameters()
public	setVisibility()
public	update()
public	updateData()

Public Constructors

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

Create Distance representation object

Override:

MeasurementRepresentation#constructor

Params:

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

Example:

stage.loadFile( "rcsb://1crn" ).then( function( o ){
    o.addRepresentation( "cartoon" );
    // either give selections (uses first selected atom) ...
    var atomPair = [ [ "1.CA", "4.CA" ], [ "7.CA", "13.CA" ] ];
    // or atom indices
    var atomPair = [ [ 8, 28 ], [ 173, 121 ] ];
    o.addRepresentation( "distance", { atomPair: atomPair } );
    stage.autoView();
} );

DistanceRepresentation

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

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

Override:

Params:

Example:

Public Members

public atomPair source

public cylinderBuffer source

public labelUnit source

public parameters source

Override:

public textBuffer source

public type source

Override:

Public Methods

public create() source

Override:

public getBondData() source

public getDistanceData() source

public init() source

Override:

public updateData() source

Override: