Skip to main content

PipelineStore

megane-viewer


megane-viewer / PipelineStore

Interface: PipelineStore

Defined in: pipeline/store.ts:43

Properties​

activateEmbeddedVectorChannel​

activateEmbeddedVectorChannel: (name) => void

Defined in: pipeline/store.ts:87

Parameters​

name​

string | null

Returns​

void


activeEmbeddedVectorChannel​

activeEmbeddedVectorChannel: string | null

Defined in: pipeline/store.ts:70

Name of the embedded channel currently feeding fileVectors, if any.


addNode​

addNode: (type, position?) => string

Defined in: pipeline/store.ts:108

Parameters​

type​

PipelineNodeType

position?​
x​

number

y​

number

Returns​

string


applyGeneratedPipeline​

applyGeneratedPipeline: (json, opts?) => number | null

Defined in: pipeline/store.ts:144

Parameters​

json​

SerializedPipeline

opts?​
checkpoint?​

boolean

Returns​

number | null


applyTemplate​

applyTemplate: (templateId) => void

Defined in: pipeline/store.ts:188

Parameters​

templateId​

string

Returns​

void


atomLabels​

atomLabels: string[] | null

Defined in: pipeline/store.ts:52


autoLayout​

autoLayout: () => void

Defined in: pipeline/store.ts:192

Returns​

void


clearEditOps​

clearEditOps: () => void

Defined in: pipeline/store.ts:176

Drop every op.

Returns​

void


clearNodeParseError​

clearNodeParseError: (nodeId) => void

Defined in: pipeline/store.ts:91

Parameters​

nodeId​

string

Returns​

void


clearPendingTemplate​

clearPendingTemplate: () => void

Defined in: pipeline/store.ts:189

Returns​

void


deserialize​

deserialize: (json) => void

Defined in: pipeline/store.ts:127

Parameters​

json​

SerializedPipeline

Returns​

void


edges​

edges: Edge[]

Defined in: pipeline/store.ts:46


editRevision​

editRevision: number

Defined in: pipeline/store.ts:184

Bumped whenever a loader's edit list changes (ops pushed / undone / cleared, or the list edited directly) and when the original-structure preview is toggled. The viewer keeps the camera where it is on such re-executions: an edit reshapes the snapshot arrays, which would otherwise read as a new structure and re-fit the view.


embeddedVectorChannels​

embeddedVectorChannels: object[] | null

Defined in: pipeline/store.ts:68

Vector channels embedded in the loaded structure/trajectory file (GRO velocities, LAMMPS dump vx/vy/vz, ...). These are OFFERED to the user — nothing renders until a load_vector node activates one; a parse must not switch a visual overlay on as a side effect.


execute​

execute: () => void

Defined in: pipeline/store.ts:119

Returns​

void


fileFrames​

fileFrames: Frame[] | null

Defined in: pipeline/store.ts:57


fileMeta​

fileMeta: TrajectoryMeta | null

Defined in: pipeline/store.ts:58


fileProvider​

fileProvider: FrameProvider | null

Defined in: pipeline/store.ts:60

Pre-built lazy/streaming provider for the file trajectory (mutually exclusive with fileFrames).


fileVectors​

fileVectors: VectorFrame[] | null

Defined in: pipeline/store.ts:61


generatedUndoStack​

generatedUndoStack: GraphCheckpoint[]

Defined in: pipeline/store.ts:155

Graphs replaced by applyGeneratedPipeline, newest last. Emptied whenever new data is loaded or the whole pipeline is replaced, because a checkpoint holds the per-node data of the files that were loaded when it was taken.


layoutPending​

layoutPending: boolean

Defined in: pipeline/store.ts:198

True while the graph was laid out with estimated node sizes (a template, the initial graph, a chat-generated pipeline). The editor re-runs autoLayout once xyflow has measured every node, which clears it.


loadPipeline​

loadPipeline: (json, nodeSnapshots) => void

Defined in: pipeline/store.ts:137

Parameters​

json​

SerializedPipeline

nodeSnapshots​

Record<string, NodeSnapshotData>

Returns​

void


nodeErrors​

nodeErrors: Record<string, NodeError[]>

Defined in: pipeline/store.ts:48


nodeParseErrors​

nodeParseErrors: Record<string, string>

Defined in: pipeline/store.ts:74


nodes​

nodes: Node<PipelineNodeData>[]

Defined in: pipeline/store.ts:45


nodeSnapshots​

nodeSnapshots: Record<string, NodeSnapshotData>

Defined in: pipeline/store.ts:73


nodeStreamingData​

nodeStreamingData: Record<string, NodeStreamingData>

Defined in: pipeline/store.ts:77


onConnect​

onConnect: (connection) => void

Defined in: pipeline/store.ts:98

Parameters​

connection​

Connection

Returns​

void


onEdgesChange​

onEdgesChange: OnEdgesChange

Defined in: pipeline/store.ts:97


onNodesChange​

onNodesChange: OnNodesChange<Node<PipelineNodeData>>

Defined in: pipeline/store.ts:96


openFile​

openFile: (file, opts?) => Promise<void>

Defined in: pipeline/store.ts:123

Parameters​

file​

File

opts?​

OpenFileOptions

Returns​

Promise<void>


pendingTemplateId​

pendingTemplateId: string | null

Defined in: pipeline/store.ts:187


pushEditOp​

pushEditOp: (op) => string

Defined in: pipeline/store.ts:170

