Class StructureRepresentation

Structure representation

interface

Hierarchy

Representation
- StructureRepresentation

Index

Constructors

constructor

Accessors

defaultScale

Constructors

constructor

new StructureRepresentation(structure: any, viewer: any, params: any): StructureRepresentation

Overrides Representation.constructor
- Defined in src/representation/structure-representation.js:28
Create Structure representation object

Parameters
- structure: any
  
  the structure to be represented
- viewer: any
  
  a viewer object
- params: any
  
  structure representation parameters
Returns StructureRepresentation

Accessors

defaultScale

get defaultScale(): object

- Defined in src/representation/structure-representation.js:101
Returns object
- bfactor: number
- covalent: number
- sstruc: number
- vdw: number

Methods

attach

attach(callback: any): void

Overrides Representation.attach
- Defined in src/representation/structure-representation.js:342
Parameters
- callback: any
Returns void

build

build(updateWhat: any): void

Inherited from Representation.build
- Defined in src/representation/representation.js:355
Parameters
- updateWhat: any
Returns void

clear

clear(): void

Overrides Representation.clear
- Defined in src/representation/structure-representation.js:357
Returns void

create

create(): void

Overrides Representation.create
- Defined in src/representation/structure-representation.js:180
Returns void

createData

createData(): void

- Defined in src/representation/structure-representation.js:212
Returns void

dispose

dispose(): void

Overrides Representation.dispose
- Defined in src/representation/structure-representation.js:363
Returns void

getAssembly

getAssembly(): any

- Defined in src/representation/structure-representation.js:149
Returns any

getAtomParams

getAtomParams(what: any, params: any): any

- Defined in src/representation/structure-representation.js:254
Parameters
- what: any
- params: any
Returns any

getAtomRadius

getAtomRadius(atom: any): number

- Defined in src/representation/structure-representation.js:270
Parameters
- atom: any
Returns number

getBondParams

getBondParams(what: any, params: any): any

- Defined in src/representation/structure-representation.js:262
Parameters
- what: any
- params: any
Returns any

getBufferParams

getBufferParams(p: any): any

Inherited from Representation.getBufferParams
- Defined in src/representation/representation.js:292
Parameters
- p: any
Returns any

getColorParams

getColorParams(): any

Overrides Representation.getColorParams
- Defined in src/representation/structure-representation.js:238
Returns any

getParameters

getParameters(): object & object

Overrides Representation.getParameters
- Defined in src/representation/structure-representation.js:330
Returns object & object

getQuality

getQuality(): "high" | "medium" | "low"

- Defined in src/representation/structure-representation.js:154
Returns "high" | "medium" | "low"

getRadiusParams

getRadiusParams(): object

- Defined in src/representation/structure-representation.js:245
Returns object
- data: any
- scale: any
- size: any
- type: any

init

init(params: any): void

Overrides Representation.init
- Defined in src/representation/structure-representation.js:110
Parameters
- params: any
Returns void

make

make(updateWhat: any, callback: any): void

Inherited from Representation.make
- Defined in src/representation/representation.js:378
Parameters
- updateWhat: any
- callback: any
Returns void

setColor

setColor(value: any, p: any): this

Inherited from Representation.setColor
- Defined in src/representation/representation.js:320
Parameters
- value: any
- p: any
Returns this

setParameters

setParameters(params: any, what?: object, rebuild?: boolean): StructureRepresentation

Overrides Representation.setParameters
- Defined in src/representation/structure-representation.js:305
Set representation parameters

alias

StructureRepresentation#setParameters

Parameters
- params: any
  
  structure parameter object
- Default value what: object = {}
- Default value rebuild: boolean = false
Returns StructureRepresentation

this object

setRadius

setRadius(value: any, p: any): this

- Defined in src/representation/structure-representation.js:136
Parameters
- value: any
- p: any
Returns this

setSelection

setSelection(string: string, silent: boolean): StructureRepresentation

- Defined in src/representation/structure-representation.js:285
Set representation parameters

alias

StructureRepresentation#setSelection

Parameters
- string: string
  
  selection string, see {@tutorial selection-language}
- silent: boolean
Returns StructureRepresentation

this object

setVisibility

setVisibility(value: boolean, noRenderRequest: boolean): Representation

Inherited from Representation.setVisibility
- Defined in src/representation/representation.js:422
Set the visibility of the representation

Parameters
- value: boolean
  
  visibility flag
- noRenderRequest: boolean
Returns Representation

this object

update

update(what: any): void

Overrides Representation.update
- Defined in src/representation/structure-representation.js:216
Parameters
- what: any
Returns void

updateData

updateData(): void

- Defined in src/representation/structure-representation.js:234
Returns void

updateParameters

updateParameters(bufferParams?: object, what: any): void

Inherited from Representation.updateParameters
- Defined in src/representation/representation.js:536
Parameters
- Default value bufferParams: object = {}
- what: any
Returns void

Generated using TypeDoc