import LabelRepresentation from 'ngl/src/representation/label-representation.js'

public class | source

LabelRepresentation

Extends:

Representation → StructureRepresentation → LabelRepresentation

Label representation

Constructor Summary

Public Constructor
public	constructor(structure: Structure, viewer: Viewer, params: LabelRepresentationParameters) Create Label representation object

Member Summary

Public Members
public	attachment
public	backgroundColor
public	backgroundMargin
public	backgroundOpacity
public	borderColor
public	borderWidth
public	fontFamily
public	fontStyle
public	fontWeight
public	labelText
public	labelType
public	parameters
public	sdf
public	showBackground
public	showBorder
public	type
public	xOffset
public	yOffset
public	zOffset

Method Summary

Public Methods
public	createData()
public	init()
public	updateData()

Inherited Summary

From class Representation
public	[name]
public	clipCenter
public	clipNear
public	clipRadius
public	colorDomain
public	colorMode
public	colorReverse
public	colorScale
public	colorScheme
public	colorValue
public	depthWrite
public	diffuse
public	disableImpostor
public	disablePicking
public	disposed
public	flatShaded
public	lazy
public	lazyProps
public	matrix
public	metalness
public	opacity
public	openEnded
public	parameters
public	quality
public	radialSegments
public	roughness
public	side
public	sphereDetail
public	tasks: Counter Counter that keeps track of tasks related to the creation of the representation, including surface calculations.
public	type
public	viewer: Viewer
public	visible
public	wireframe
private	bufferList: Array
private	queue: Queue
public	attach()
public	build()
public	clear()
public	create()
public	dispose()
public	getBufferParams()
public	getColorParams()
public	getParameters()
public	init()
public	make()
public	setColor()
public	setParameters(params: RepresentationParameters, what: Object, rebuild: Boolean): Representation Set the visibility of the representation
public	setVisibility(value: Boolean, noRenderRequest: Boolean): Representation Set the visibility of the representation
public	update()
public	updateParameters()

From class StructureRepresentation
public get	defaultScale
public	assembly
public	defaultAssembly
public	needsBuild
public	parameters
public	radius
public	scale
public	structure: Structure
public	structureView: StructureView
public	type
private	dataList: Array
private	selection: Selection
public	attach()
public	clear()
public	create()
public	createData()
public	dispose()
public	getAssembly()
public	getAtomParams()
public	getBondParams()
public	getColorParams()
public	getParameters()
public	getQuality()
public	init()
public	setParameters(params: StructureRepresentationParameters, what: Object, rebuild: Boolean): StructureRepresentation Set representation parameters
public	setSelection(string: String, silent: Boolean): StructureRepresentation Set representation parameters
public	update()
public	updateData()

Public Constructors

public constructor(structure: Structure, viewer: Viewer, params: LabelRepresentationParameters) source

Create Label representation object

Override:

StructureRepresentation#constructor

Params:

Name	Type	Attribute	Description
structure	Structure		the structure to be represented
viewer	Viewer		a viewer object
params	LabelRepresentationParameters		label representation parameters

Public Members

public attachment source

public backgroundColor source

public backgroundMargin source

public backgroundOpacity source

public borderColor source

public borderWidth source

public fontFamily source

public fontStyle source

public fontWeight source

public labelText source

public labelType source

public parameters source

Override:

StructureRepresentation#parameters

public sdf source

public showBackground source

public showBorder source

public type source

Override:

StructureRepresentation#type

public xOffset source

public yOffset source

public zOffset source

Public Methods

public createData() source

Override:

StructureRepresentation#createData

public init() source

Override:

StructureRepresentation#init

public updateData() source

Override:

StructureRepresentation#updateData