Append an op to the primary loader's edits. Returns the loader id ("" without one).

Parameters​

op​

EditOp

Returns​

string


reconnectEdge​

reconnectEdge: (oldEdge, connection) => void

Defined in: pipeline/store.ts:105

Move an existing edge's endpoint to connection. Invalid targets (per canConnect) leave the edge untouched.

Parameters​

oldEdge​

Edge

connection​

Connection

Returns​

void


removeEdge​

removeEdge: (id) => void

Defined in: pipeline/store.ts:100

Delete one edge (the editor's edge × button / drag-off disconnect).

Parameters​

id​

string

Returns​

void


removeNode​

removeNode: (id) => void

Defined in: pipeline/store.ts:109

Parameters​

id​

string

Returns​

void


removeNodeSnapshot​

removeNodeSnapshot: (nodeId) => void

Defined in: pipeline/store.ts:89

Parameters​

nodeId​

string

Returns​

void


removeNodeStreamingData​

removeNodeStreamingData: (nodeId) => void

Defined in: pipeline/store.ts:93

Parameters​

nodeId​

string

Returns​

void


replaceLastEditOp​

replaceLastEditOp: (op) => void

Defined in: pipeline/store.ts:172

Replace the most recent op (used while a drag is in progress).

Parameters​

op​

EditOp

Returns​

void


reset​

reset: () => void

Defined in: pipeline/store.ts:201

Returns​

void


selectNode​

selectNode: (id) => void

Defined in: pipeline/store.ts:116

Make id the only selected node (null clears the selection). The editor's properties pane edits the selected node.

Parameters​

id​

string | null

Returns​

void


serialize​

serialize: () => SerializedPipeline

Defined in: pipeline/store.ts:126

Returns​

SerializedPipeline


setAtomLabels​

setAtomLabels: (labels) => void

Defined in: pipeline/store.ts:80

Parameters​

labels​

string[] | null

Returns​

void


setEmbeddedVectorChannels​

setEmbeddedVectorChannels: (channels) => void

Defined in: pipeline/store.ts:86

Parameters​

channels​

object[] | null

Returns​

void


setFileFrames​

setFileFrames: (frames, meta) => void

Defined in: pipeline/store.ts:83

Parameters​

frames​

Frame[] | null

meta​

TrajectoryMeta | null

Returns​

void


setFileProvider​

setFileProvider: (provider) => void

Defined in: pipeline/store.ts:84

Parameters​

provider​

FrameProvider | null

Returns​

void


setFileVectors​

setFileVectors: (vectors) => void

Defined in: pipeline/store.ts:85

Parameters​

vectors​

VectorFrame[] | null

Returns​

void


setInspectorLayers​

setInspectorLayers: (layers) => void

Defined in: pipeline/store.ts:161

Parameters​

layers​

InspectorLayer[]

Returns​

void


setNodeParseError​

setNodeParseError: (nodeId, message) => void

Defined in: pipeline/store.ts:90

Parameters​

nodeId​

string

message​

string

Returns​

void


setNodeSnapshot​

setNodeSnapshot: (nodeId, data) => void

Defined in: pipeline/store.ts:88

Parameters​

nodeId​

string

data​

NodeSnapshotData

Returns​

void


setNodeStreamingData​

setNodeStreamingData: (nodeId, data) => void

Defined in: pipeline/store.ts:92

Parameters​

nodeId​

string

data​

NodeStreamingData

Returns​

void


setQuickStyle​

setQuickStyle: (patch) => void

Defined in: pipeline/store.ts:163

Apply Quick Style controls to the graph (see quickStyle.ts).

Parameters​

patch​

Partial<QuickStyle>

Returns​

void


setSnapshot​

setSnapshot: (s) => void

Defined in: pipeline/store.ts:79

Parameters​

s​

Snapshot | null

Returns​

void


setStructureFrames​

setStructureFrames: (frames, meta) => void

Defined in: pipeline/store.ts:81

Parameters​

frames​

Frame[] | null

meta​

TrajectoryMeta | null

Returns​

void


setStructureProvider​

setStructureProvider: (provider) => void

Defined in: pipeline/store.ts:82

Parameters​

provider​

FrameProvider | null

Returns​

void


snapshot​

snapshot: Snapshot | null

Defined in: pipeline/store.ts:51


structureFrames​

structureFrames: Frame[] | null

Defined in: pipeline/store.ts:53


structureMeta​

structureMeta: TrajectoryMeta | null

Defined in: pipeline/store.ts:54


structureProvider​

structureProvider: FrameProvider | null

Defined in: pipeline/store.ts:56

Pre-built lazy/streaming provider for a multi-frame structure file (mutually exclusive with structureFrames).


toggleNode​

toggleNode: (id) => void

Defined in: pipeline/store.ts:111

Parameters​

id​

string

Returns​

void


undoEditOp​

undoEditOp: () => EditOp | null

Defined in: pipeline/store.ts:174

Remove and return the most recent op, or null when there is none.

Returns​

EditOp | null


undoGeneratedPipeline​

undoGeneratedPipeline: () => boolean

Defined in: pipeline/store.ts:149

Restore the graph from before the latest generated apply. False when there is none.

Returns​

boolean


updateNodeParams​

updateNodeParams: (id, params) => void

Defined in: pipeline/store.ts:110

Parameters​

id​

string

params​

Record<string, unknown>

Returns​

void


viewportState​

viewportState: ViewportState

Defined in: pipeline/store.ts:47