LayeredLayout.Graph

newtype NodeId

Constructors

• NodeId String

Instances

• Newtype NodeId _
• Eq NodeId
• Ord NodeId
• Show NodeId
• Semigroup NodeId
• ReadForeign NodeId
• WriteForeign NodeId

newtype PortId

Constructors

• PortId String

Instances

• Newtype PortId _
• Eq PortId
• Ord PortId
• Show PortId
• ReadForeign PortId
• WriteForeign PortId

newtype EdgeId

Constructors

• EdgeId String

Instances

• Newtype EdgeId _
• Eq EdgeId
• Ord EdgeId
• Show EdgeId
• ReadForeign EdgeId
• WriteForeign EdgeId

data Shape

Constructors

• Rectangle
• Cylinder
• Parallelogram
• Diamond
• Ellipse
• Document
• Cloud

Instances

• Eq Shape
• Ord Shape
• Generic Shape _
• Show Shape
• ReadForeign Shape
• WriteForeign Shape

silhouetteOverflow :: Shape -> Number -> Number -> { bottom :: Number, left :: Number, right :: Number, top :: Number }

How far a shape's drawn silhouette pokes past its bounding rect, per edge, for a node of width w and height h. The Cloud's arcs rise above the top, the Cylinder's bulge and the Document's wave droop below the bottom. Rectangles (and pill/parallelogram/diamond, which stay inside the rect) overflow nowhere. The renderer's path builders and the layout's framing both read these so the painted region always covers the silhouette. Canonical home for the silhouette constants; Render.Draw re-exports them so the path builders stay in lockstep.

cylinderBottomDrop :: Number

The cylinder body extends this many pixels past pos.y + h so its bottom bulge covers the first slice of an incoming edge.

cloudHatRatio :: Number

Cloud arcs reach this fraction of the node height above the bbox top.

documentWaveDrop :: Number

Fraction of node height the document wave dips below the bbox bottom (the wave bottoms out at 1.05·h in Render.Draw.documentPath).

parseShape :: String -> Maybe Shape

Parse a user-facing shape name (case-insensitive) from +node id {shape: cylinder}.

shapeName :: Shape -> String

Inverse of parseShape. Used when serializing a Node back to a Document.

newtype Label

A displayable text label attached to a token, node, or edge. Distinct from node/edge ids so the type system catches accidental swaps with NodeId/EdgeId strings.

Constructors

• Label String

Instances

• Newtype Label _
• Eq Label
• Ord Label
• Show Label
• Semigroup Label
• ReadForeign Label
• WriteForeign Label

data Side

Constructors

• North
• South
• East
• West

Instances

• Eq Side
• Ord Side
• Generic Side _
• Show Side
• ReadForeign Side
• WriteForeign Side

data Axis

Constructors

• Horizontal
• Vertical

Instances

• Eq Axis
• Ord Axis
• Generic Axis _
• Show Axis
• ReadForeign Axis
• WriteForeign Axis

data Alignment

Constructors

• Start
• Center
• End

Instances

• Eq Alignment
• Ord Alignment
• Generic Alignment _
• Show Alignment
• ReadForeign Alignment
• WriteForeign Alignment

data Justify

Constructors

• JustifyStart
• JustifyEnd
• JustifyCenter
• SpaceBetween
• SpaceAround

Instances

• Eq Justify
• Ord Justify
• Generic Justify _
• Show Justify
• ReadForeign Justify
• WriteForeign Justify

data LayerPin

Constructors

• FirstLayer
• LastLayer
• SpecificLayer Int

Instances

• Eq LayerPin
• Ord LayerPin
• Generic LayerPin _
• Show LayerPin
• ReadForeign LayerPin
• WriteForeign LayerPin

data Constraints

Constructors

• AlignGroup { alignment :: Alignment, axis :: Axis, justify :: Justify, nodes :: Array NodeId }
• SameLayer { nodes :: Array NodeId }
• LayerConstraint { node :: NodeId, pin :: LayerPin }
• OrderConstraint { after :: NodeId, before :: NodeId }
• RelativePosition { anchor :: NodeId, offset :: GridPos, target :: NodeId }

Instances

• Eq Constraints
• Generic Constraints _
• ReadForeign Constraints
• WriteForeign Constraints

type Port = { id :: PortId, label :: Maybe String, offset :: Int, side :: Side }

type Node = { id :: NodeId, label :: Maybe String, ports :: Array Port, shape :: Shape, size :: GridSize }

type Endpoint = { node :: NodeId, port :: Maybe PortId }

type Edge = { from :: Endpoint, id :: EdgeId, label :: Maybe Label, to :: Endpoint }

edgeHasArrowhead :: EdgeId -> Boolean

type Graph = { constraints :: Array Constraints, edges :: Array Edge, nodes :: Array Node }

readEnum :: forall a rep. Generic a rep => GenericEnumSumRep rep => Foreign -> F a

writeEnum :: forall a rep. Generic a rep => GenericEnumSumRep rep => a -> Foreign