Skip to main content

PipelineStore

megane-viewer

megane-viewer / PipelineStore

Interface: PipelineStore

Defined in: pipeline/store.ts:38

Properties​

activateEmbeddedVectorChannel​

activateEmbeddedVectorChannel: (name) => void

Defined in: pipeline/store.ts:82

Parameters​

name​

string | null

Returns​

void

activeEmbeddedVectorChannel​

activeEmbeddedVectorChannel: string | null

Defined in: pipeline/store.ts:65

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

addNode​

addNode: (type, position?) => string

Defined in: pipeline/store.ts:96

Parameters​

type​

PipelineNodeType

position?​
x​

number

y​

number

Returns​

string

applyTemplate​

applyTemplate: (templateId) => void

Defined in: pipeline/store.ts:130

Parameters​

templateId​

string

Returns​

void

atomLabels​

atomLabels: string[] | null

Defined in: pipeline/store.ts:47

autoLayout​

autoLayout: () => void

Defined in: pipeline/store.ts:134

Returns​

void

clearNodeParseError​

clearNodeParseError: (nodeId) => void

Defined in: pipeline/store.ts:86

Parameters​

nodeId​

string

Returns​

void

clearPendingTemplate​

clearPendingTemplate: () => void

Defined in: pipeline/store.ts:131

Returns​

void

deserialize​

deserialize: (json) => void

Defined in: pipeline/store.ts:110

Parameters​

json​

SerializedPipeline

Returns​

void

edges​

edges: Edge[]

Defined in: pipeline/store.ts:41

embeddedVectorChannels​

embeddedVectorChannels: object[] | null

Defined in: pipeline/store.ts:63

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

Returns​

void

fileFrames​

fileFrames: Frame[] | null

Defined in: pipeline/store.ts:52

fileMeta​

fileMeta: TrajectoryMeta | null

Defined in: pipeline/store.ts:53

fileProvider​

fileProvider: FrameProvider | null

Defined in: pipeline/store.ts:55

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

fileVectors​

fileVectors: VectorFrame[] | null

Defined in: pipeline/store.ts:56

loadPipeline​

loadPipeline: (json, nodeSnapshots) => void

Defined in: pipeline/store.ts:120

Parameters​

json​

SerializedPipeline

nodeSnapshots​

Record<string, NodeSnapshotData>

Returns​

void

nodeErrors​

nodeErrors: Record<string, NodeError[]>

Defined in: pipeline/store.ts:43

nodeParseErrors​

nodeParseErrors: Record<string, string>

Defined in: pipeline/store.ts:69

nodes​

nodes: Node<PipelineNodeData>[]

Defined in: pipeline/store.ts:40

nodeSnapshots​

nodeSnapshots: Record<string, NodeSnapshotData>

Defined in: pipeline/store.ts:68

nodeStreamingData​

nodeStreamingData: Record<string, NodeStreamingData>

Defined in: pipeline/store.ts:72

onConnect​

onConnect: (connection) => void

Defined in: pipeline/store.ts:93

Parameters​

connection​

Connection

Returns​

void

onEdgesChange​

onEdgesChange: OnEdgesChange

Defined in: pipeline/store.ts:92

onNodesChange​

onNodesChange: OnNodesChange<Node<PipelineNodeData>>

Defined in: pipeline/store.ts:91

openFile​

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

Defined in: pipeline/store.ts:106

Parameters​

file​

File

opts?​

OpenFileOptions

Returns​

Promise<void>

pendingTemplateId​

pendingTemplateId: string | null

Defined in: pipeline/store.ts:129

removeNode​

removeNode: (id) => void

Defined in: pipeline/store.ts:97

Parameters​

id​

string

Returns​

void

removeNodeSnapshot​

removeNodeSnapshot: (nodeId) => void

Defined in: pipeline/store.ts:84

Parameters​

nodeId​

string

Returns​

void

removeNodeStreamingData​

removeNodeStreamingData: (nodeId) => void

Defined in: pipeline/store.ts:88

Parameters​

nodeId​

string

Returns​

void

reset​

reset: () => void

Defined in: pipeline/store.ts:137

Returns​

void

serialize​

serialize: () => SerializedPipeline

Defined in: pipeline/store.ts:109

Returns​

SerializedPipeline

setAtomLabels​

setAtomLabels: (labels) => void

Defined in: pipeline/store.ts:75

Parameters​

labels​

string[] | null

Returns​

void

setEmbeddedVectorChannels​

setEmbeddedVectorChannels: (channels) => void

Defined in: pipeline/store.ts:81

Parameters​

channels​

object[] | null

Returns​

void

setFileFrames​

setFileFrames: (frames, meta) => void

Defined in: pipeline/store.ts:78

Parameters​

frames​

Frame[] | null

meta​

TrajectoryMeta | null

Returns​

void

setFileProvider​

setFileProvider: (provider) => void

Defined in: pipeline/store.ts:79

Parameters​

provider​

FrameProvider | null

Returns​

void

setFileVectors​

setFileVectors: (vectors) => void

Defined in: pipeline/store.ts:80

Parameters​

vectors​

VectorFrame[] | null

Returns​

void

setInspectorLayers​

setInspectorLayers: (layers) => void

Defined in: pipeline/store.ts:126

Parameters​

layers​

InspectorLayer[]

Returns​

void

setNodeParseError​

setNodeParseError: (nodeId, message) => void

Defined in: pipeline/store.ts:85

Parameters​

nodeId​

string

message​

string

Returns​

void

setNodeSnapshot​

setNodeSnapshot: (nodeId, data) => void

Defined in: pipeline/store.ts:83

Parameters​

nodeId​

string

data​

NodeSnapshotData

Returns​

void

setNodeStreamingData​

setNodeStreamingData: (nodeId, data) => void

Defined in: pipeline/store.ts:87

Parameters​

nodeId​

string

data​

NodeStreamingData

Returns​

void

setSnapshot​

setSnapshot: (s) => void

Defined in: pipeline/store.ts:74

Parameters​

s​

Snapshot | null

Returns​

void

setStructureFrames​

setStructureFrames: (frames, meta) => void

Defined in: pipeline/store.ts:76

Parameters​

frames​

Frame[] | null

meta​

TrajectoryMeta | null

Returns​

void

setStructureProvider​

setStructureProvider: (provider) => void

Defined in: pipeline/store.ts:77

Parameters​

provider​

FrameProvider | null

Returns​

void

snapshot​

snapshot: Snapshot | null

Defined in: pipeline/store.ts:46

structureFrames​

structureFrames: Frame[] | null

Defined in: pipeline/store.ts:48

structureMeta​

structureMeta: TrajectoryMeta | null

Defined in: pipeline/store.ts:49

structureProvider​

structureProvider: FrameProvider | null

Defined in: pipeline/store.ts:51

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

toggleNode​

toggleNode: (id) => void

Defined in: pipeline/store.ts:99

Parameters​

id​

string

Returns​

void

updateNodeParams​

updateNodeParams: (id, params) => void

Defined in: pipeline/store.ts:98

Parameters​

id​

string

params​

Record<string, unknown>

Returns​

void

viewportState​

viewportState: ViewportState

Defined in: pipeline/store.ts:42