@balkangraph/orgchart.js 8.17.3 → 8.17.5

package/orgchart.d.ts

@@ -232,11 +232,11 @@ declare class OrgChart {
         /**
          * old node data
          */
-        oldData: object,
+        oldData: nodeData,
         /**
          * new node data
          */
-        newData: object
+        newData: nodeData
     }) => void): OrgChart;
 
         /**
@@ -293,7 +293,7 @@ declare class OrgChart {
         /**
          * new added data node
          */
-        data: object
+        data: nodeData
     }) => void): OrgChart;
     /**
      * The onDrag event occurs when a node is dragged. *enableDragDrop* option has to be turned on.
@@ -433,7 +433,7 @@ declare class OrgChart {
      * @param callback called at the end of animation
      * @param fireEvent indicates if the add event will be called or not
      */
-    addNode(data: object, callback?: () => void, fireEvent?: boolean): void;  
+    addNode(data: nodeData, callback?: () => void, fireEvent?: boolean): void;  
 
     /**
      * Removes specified node from nodes collection, redraws the chart and fires remove event.
@@ -457,7 +457,7 @@ declare class OrgChart {
      * ```
      * @param id identification number of the node
      */
-    get(id: string | number): Node;
+    get(id: string | number): nodeData;
     /**
      * If specified node has assistant/s or partner/s as children will return false.
      * ```typescript     
@@ -552,10 +552,12 @@ declare class OrgChart {
      *  { id: 3, pid: 1, name: "Caden Ellison" }
      * ]);
      * ```
-     * @param data node data array
+     * @param data nodes data array
      * @param callback function called after the load
      */
-    load(data: Array<object>, callback?: () => void): OrgChart;
+    load(data: Array<nodeData>, callback?: () => void): OrgChart;
+
+
 
     /**
      * Updates the node data, redraws the chart and fires update event.
@@ -568,7 +570,7 @@ declare class OrgChart {
      * @param callback function called when the animation completes
      * @param fireEvent if it set to true the update event is called
      */
-    updateNode(data: object, callback?: () => void, fireEvent?: boolean): void;
+    updateNode(data: nodeData, callback?: () => void, fireEvent?: boolean): void;
 
     /**
      * Loads nodes from xml.
@@ -1043,7 +1045,7 @@ declare class OrgChart {
         childLevels?: boolean,
         parentLevels?: boolean,
         min?: boolean,
-        pages?: {
+        pages?: Array<{
             chartInstance?: OrgChart,
             nodeId?: number | string,
             expandChildren?: boolean,
@@ -1052,7 +1054,7 @@ declare class OrgChart {
             min?: boolean,
             header?: string,
             footer?: string
-        },
+        }>,
         format?: "Screen" | "Widescreen" | "Standard" | "A1" | "A2" | "A3" | "A4" | "A5" | "A4" | "Letter" | "Legal",
         header?: string,
         footer?: string
@@ -2314,9 +2316,39 @@ declare class OrgChart {
     static grCloseTag: any;
 }
 
-interface Node {
+/**
+ * The node JSON data
+ * ```ts
+ * { id: 2, pid: 1, tags: ["HR"], name: "Anna Smith" }
+ * ```
+ */
+interface nodeData {
+
+    /**
+     * the id of the node
+     */
     id: number | string,
+
+    /**
+     * the parent id
+     */
     pid?: number | string,
+
+    /**
+     * the parent partner id
+     */
+    ppid?: number | string,
+
+    /**
+     * the subtree parent id
+     */
+    stPid?: number | string,
+
+    /**
+     * Set custom configuration for the tagged node
+     *{@link https://balkan.app/OrgChartJS/Docs/Tags | See Tags doc page...} 
+     */
+    tags?: Array<string>,
     [key: string]: any
 }
 
@@ -4747,6 +4779,9 @@ declare namespace OrgChart {
          * - Change node menu, circle menu and context menu items for tagged node/s {@link https://balkan.app/OrgChartJS/Docs/Menus | See doc...}
          * - Set the node level {@link https://balkan.app/OrgChartJS/Demos/SubLevels | See demo...}
          * - Set specific options for sub trees like layout templates etc {@link https://balkan.app/OrgChartJS/Docs/SubTrees | See doc...}          
+         *  * - Set specific options for sub trees like layout templates, etc. {@link https://balkan.app/OrgChartJS/Docs/SubTrees | See doc...}        
+         * - Set custom CSS, for example node color, field color, etc. {@link https://balkan.app/OrgChartJS/Docs/CSSCustomization | See CSS doc page...}  
+         * - {@link https://balkan.app/OrgChartJS/Docs/Tags | See Tags doc page...}  
          * ```typescript     
          * var chart = new OrgChart('#tree', {
          *      tags: {

package/orgchart.js

@@ -1 +1 @@
-/* eslint-disable */ 
+/* eslint-disable */ 

package/package.json

@@ -1 +1 @@
-{"author":{"name":"BALKAN App"},"bugs":{"email":"support@balkan.app","url":"https://github.com/BALKANGraph/OrgChartJS/issues"},"deprecated":false,"description":"Ultimate Organizational Chart JavaScript library, Interactive Diagrams","files":["orgchart.js","orgchart.d.ts","package.json","README.md"],"homepage":"https://balkan.app/","keywords":["diagram","chart","tree","orgchart","graph","svg","hierarchy","family-tree","decision-tree","visualization","tree-layout","hierarchical","javascript","js","html","html5"],"license":"SEE LICENSE IN https://balkan.app","main":"orgchart.js","types":"orgchart.d.ts","name":"@balkangraph/orgchart.js","repository":{"type":"git","url":"https://github.com/BALKANGraph/OrgChartJS"},"dependencies":{},"version":"8.17.03"}
+{"author":{"name":"BALKAN App"},"bugs":{"email":"support@balkan.app","url":"https://github.com/BALKANGraph/OrgChartJS/issues"},"deprecated":false,"description":"Ultimate Organizational Chart JavaScript library, Interactive Diagrams","files":["orgchart.js","orgchart.d.ts","package.json","README.md"],"homepage":"https://balkan.app/","keywords":["diagram","chart","tree","orgchart","graph","svg","hierarchy","family-tree","decision-tree","visualization","tree-layout","hierarchical","javascript","js","html","html5"],"license":"SEE LICENSE IN https://balkan.app","main":"orgchart.js","types":"orgchart.d.ts","name":"@balkangraph/orgchart.js","repository":{"type":"git","url":"https://github.com/BALKANGraph/OrgChartJS"},"dependencies":{},"version":"8.17.05"}