Skip to main content

AddLabels

megane-viewer

megane-viewer / AddLabels

Class: AddLabels

Defined in: pipeline/builder.ts:297

Generate text labels at atom positions.

Ports: inp.particle — atom data out.label — label data

Extends​

  • PipelineNode

Constructors​

Constructor​

new AddLabels(__namedParameters?): AddLabels

Defined in: pipeline/builder.ts:304

Parameters​

__namedParameters?​
source?​

"element" | "resname" | "index" = "element"

Returns​

AddLabels

Overrides​

PipelineNode.constructor

Properties​

_id​

_id: string | null = null

Defined in: pipeline/builder.ts:83

Inherited from​

PipelineNode._id

_inpPorts​

protected readonly _inpPorts: object

Defined in: pipeline/builder.ts:300

particle​

particle: string = "particle"

Overrides​

PipelineNode._inpPorts

_outPorts​

protected readonly _outPorts: object

Defined in: pipeline/builder.ts:299

label​

label: string = "label"

Overrides​

PipelineNode._outPorts

nodeType​

readonly nodeType: "label_generator" = "label_generator"

Defined in: pipeline/builder.ts:298

Overrides​

PipelineNode.nodeType

source​

source: "element" | "resname" | "index"

Defined in: pipeline/builder.ts:302

Accessors​

inp​

Get Signature​

get inp(): PortAccessor

Defined in: pipeline/builder.ts:91

Input port namespace. Access ports via node.inp.portName

Returns​

PortAccessor

Inherited from​

PipelineNode.inp

out​

Get Signature​

get out(): PortAccessor

Defined in: pipeline/builder.ts:86

Output port namespace. Access ports via node.out.portName

Returns​

PortAccessor

Inherited from​

PipelineNode.out

Methods​

_toSerializedParams()​

_toSerializedParams(): object

Defined in: pipeline/builder.ts:309

Serialize node parameters to the SerializedPipeline v3 node dict.

Returns​

object

source​

source: "element" | "resname" | "index"

type​

type: string

Overrides​

PipelineNode._toSerializedParams