Skip to content

Commit

Permalink
Make links visible in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gampleman committed Aug 14, 2023
1 parent d6c4053 commit e84204e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs.json

Large diffs are not rendered by default.

16 changes: 9 additions & 7 deletions src/Hierarchy.elm
Original file line number Diff line number Diff line change
Expand Up @@ -116,13 +116,15 @@ size =
Size


{-| [![Layered behavior](https://elm-visualization.netlify.com/LayeredTree/preview.png)](https://elm-visualization.netlify.com/LayeredTree/)
{-| [![Layered behavior](https://deploy-preview-142--elm-visualization.netlify.app/LayeredTree/preview@2x.png)](https://deploy-preview-142--elm-visualization.netlify.app/LayeredTree/)
Passing this option causes each "layer" (i.e. nodes in the tree that have the same number of ancestor nodes)
to be layed out with the same y value. This makes the layers much more emphasized (if you are for instance
visualizing the organization of an army unit, then this might neatly show the rank of each member) at the cost
of needing more space.
This only makes a difference if `nodeSize` returns different heights for different children.
-}
layered : Attribute a { b | layered : Supported }
layered =
Expand Down Expand Up @@ -227,9 +229,9 @@ none =
Batch []


{-| [![Tidy Tree](https://elm-visualization.netlify.com/TidyTree/preview@2.png)](https://elm-visualization.netlify.com/TidyTree/)
{-| Produces a tidy node-link diagram of a tree, based on a linear time algorithm by [van der Ploeg](https://citeseerx.ist.psu.edu/document?repid=rep1&type=pdf&doi=d45f66231e053590c64c9d901fb7b028dbc5c923).
Produces a tidy node-link diagram of a tree, based on a linear time algorithm by [van der Ploeg](https://citeseerx.ist.psu.edu/document?repid=rep1&type=pdf&doi=d45f66231e053590c64c9d901fb7b028dbc5c923).
[![Tidy Tree](https://deploy-preview-142--elm-visualization.netlify.app/TidyTree/preview@2x.png)](https://deploy-preview-142--elm-visualization.netlify.app/TidyTree/)
-}
tidy :
Expand Down Expand Up @@ -335,9 +337,9 @@ tidy attrs t =
layout


{-| [![Treemap](https://elm-visualization.netlify.com/Treemap/preview@2.png)](https://elm-visualization.netlify.com/Treemap/)
{-| A treemap recursively subdivides area into rectangles according to each node’s associated value. This implementation supports an extensible tiling method.
A treemap recursively subdivides area into rectangles according to each node’s associated value. This implementation supports an extensible tiling method.
[![Treemap](https://deploy-preview-142--elm-visualization.netlify.app/Treemap/preview@2x.png)](https://deploy-preview-142--elm-visualization.netlify.app/Treemap/)
-}
treemap :
Expand Down Expand Up @@ -474,9 +476,9 @@ squarifyRatio =
Hierarchy.Treemap.squarifyRatio


{-| [![Treemap](https://elm-visualization.netlify.com/Sunburst/preview@2.png)](https://elm-visualization.netlify.com/Sunburst/)
{-| The partition layout produces adjacency diagrams: a space-filling variant of a node-link tree diagram. Rather than drawing a link between parent and child in the hierarchy, nodes are drawn as solid areas (either arcs or rectangles), and their placement relative to other nodes reveals their position in the hierarchy. The size of the nodes encodes a quantitative dimension that would be difficult to show in a node-link diagram.
The partition layout produces adjacency diagrams: a space-filling variant of a node-link tree diagram. Rather than drawing a link between parent and child in the hierarchy, nodes are drawn as solid areas (either arcs or rectangles), and their placement relative to other nodes reveals their position in the hierarchy. The size of the nodes encodes a quantitative dimension that would be difficult to show in a node-link diagram.
[![Sunburst diagram](https://deploy-preview-142--elm-visualization.netlify.app/Sunburst/preview@2x.png)](https://deploy-preview-142--elm-visualization.netlify.app/Sunburst/)
-}
partition :
Expand Down

0 comments on commit e84204e

Please sign in to comment.