import StructureRepresentation from 'ngl/src/representation/structure-representation.js'
StructureRepresentation
Extends:
Direct Subclass:
Indirect Subclass:
Structure representation
Constructor Summary
Public Constructor | ||
public |
constructor(structure: Structure, viewer: Viewer, params: StructureRepresentationParameters) Create Structure representation object |
Member Summary
Public Members | ||
public |
|
|
public |
|
|
public get |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
Private Members | ||
private |
|
|
private |
|
Method Summary
Public Methods | ||
public |
attach() |
|
public |
clear() |
|
public |
create() |
|
public |
|
|
public |
dispose() |
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
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 |
|
Inherited Summary
From class Representation | ||
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
Counter that keeps track of tasks related to the creation of the representation, including surface calculations. |
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
private |
|
|
private |
|
|
public |
attach() |
|
public |
build() |
|
public |
clear() |
|
public |
create() |
|
public |
dispose() |
|
public |
|
|
public |
|
|
public |
|
|
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 |
|
Public Constructors
public constructor(structure: Structure, viewer: Viewer, params: StructureRepresentationParameters) source
Create Structure representation object
Override:
Representation#constructorParams:
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 radius source
public scale source
public structureView: StructureView source
Private Members
Public Methods
public createData() source
public getAssembly() source
public getAtomParams() source
public getBondParams() source
public getQuality() source
public setParameters(params: StructureRepresentationParameters, what: Object, rebuild: Boolean): StructureRepresentation source
Set representation parameters
Override:
Representation#setParametersParams:
Name | Type | Attribute | Description |
params | StructureRepresentationParameters | structure parameter object |
|
what | Object |
|
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 |
|
whether or not to rebuild the representation |
public setSelection(string: String, silent: Boolean): StructureRepresentation source
Set representation parameters