Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LabelRepresentationParameters

Label representation parameter object. Extends RepresentationParameters and StructureRepresentationParameters.

property

{Integer} clipNear - position of camera near/front clipping plane in percent of scene bounding box

property

{Float} opacity - translucency: 1 is fully opaque, 0 is fully transparent

property

{String} labelType - type of the label, one of: "atomname", "atomindex", "occupancy", "bfactor", "serial", "element", "atom", "resname", "resno", "res", "text", "qualified". When set to "text", the labelText list is used.

property

{String[]} labelText - list of label strings, must set labelType to "text" to take effect

property

{String[]} labelFormat - sprintf-js format string, any attribute of AtomProxy can be used

property

{String} labelGrouping - grouping of the label, one of: "atom", "residue".

property

{String} fontFamily - font family, one of: "sans-serif", "monospace", "serif"

property

{String} fontStyle - font style, "normal" or "italic"

property

{String} fontWeight - font weight, "normal" or "bold"

property

{Float} xOffset - offset in x-direction

property

{Float} yOffset - offset in y-direction

property

{Float} zOffset - offset in z-direction (i.e. in camera direction)

property

{String} attachment - attachment of the label, one of: "bottom-left", "bottom-center", "bottom-right", "middle-left", "middle-center", "middle-right", "top-left", "top-center", "top-right"

property

{Boolean} showBorder - show border/outline

property

{Color} borderColor - color of the border/outline

property

{Float} borderWidth - width of the border/outline

property

{Boolean} showBackground - show background rectangle

property

{Color} backgroundColor - color of the background

property

{Float} backgroundMargin - width of the background

property

{Float} backgroundOpacity - opacity of the background

property

{Boolean} fixedSize - show text with a fixed pixel size

Hierarchy

Indexable

[key: string]: any

Label representation parameter object. Extends RepresentationParameters and StructureRepresentationParameters.

property

{Integer} clipNear - position of camera near/front clipping plane in percent of scene bounding box

property

{Float} opacity - translucency: 1 is fully opaque, 0 is fully transparent

property

{String} labelType - type of the label, one of: "atomname", "atomindex", "occupancy", "bfactor", "serial", "element", "atom", "resname", "resno", "res", "text", "qualified". When set to "text", the labelText list is used.

property

{String[]} labelText - list of label strings, must set labelType to "text" to take effect

property

{String[]} labelFormat - sprintf-js format string, any attribute of AtomProxy can be used

property

{String} labelGrouping - grouping of the label, one of: "atom", "residue".

property

{String} fontFamily - font family, one of: "sans-serif", "monospace", "serif"

property

{String} fontStyle - font style, "normal" or "italic"

property

{String} fontWeight - font weight, "normal" or "bold"

property

{Float} xOffset - offset in x-direction

property

{Float} yOffset - offset in y-direction

property

{Float} zOffset - offset in z-direction (i.e. in camera direction)

property

{String} attachment - attachment of the label, one of: "bottom-left", "bottom-center", "bottom-right", "middle-left", "middle-center", "middle-right", "top-left", "top-center", "top-right"

property

{Boolean} showBorder - show border/outline

property

{Color} borderColor - color of the border/outline

property

{Float} borderWidth - width of the border/outline

property

{Boolean} showBackground - show background rectangle

property

{Color} backgroundColor - color of the background

property

{Float} backgroundMargin - width of the background

property

{Float} backgroundOpacity - opacity of the background

property

{Boolean} fixedSize - show text with a fixed pixel size

Index

Properties

attachment

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

backgroundColor

backgroundColor: number

backgroundMargin

backgroundMargin: number

backgroundOpacity

backgroundOpacity: number

borderColor

borderColor: number

borderWidth

borderWidth: number

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

fixedSize

fixedSize: boolean

flatShaded

flatShaded: boolean

fontFamily

fontFamily: "sans-serif" | "monospace" | "serif"

fontStyle

fontStyle: "normal" | "italic"

fontWeight

fontWeight: "normal" | "bold"

interiorColor

interiorColor: Color

interiorDarkening

interiorDarkening: number

labelFormat

labelFormat: string

labelGrouping

labelGrouping: "atom" | "residue"

labelText

labelText: string

labelType

labelType: LabelType

lazy

lazy: boolean

matrix

matrix: Matrix4

metalness

metalness: number

name

name: string

opacity

opacity: number

openEnded

openEnded: boolean

quality

quality: string

radialSegments

radialSegments: number

roughness

roughness: number

showBackground

showBackground: boolean

showBorder

showBorder: boolean

side

sphereDetail

sphereDetail: number

useInteriorColor

useInteriorColor: boolean

visible

visible: boolean

wireframe

wireframe: boolean

xOffset

xOffset: number

yOffset

yOffset: number

zOffset

zOffset: number

Generated using TypeDoc