Installations

npm install @antv/hierarchy

Developer Guide

BETA

Typescript

No

Module System

CommonJS, UMD

Node Version

20.17.0

NPM Version

10.8.2 Score

99.4

Supply Chain

99.6

Quality

85

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

23

Closed

1

Merged

20

Issues

Open

10

Total

11

Closed

1

Releases

3

0.6.13

Updated on Aug 29, 2024

0.6.9

Updated on Jan 19, 2023

0.6.6

Updated on Aug 24, 2020

View All 3 releases

Languages

1

JavaScript

JavaScript (100%)

Developer

antvis

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

272 Stars

77 Commits

33 Forks

15 Watchers

1 Branches

52 Contributors

Updated on Jul 12, 2025

Maintainers

66

View All 52 Contributors

Package Meta Information

Latest Version

0.6.14

Package Id

@antv/hierarchy@0.6.14

Unpacked Size

1.14 MB

Size

935.94 kB

File Count

67

NPM Version

10.8.2

Node Version

20.17.0

Published on

Sep 20, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

26

@antv/hierarchy

Layout algorithms for visualizing hierarchical data.

API

example

1const Hierarchy = require('@antv/hierarchy');
2
3// your tree data
4const root = {
5  isRoot: true,
6  id: 'Root',
7  children: [
8    {
9      id: 'SubTreeNode1',
10      children: [
11        {
12          id: 'SubTreeNode1.1'
13        },
14        {
15          id: 'SubTreeNode1.2'
16        }
17      ]
18    },
19    {
20      id: 'SubTreeNode2'
21    }
22  ]
23};
24
25// apply layout
26const NODE_SIZE = 16;
27const PEM = 5;
28const ctx = document.getElementById('id-of-canvas-element').getContext('2d');
29const rootNode = Hierarchy.compactBox(root, {
30  direction: 'H', // H / V / LR / RL / TB / BT
31  getId(d) {
32    return d.id;
33  },
34  getHeight(d) {
35    if (d.isRoot) {
36      return NODE_SIZE * 2;
37    }
38    return NODE_SIZE;
39  },
40  getWidth(d) {
41    if (d.isRoot) {
42      return ctx.measureText(d.id).width * 2 + PEM * 1.6;
43    }
44    return ctx.measureText(d.id).width + PEM * 1.6;
45  },
46  getHGap(d) {
47    if (d.isRoot) {
48      return PEM * 2;
49    }
50    return PEM;
51  },
52  getVGap(d) {
53    if (d.isRoot) {
54      return PEM * 2;
55    }
56    return PEM;
57  },
58  getSubTreeSep(d) {
59    if (!d.children || !d.children.length) {
60      return 0;
61    }
62    return PEM;
63  }
64});

layout types

Hierarchy[type]

compactBox

this layout differs from d3-hierarcy.tree, it is a compact box tidy layout that is tidy in both horizontal and vertical directions.

demos

LR	RL	H

TB	BT	V

dendrogram

demos

LR	RL	H

TB	BT	V

indented

demos

LR	RL	H

mindmap

this layout is inspired by XMind.

demos

mindmap

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

4.2

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More