Show / Hide Table of Contents

Getting Started

Hello Org Chart JS

System requirements

  • Org Chart JS runs on any server that supports HTML. You can even run BALKAN OrgChartJS locally from a filesystem.
  • Org Chart JS does not depend on any third party JavaScript library
  • Org Chart JS works in all modern browsers and uses SVG for the graphics rendering

Installation

  1. Download BALKAN OrgChartJS file form here.
  2. Unzip the file and add it to you root directory.
  3. In your html document between the head tags include the code bellow, and then Org Chart JS will be installed.
     
            <script src="www.[yourdomain].com/OrgChart.js"></script>
                

Your first BALKAN OrgChartJS project

With BALKAN OrgChartJS included in your webpage you are ready to create your first Org Chart JS.

  1. Add a div in your webpage. Give it an id and set a specific width and height which will be the width and height of your Org Chart JS.
     
            <div style="width:100%; height:700px;" id="tree"></div>
                
  2. Add script tags anywhere in a webpage, containing the following code:
        
    
        <script>
            let chart = new OrgChart(document.getElementById("tree"), {
                nodeBinding: {
                    field_0: "name"
                },
                nodes: [
                    { id: 1, name: "Amber McKenzie" },
                    { id: 2, pid: 1, name: "Ava Field" },
                    { id: 3, pid: 1, name: "Peter Stevens" }  
                ]
            });
        </script> 
     
                    
                
  3. You should now see the following Org Chart JS on your webpage:

Where:

nodes: is the data source. The 'id' property is mandatory.

pid: is the parent id, represents connection between two nodes.

nodeBinding: 'name' property form the data source will be bound to 'field_0' ui element from the template.

TypeScript Declaration File

The download package includes .d.ts file.
If you don't use any frameworks, in order to have intellisense for your .js file in Visual Studio Code, you need to inclide this refference in the top of the file:

    /// <reference path="OrgChart.d.ts" />

Update the database

Use onAddNode and onRemoveNode methods to add or remove nodes in the database.

Use onUpdateNode method to save changes in the database.

Here we have an example on how to update the database. For more details, see our Server Side examples doc page.

License

We believe in a simple, transparent and flexible licensing and pricing model that is aligned with the business value BALKAN App delivers to you. All licenses include one year of maintenance and technical support and are available on perpetual base.