Skip to main content

AddCoordination

megane-viewer

megane-viewer / AddCoordination

Class: AddCoordination

Defined in: pipeline/builder.ts:502

Resolve directed center-neighbor coordination relationships. With boundaryMode: "complete", periodic neighbor images just outside Drawing Boundary are included when needed to complete a visible center.

Extends​

  • PipelineNode

Constructors​

Constructor​

new AddCoordination(options?): AddCoordination

Defined in: pipeline/builder.ts:507

Parameters​

options?​
boundaryMode?​

"inside" | "complete"

cutoffTolerance?​

number

excludedCenters?​

number[]

excludedLigands?​

number[]

Returns​

AddCoordination

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:505

particle​

particle: string = "particle"

Overrides​

PipelineNode._inpPorts

_outPorts​

protected readonly _outPorts: object

Defined in: pipeline/builder.ts:504

bond​

bond: string = "bond"

coordination​

coordination: string = "coordination"

Overrides​

PipelineNode._outPorts

nodeType​

readonly nodeType: "coordination_generator" = "coordination_generator"

Defined in: pipeline/builder.ts:503

Overrides​

PipelineNode.nodeType

options​

options: object = {}

Defined in: pipeline/builder.ts:508

boundaryMode?​

optional boundaryMode?: "inside" | "complete"

cutoffTolerance?​

optional cutoffTolerance?: number

excludedCenters?​

optional excludedCenters?: number[]

excludedLigands?​

optional excludedLigands?: number[]

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:518

Serialize node parameters to the SerializedPipeline v3 node dict.

Returns​

object

boundaryMode​

boundaryMode: "inside" | "complete"

cutoffTolerance​

cutoffTolerance: number

excludedCenters​

excludedCenters: number[]

excludedLigands​

excludedLigands: number[]

type​

type: string

Overrides​

PipelineNode._toSerializedParams