Getting Started

FamilyTree JS extends OrgChart JS, with more functionalities added.

System requirements

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

Installation

  1. Download BALKAN FamilyTree JS 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 FamilyTree JS will be installed. 
     
            
<script src="www.[yourdomain].com/FamilyTree.js"></script>

Your first BALKAN FamilyTree JS project

With BALKAN FamilyTree JS included in your webpage you are ready to create your first FamilyTree 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 FamilyTree JS. 
     
    
<div id="tree"></div>
  2. Add script tags anywhere in a webpage, containing the following code: 
        
            
<script>

    let family = new FamilyTree("#tree", {
        // options
        nodeBinding: {
            field_0: "name"
        },
        nodes: [
            { id: 1, pids: [2], name: "Amber McKenzie", gender: "female" },
            { id: 2, pids: [1], name: "Ava Field", gender: "male" },
            { id: 3, mid: 1, fid: 2, name: "Peter Stevens", gender: "male" }
        ]  
    });

 

</script>
  3. You should now see the following FamilyTree JS on your webpage:
    BALKAN Code Edit in BALKAN Code

Where:

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

pids: are the partner ids, represents connection between two partners (wife and husband).

mid: mother id.

fid: father id.

gender: male or female.


You can see all the options here.

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="FamilyTree.d.ts" />

Update 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.

In this article