Vue.js Version

Native JavaScript(ES6) Version

Web Components Version

Foreword

• First of all, thanks a lot for wesnolte's great work😊 -- jOrgChart. The thought that using nested tables to build out the tree-like orgonization chart is amazing. This idea is more simple and direct than its counterparts based on svg
• Unfortunately, it's long time not to see the update of jOrgChart. on the other hand, I got some interesting ideas to add, so I choose to create a new repo.
• Font Awesome provides us with administration icon, second level menu icon and loading spinner.

Features

• Supports both local data and remote data (JSON).
• Smooth expand/collapse effects based on CSS3 transitions.
• Align the chart in 4 orientations.
• Allows user to change orgchart structure by drag/drop nodes.
• Allows user to edit orgchart dynamically and save the final hierarchy as a JSON object.
• Supports exporting chart as a picture or pdf document.
• Supports pan and zoom
• Users can adopt multiple solutions to build up a huge organization chart(please refer to multiple-layers or hybrid layout sections)
• touch-enabled plugin for mobile divice

CDN

Users could find the related CDN support for OrgChart's CSS and JavaScript.

https://cdnjs.com/libraries/orgchart

Installation

Of course, you can directly use the standalone build by including dist/js/jquery.orgchart.js and dist/css/jquery.orgchart.css in your webapps.

Install with Bower

# From version 1.0.2 on, users can install orgchart and add it to bower.json dependencies $ bower install orgchart 

Install with npm

# From version 1.0.4 on, users can install orgchart with npm $ npm install orgchart 

require('orgchart') will load orgchart plugin onto the jQuery object. The orgchart module itself does not export anything.

Demos on github      Demos on codepen.io

online demos

• using ul datasource(this feature comes from Tobyee's good idea😊)

• using local datasource

• I wanna pan&zoom the orgchart

• I wanna align orgchart with different orientation**(this feature comes from the good idea of fvlima and badulesia 😊)

  Top to Bottom -- default direction, as you can see all other examples on this page.

  Bottom to Top

  Left to Right

  Right to Left

• I wanna show/hide left/right sibling nodes respectively by clicking left/right arrow

• I wanna load datasource through ajax

• I wanna load data on-demand

Note: when users use ajaxURL option to build orghchart, they must use json datasource(both local and remote are OK) and set the relationship property of datasource by themselves. All of these staff are used to generate the correct expanding/collapsing arrows for nodes.

• I wanna customize the structure of node

• I wanna export the organization chart as a picture

Here, we need the help from html2canvas.

Note:

(1) if you wanna export something in IE or Edge, please introduce es6-promise.auto.js firstly.

(2) if your OS is windows, please check your display scaling settings. For the perfact exported picture, you'd better adjust "Change the size of text, apps, and other items" to 100%.(thanks for sayamkrai's exploration)

(3) Besides, if you wanna export a pdf format or your orgchart includes picture, you have to introduce jspdf and set "exportFileextension" option to "pdf".

• I wanna itegrate organization chart with geographic information

Here, we fall back on OpenLayers. It's the most aewsome open-source js library for Web GIS you sholdn't miss.

• I wanna edit orgchart

With the help of exposed core methods(addParent(), addSiblings(), addChildren(), removeNodes()) of orgchart plugin, we can finish this task easily.

• I wanna drag & drop the nodes of orgchart

