NGL@1.0.0-beta.7 Home Manual Reference Source Gallery
import LabelRepresentation from 'ngl/src/representation/label-representation.js'
public class | source

LabelRepresentation

Extends:

RepresentationStructureRepresentation → LabelRepresentation

Label representation

Constructor Summary

Public Constructor
public

Create Label representation object

Member Summary

Public Members
public
public
public
public
public
public
public
public
public
public
public
public
public

sdf

public
public
public
public
public
public

Method Summary

Public Methods
public
public

init()

public

Inherited Summary

From class Representation
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public

Counter that keeps track of tasks related to the creation of the representation, including surface calculations.

public
public
public
public
private
private
public

attach()

public

build()

public

clear()

public

create()

public
public
public
public
public

init()

public

make()

public
public

Set the visibility of the representation

public

setVisibility(value: Boolean, noRenderRequest: Boolean): Representation

Set the visibility of the representation

public

update()

public
From class StructureRepresentation
public get
public
public
public
public
public
public
public
public
public
private
private
public

attach()

public

clear()

public

create()

public
public
public
public
public
public
public
public
public

init()

public

Set representation parameters

public

Set representation parameters

public

update()

public

Public Constructors

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

Create Label representation object

Override:

StructureRepresentation#constructor

Params:

NameTypeAttributeDescription
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