Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StructureRepresentationParameters

Structure representation parameter object.

mixes

RepresentationParameters

property

{String} radiusType - A list of possible sources of the radius used for rendering the representation. The radius can be based on the vdW radius, the covalent radius or the B-factor value of the corresponding atom. Additionally the radius can be based on the secondary structure. Alternatively, when set to size, the value from the radius parameter is used for all atoms.

property

{Float} radius - A number providing a fixed radius used for rendering the representation.

property

{Float} scale - A number that scales the value defined by the radius or the radiusType parameter.

property

{String} assembly - name of an assembly object. Included are the asymmetric unit (AU) corresponding to the coordinates given in the structure file, biological assemblies from PDB, mmCIF or MMTF files (BU1, BU2, ...), a filled (crystallographic) unitcell of a given space group (UNITCELL), a supercell consisting of a center unitcell and its 26 direct neighbors (SUPERCELL). Set to default to use the default asemmbly of the structure object.

Hierarchy

Indexable

[key: string]: any

Structure representation parameter object.

mixes

RepresentationParameters

property

{String} radiusType - A list of possible sources of the radius used for rendering the representation. The radius can be based on the vdW radius, the covalent radius or the B-factor value of the corresponding atom. Additionally the radius can be based on the secondary structure. Alternatively, when set to size, the value from the radius parameter is used for all atoms.

property

{Float} radius - A number providing a fixed radius used for rendering the representation.

property

{Float} scale - A number that scales the value defined by the radius or the radiusType parameter.

property

{String} assembly - name of an assembly object. Included are the asymmetric unit (AU) corresponding to the coordinates given in the structure file, biological assemblies from PDB, mmCIF or MMTF files (BU1, BU2, ...), a filled (crystallographic) unitcell of a given space group (UNITCELL), a supercell consisting of a center unitcell and its 26 direct neighbors (SUPERCELL). Set to default to use the default asemmbly of the structure object.

Index

Properties

assembly

assembly: string

clipCenter

clipCenter: Vector3

clipNear

clipNear: number

clipRadius

clipRadius: number

color

color: number | string | Color

colorDomain

colorDomain: number[]

colorMode

colorMode: ColorMode

colorReverse

colorReverse: boolean

colorScale

colorScale: string | number[]

colorScheme

colorScheme: string

colorValue

colorValue: number

depthWrite

depthWrite: boolean

diffuse

diffuse: Color

diffuseInterior

diffuseInterior: boolean

disableImpostor

disableImpostor: boolean

disablePicking

disablePicking: boolean

flatShaded

flatShaded: boolean

interiorColor

interiorColor: Color

interiorDarkening

interiorDarkening: number

lazy

lazy: boolean

matrix

matrix: Matrix4

metalness

metalness: number

name

name: string

opacity

opacity: number

openEnded

openEnded: boolean

quality

quality: string

radialSegments

radialSegments: number

radius

radius: number

radiusType

radiusType: string

roughness

roughness: number

scale

scale: number

side

sphereDetail

sphereDetail: number

useInteriorColor

useInteriorColor: boolean

visible

visible: boolean

wireframe

wireframe: boolean

Generated using TypeDoc