Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/workflows/domain/MachineGraph

Cockpit client (features), next. Source: ui/client/features/workflows/domain/MachineGraph.tsx.

Type Aliases#

StateNode#

StateNode = object

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:33

Properties#

data

data: StateNodeData

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:33

id

id: string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:33

position

position: object

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:33

x

x: number

y

y: number

type

type: "stateNode"

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:33


StateNodeData#

StateNodeData = object

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:20

Properties#

compound

compound: boolean

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:26

final

final: boolean

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:25

initial

initial: boolean

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:24

internal

internal: string[]

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:29

Transitions that don't move anywhere else visible: self-loops and targetless (actions-only) handlers, listed on the node itself.

kind

kind: "state" | "start" | "missing"

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:23

label

label: string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:21

path

path: string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:22

width

width: number

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:30


TransitionEdge#

TransitionEdge = object

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:35

Properties#

data

data: object

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:46

editable

editable: boolean

event

event: string

from

from: string

guard?

optional guard?: string

kind

kind: string

labelX

labelX: number

Where the label sits, centred — the layout reserved this box for it.

labelY

labelY: number

points

points: object[]

Route computed by the layout (start .. end, label point in the middle).

id

id: string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:36

label

label: string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:41

markerEnd

markerEnd: object

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:42

type

type: "arrowclosed"

reconnectable

reconnectable: boolean

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:43

source

source: string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:37

sourceHandle

sourceHandle: string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:39

style?

optional style?: Record<string, string | number>

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:45

target

target: string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:38

targetHandle

targetHandle: string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:40

type

type: "flowEdge"

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:44

Variables#

START_NODE_ID#

const START_NODE_ID: "__start__" = '__start__'

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:12

Functions#

buildMachineFlow()#

buildMachineFlow(machine): object

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:74

Parameters#

machine

WorkflowMachine

Returns#

object

edges

edges: TransitionEdge[]

nodes

nodes: StateNode[]


transitionLabel()#

transitionLabel(t): string

Defined in: ui/client/features/workflows/domain/MachineGraph.tsx:62

Human label for one transition: EVENT [guard], with a kind prefix for the non-on forms (after/always/onDone/invoke).

Parameters#

t
event

string

guard?

string

kind

string

Returns#

string