Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DistanceRepresentationParameters

Distance representation parameter object.

mixes

RepresentationParameters

mixes

StructureRepresentationParameters

mixes

MeasurementRepresentationParameters

property

{String} labelUnit - distance unit (e.g. "angstrom" or "nm"). If set, a distance symbol is appended to the label (i.e. 'nm' or '\u00C5'). In case of 'nm', the distance value is computed in nanometers instead of Angstroms.

property

{Array[]} atomPair - list of pairs of selection strings (see Selection) or pairs of atom indices. Using atom indices is much more efficient when the representation is updated often, e.g. by changing the selection or the atom positions, as there are no selection strings to be evaluated.

Hierarchy

Indexable

[key: string]: any

Distance representation parameter object.

mixes

RepresentationParameters

mixes

StructureRepresentationParameters

mixes

MeasurementRepresentationParameters

property

{String} labelUnit - distance unit (e.g. "angstrom" or "nm"). If set, a distance symbol is appended to the label (i.e. 'nm' or '\u00C5'). In case of 'nm', the distance value is computed in nanometers instead of Angstroms.

property

{Array[]} atomPair - list of pairs of selection strings (see Selection) or pairs of atom indices. Using atom indices is much more efficient when the representation is updated often, e.g. by changing the selection or the atom positions, as there are no selection strings to be evaluated.

Index

Properties

assembly

assembly: string

atomPair

atomPair: AtomPair

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

labelAttachment

labelAttachment: "bottom-left" | "bottom-center" | "bottom-right" | "middle-left" | "middle-center" | "middle-right" | "top-left" | "top-center" | "top-right"

labelBackground

labelBackground: boolean

labelBackgroundColor

labelBackgroundColor: number

labelBackgroundMargin

labelBackgroundMargin: number

labelBackgroundOpacity

labelBackgroundOpacity: number

labelBorder

labelBorder: boolean

labelBorderColor

labelBorderColor: number

labelBorderWidth

labelBorderWidth: number

labelColor

labelColor: number

labelFixedSize

labelFixedSize: boolean

labelFontFamily

labelFontFamily: "sans-serif" | "monospace" | "serif"

labelFontStyle

labelFontStyle: "normal" | "italic"

labelFontWeight

labelFontWeight: "normal" | "bold"

labelFormat

labelFormat: string

labelGrouping

labelGrouping: "atom" | "residue"

labelSize

labelSize: number

labelText

labelText: string

labelType

labelType: "atomname" | "atomindex" | "occupancy" | "bfactor" | "serial" | "element" | "atom" | "resname" | "resno" | "res" | "text" | "qualified"

labelUnit

labelUnit: string

labelVisible

labelVisible: boolean

labelXOffset

labelXOffset: number

labelYOffset

labelYOffset: number

labelZOffset

labelZOffset: number

labelsdf

labelsdf: boolean

lazy

lazy: boolean

lineOpacity

lineOpacity: number

linewidth

linewidth: number

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

useCylinder

useCylinder: boolean

useInteriorColor

useInteriorColor: boolean

visible

visible: boolean

wireframe

wireframe: boolean

Generated using TypeDoc