Class LicoriceRepresentation

Licorice representation object (BallAndStickRepresentation with aspectRatio fixed at 1.0)

Hierarchy

BallAndStickRepresentation
- LicoriceRepresentation
  - HyperballRepresentation

Index

Constructors

constructor

Accessors

defaultScale

Constructors

constructor

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

Overrides BallAndStickRepresentation.constructor
- Defined in src/representation/licorice-representation.js:13
Create Licorice representation object

Parameters
- structure: any
  
  the structure to be represented
- viewer: any
  
  a viewer object
- params: any
  
  ball and stick representation parameters
Returns LicoriceRepresentation

Accessors

defaultScale

get defaultScale(): object

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

Methods

attach

attach(callback: any): void

Inherited from StructureRepresentation.attach

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

Inherited from StructureRepresentation.clear

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

create

create(): void

Inherited from StructureRepresentation.create

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

createData

createData(sview: any): object

Inherited from BallAndStickRepresentation.createData

Overrides StructureRepresentation.createData
- Defined in src/representation/ballandstick-representation.js:141
Parameters
- sview: any
Returns object
- bufferList: (CylinderBuffer | WideLineBuffer | SphereBuffer)[]

dispose

dispose(): void

Inherited from StructureRepresentation.dispose

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

getAssembly

getAssembly(): any

Inherited from StructureRepresentation.getAssembly
- Defined in src/representation/structure-representation.js:149
Returns any

getAtomData

getAtomData(sview: any, what: any, params: any): any

Inherited from BallAndStickRepresentation.getAtomData
- Defined in src/representation/ballandstick-representation.js:123
Parameters
- sview: any
- what: any
- params: any
Returns any

getAtomParams

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

Inherited from BallAndStickRepresentation.getAtomParams

Overrides StructureRepresentation.getAtomParams
- Defined in src/representation/ballandstick-representation.js:116
Parameters
- what: any
- params: any
Returns any

getAtomRadius

getAtomRadius(atom: any): number

Inherited from BallAndStickRepresentation.getAtomRadius

Overrides StructureRepresentation.getAtomRadius
- Defined in src/representation/ballandstick-representation.js:112
Parameters
- atom: any
Returns number

getBondData

getBondData(sview: any, what: any, params: any): any

Inherited from BallAndStickRepresentation.getBondData
- Defined in src/representation/ballandstick-representation.js:137
Parameters
- sview: any
- what: any
- params: any
Returns any

getBondParams

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

Inherited from BallAndStickRepresentation.getBondParams

Overrides StructureRepresentation.getBondParams
- Defined in src/representation/ballandstick-representation.js:127
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

Inherited from StructureRepresentation.getColorParams

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

getParameters

getParameters(): object & object

Inherited from StructureRepresentation.getParameters

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

getQuality

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

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

getRadiusParams

getRadiusParams(): object

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

init

init(params: any): void

Overrides BallAndStickRepresentation.init
- Defined in src/representation/licorice-representation.js:30
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?: object): this

Inherited from BallAndStickRepresentation.setParameters

Overrides StructureRepresentation.setParameters
- Defined in src/representation/ballandstick-representation.js:245
Parameters
- Default value params: object = {}
Returns this

setRadius

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

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

setSelection

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

Inherited from StructureRepresentation.setSelection
- 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

Inherited from StructureRepresentation.update

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

updateData

updateData(what: any, data: any): void

Inherited from BallAndStickRepresentation.updateData

Overrides StructureRepresentation.updateData
- Defined in src/representation/ballandstick-representation.js:183
Parameters
- what: any
- data: any
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