Hylograph.Data.Tree

data TreeJson_

data TreeLayoutFn_

data D3_TreeNode t0

D3 tree node (result of d3.hierarchy() and layout functions) Parameterized by datum type

data TreeType

Constructors

• TidyTree
• Dendrogram

Instances

• Eq TreeType
• Show TreeType

type TreeModel = { json :: TreeJson_, svgConfig :: { height :: Number, width :: Number }, treeLayout :: TreeLayout, treeLayoutFn :: TreeLayoutFn_, treeType :: TreeType }

makeD3TreeJSONFromTreeID :: forall d. Tree NodeID -> Map NodeID d -> TreeJson_

Convert a Tree of NodeIDs to D3 TreeJson format using a lookup map

This function is useful when you have a Tree structure where nodes contain only IDs, and you need to look up the full node data from a Map.

Example:

let tree = mkTree "root" $ L.fromFoldable [mkTree "child1" Nil, mkTree "child2" Nil]
let dataMap = M.fromFoldable [
  Tuple "root" {name: "Root", value: 100},
  Tuple "child1" {name: "Child 1", value: 50}
]
let d3Tree = makeD3TreeJSONFromTreeID tree dataMap

Note: If a node ID is not found in the map, an empty tree node is created.

treeToD3Tree :: forall d. Tree d -> TreeJson_

Convert a PureScript Tree directly to D3 TreeJson format

This is the simplest conversion - each node already contains its data, no lookup required.

Example:

let tree = mkTree {name: "Root", value: 100} $ L.fromFoldable
             [ mkTree {name: "Child 1", value: 50} Nil
             , mkTree {name: "Child 2", value: 30} Nil
             ]
let d3Tree = treeToD3Tree tree

arrayToTree :: forall d. { getId :: d -> NodeID, getParentId :: d -> Maybe NodeID, nodes :: Array d } -> Either String (Tree d)

Build a Tree from an array of nodes with parent pointers

This function constructs a tree from a flat array where each node knows its parent ID. Useful for loading hierarchical data from databases or JSON where parent-child relationships are encoded as references.

Example:

let nodes = [
  {id: "1", parentId: Nothing, name: "Root"},
  {id: "2", parentId: Just "1", name: "Child 1"},
  {id: "3", parentId: Just "1", name: "Child 2"}
]
let tree = arrayToTree {
  nodes: nodes,
  getId: _.id,
  getParentId: _.parentId
}

Returns Left with error message if:

• No root node found (node with Nothing parent)
• Multiple root nodes found
• Circular references detected

data TreeLayout

Tree layout orientation

Constructors

• Radial
• Horizontal
• Vertical

Instances

• Eq TreeLayout
• Ord TreeLayout
• Show TreeLayout