Users are allowed to drag & drop the nodes of orgchart when option "draggable" is assigned to true(Note: this feature doesn't work on IE due to its poor support for HTML5 drag & drop API).

Furthermore, users can make use of option dropCriteria to inject their custom limitations on drag & drop. As shown below, we don't want an manager employee to be under a engineer under no circumstance.

• I want a method that can decribe the hierarchy of orgchart

That's where getHierarchy() comes in.

• I want a color-coded chart

It's a so easy task, we just need to append id or className property to node data.

• I want a multiple-layers chart

In fact, this is a wonderful solution to display a orgchart which includes a huge number of node data.

• I want a hybrid(horizontal + vertical) chart

This feature is inspired by the issues(Aligning Children Vertical, Hybrid(horizontal + vertical) OrgChart). Thank mfahadi and Destructrix for their constructive suggestions😊 Special thanks to tedliang for his wonderful hybrid mode solution.

From now on, users never have to worry about how to align a huge of nodes in one screen of browser. The option "verticalLevel" allows users to align child nodes vertically from the given level.

Note: currently, this option is incompatible with many other options or methods, like direction, drag&drop, addChildren(), removeNodes(), getHierarchy() and so on. These conflicts will be solved one by one in the later versions.

• I want to collapse some nodes by default

No problem. You just need to adjust a little detail of datasource with the help of option "collapse" and className "slide-up".

• I want to refresh orgchart base on new options or datasource

It's not a big deal. You just turn to the method init().

• I want to use complex template to customize the internal structure of every node

No problem. With the help of ES6 Template literals, we can customize the any complex node structure rather than the common title and content sections.

how to start up demos locally

• you have to install node.js v6+ because our unit tests are based on jsdom v11
• you have to install modern browsers because many behaviors of orgchart plugin are based on HTML5 and CSS3
• run npm install to install necessary dependencies
• run npm test to run all tests including unit tests, integration tests and e2e tests
• run npm run build to generate production js&css files of plugin
• run npm start to start up local web server to host all the demos

Usage

Instantiation Statement

var oc = $('#chartContainerId').orgchart(options);

Structure of Datasource

{   'id': 'rootNode', // It's a optional property which will be used as id attribute of node   // and data-parent attribute, which contains the id of the parent node   'collapsed': true, // By default, the children nodes of current node is hidden.   'className': 'top-level', // It's a optional property which will be used as className attribute of node.   'nodeTitlePro': 'Lao Lao',   'nodeContentPro': 'general manager',   'relationship': relationshipValue, // Note: when you activate ondemand loading nodes feature,   // you should use json datsource (local or remote) and set this property.   // This property implies that whether this node has parent node, siblings nodes or children nodes.   // relationshipValue is a string composed of three "0/1" identifier.   // First character stands for wether current node has parent node;   // Scond character stands for wether current node has siblings nodes;   // Third character stands for wether current node has children node.   'children': [ // The property stands for nested nodes.     { 'nodeTitlePro': 'Bo Miao', 'nodeContentPro': 'department manager', 'relationship': '110' },     { 'nodeTitlePro': 'Su Miao', 'nodeContentPro': 'department manager', 'relationship': '111',       'children': [         { 'nodeTitlePro': 'Tie Hua', 'nodeContentPro': 'senior engineer', 'relationship': '110' },         { 'nodeTitlePro': 'Hei Hei', 'nodeContentPro': 'senior engineer', 'relationship': '110' }       ]     },     { 'nodeTitlePro': 'Yu Jie', 'nodeContentPro': 'department manager', 'relationship': '110' }   ],   'otherPro': anyValue };

Options

Methods

I'm sure that you can grasp the key points of the methods below after you try out demo -- edit orgchart.

var oc = $container.orgchart(options)

Embeds an organization chart in designated container. Accepts an options object and you can go through the "options" section to find which options are required. Variable oc is the instance of class OrgChart.

init(newOptions)

It's the useful way when users want to re-initialize or refresh orgchart based on new options or reload new data.

addParent(data)

Adds parent node(actullay it's always root node) for current orgchart.

addSiblings($node, data)

Adds sibling nodes for designated node.

addChildren($node, data)

Adds child nodes for designed node.

removeNodes($node）

Removes the designated node and its descedant nodes.

getHierarchy()

This method is designed to get the hierarchy relationships of orgchart for further processing. For example, after editing the orgchart, you could send the returned value of this method to server-side and save the new state of orghcart.

hideParent($node)

This method allows you to hide programatically the parent node of any specific node(.node element), if it has.

showParent($node)

This method allows you to show programatically the parent node of any specific node(.node element), if it has.

hideChildren($node)

This method allows you to hide programatically the children of any specific node(.node element), if it has.

showChildren($node)

This method allows you to show programatically the children of any specific node(.node element), if it has.

hideSiblings($node, direction)

This method allows you to hide programatically the siblings of any specific node(.node element), if it has.

showSiblings($node, direction)

This method allows you to show programatically the siblings of any specific node(.node element), if it has.

getNodeState($node, relation)

This method returns you the display state of related node of the specified node.

The returning object will have the following structure:

{   "exist": true|false,  //Indicates if has parent|children|siblings   "visible":true|false,  //Indicates if the relationship nodes are visible }

getRelatedNodes($node, relation)

This method returns you the nodes related to the specified node.

setChartScale($chart, newScale)

This method returns you the nodes related to the specified node.

export(exportFilename, exportFileextension)

This method allow you to export current orgchart as png or pdf file.

Events

Tips

How can I deactivate expand/collapse feature of orgchart?

This use case is inspired by the issue. Thanks der-robert and ActiveScottShaw for their constructive discussions😊

Users can enable/disable exapand/collapse feature with className "noncollapsable" as shown below.

$('.orgchart').addClass('noncollapsable'); // deactivate  $('.orgchart').removeClass('noncollapsable'); // activate

Why is the root node gone?

When I have a huge orgchart with enabled "pan" option, if I hide all the children of one of the topmost parents then the chart disappear from screen. It seems that we need to add a reset button to keep the chart visible. For details, please refer to the issue opened by manuel-84 😊

Users can embed any clear up logics into the click handler of the reset buttton as shown below.

$('.orgchart').css('transform',''); // remove the tansform settings

Browser Compatibility

• Chrome 19+
• Firefox 4+
• Safari 6+
• Opera 15+
• IE 10+

Charts Show

I love NBA.

We thank JordiCorbilla😊 for his sharing how to save datasource after chart editing.