@balkangraph/orgchart.js 8.2.77 → 8.3.0

package/orgchart.d.ts

@@ -343,6 +343,7 @@ declare class OrgChart extends OrgChartBase {
      * chart.onField((args) => {
      *      //return false; to cancel
      * });
+     * chart.load(nodes);
      * ```
      * @category Event Listeners
      * @param listener 
@@ -376,6 +377,7 @@ declare class OrgChart extends OrgChartBase {
      * var chart = new OrgChart('#tree', {});
      * chart.onInit(() => {
      * });
+     * chart.load(nodes);
      * ```
      * @category Event Listeners
      * @param listener 
@@ -390,6 +392,7 @@ declare class OrgChart extends OrgChartBase {
      * var chart = new OrgChart('#tree', {});
      * chart.onRedraw(() => {
      * });
+     * chart.load(nodes);
      * ```
      * @category Event Listeners
      * @param listener 
@@ -403,6 +406,7 @@ declare class OrgChart extends OrgChartBase {
      * chart.onExpandCollpaseButtonClick(() => {
      *  //return false; to cancel the operation
      * });
+     * chart.load(nodes);
      * ```
      * @category Event Listeners
      * @param listener 
@@ -429,6 +433,7 @@ declare class OrgChart extends OrgChartBase {
      *  args.styles += '<link href="https://fonts.googleapis.com/css?family=Gochi+Hand" rel="stylesheet">';
      *  //return false; to cancel the operation
      * });
+     * chart.load(nodes);
      * ```
      * @category Event Listeners
      * @param listener 
@@ -485,6 +490,7 @@ declare class OrgChart extends OrgChartBase {
      * chart.onExportEnd(() => {
      *  //return false; to cancel the operation for example id you prefer the exported document to not download
      * });
+     * chart.load(nodes);
      * ```
      * @category Event Listeners
      * @param listener 
@@ -544,6 +550,7 @@ declare class OrgChart extends OrgChartBase {
      * chart.onNodeClick(() => {
      *  //return false; to cancel the operation      
      * });
+     * chart.load(nodes);
      * ```
      * @category Event Listeners
      * @param listener 
@@ -565,6 +572,7 @@ declare class OrgChart extends OrgChartBase {
      * chart.onNodeDoubleClick(() => {
      *  //return false; to cancel the operation 
      * });
+     * chart.load(nodes);
      * ```
      * @category Event Listeners
      * @param listener 
@@ -639,8 +647,14 @@ declare class OrgChart extends OrgChartBase {
         firefox?: { smooth?: number; speed?: number; },
         opera?: { smooth?: number; speed?: number; }
     };
+    
 
     static events: {
+        /**
+         * node-created and layout event listeners are obsolete use node-initialized or node-layout instead
+         * @param type 
+         * @param listener 
+         */
         on(type: "node-created" | "layout", listener: (args: any, args1: any, args2: any) => void): void
     };
     static state: { clear(stateName: string): void };
@@ -792,6 +806,118 @@ declare namespace OrgChart {
 
     var template: object;
 
+    interface node {
+        /**
+         * the same id you provided in the source node
+         */
+        id?: string | number,
+        /**
+         *  partner parent id, it is the partner parent node id of the partner node, it is the same ppid you provided in the source node, the default value is undefined.
+         */
+        ppid?: string | number,
+        /**
+         * a reference to the parent node, default value is null, if the nodes is collapse this proprty is not initalized and can be null even if pid is not null
+         */
+        parent?: node,
+        /**
+         * ub tree parent id, it is the parent node id of the root node of the sub tree, it is the same stpid you provided in the source node, the default value is null if not provided or if node with the same id does not exist.
+         */
+        stpid?: string | number,
+        /**
+         * - a reference to the parent node of a sub tree, default value is null, if the parent node is minimized this proprty is not initalized and can be null even if we have stpid
+         */
+        stParent?: node,
+        isPartner?: boolean,
+        partnerSeparation?: number,
+        /**
+         * array of ids, always initialized
+         */
+        childrenIds?: Array<string | number>,
+        /**
+         * array of children nodes, initialized on demand if all children are collpased it will be empty array
+         */
+        children?: Array<node>,
+        /**
+         * array of sub tree children root node ids, always initialized
+         */
+        stChildrenIds?: Array<string | number>,
+        /**
+         * array of sub tree children root nodes, initialized on demand if the node is minimized it will be empty array
+         */
+        stChildren?: Array<node>,
+        /**
+         * array of string values, the same array you provided in the source node
+         */
+        tags?: Array<string>,
+        /**
+         * template name, you can specify multiple templates with tags in one chart
+         */
+        templateName?: string,
+        /**
+         * a reference to the left node neighbor, the default value is undefined
+         */
+        leftNeighbor?: node | undefined,
+        /**
+         *  a reference to the right node neighbor, the default value is undefined
+         */
+        rightNeighbor?: node | undefined,
+        /**
+         * x position, default value undefined
+         */
+        x?: number | undefined,
+        /**
+         *  y position, default value undefined
+         */
+        y?: number | undefined,
+        /**
+         * width of the node, default value undefined
+         */
+        w?: number | undefined,
+        /**
+         * height of the node, default value undefined
+         */
+        h?: number | undefined,
+        /**
+         * if the node is assistant is true if not false if the node is not initialized is undefined
+         */
+        isAssistant?: boolean | undefined,
+        /**
+         * sub tree container nodes array, property only for the root node, default value undefined
+         */
+        stContainerNodes?: Array<node> | undefined,
+        /**
+         * it is set only if you define order option, default value undefined
+         */
+        order?: number | undefined,
+        /**
+         * true if the node is collpased, false if it is not and undefined if not initalized
+         */
+        collapsed?: boolean | undefined,
+        /**
+         * a level of the node starting from zero
+         */
+        level?: number,
+        /**
+         * true if the node is minimized, default value undefined
+         */
+        min?: boolean | undefined,
+        /**
+         * sub levels, default value undefined
+         */
+        subLevels?: number | undefined,
+        /**
+         * set only if the node contains sub trees and padding is defined in the template, default value undefined
+         */
+        padding?: number | undefined,
+        /**
+         * layout configuration name, default value undefined
+         */
+        lcn?: string | undefined,
+        /**
+         * for assistant nodes and mixed layout we create dynamic nodes called splits, default value undefined
+         */
+        isSplit?: boolean | undefined
+    }
 
 
     interface template  
@@ -880,6 +1006,14 @@ declare namespace OrgChart {
         createItem(img: string, id: string | number, first: string, second: string): string;
     }
 
+    
+    interface filterUI {
+        init(instance: OrgChart): void;   
+        update(): void;
+        shouldFilter(data: object): boolean;
+    }
+
+
     interface menuUI {
         init(obj: OrgChart, menu: { [key: string]: menu }): void;
         /**
@@ -1677,7 +1811,21 @@ declare namespace OrgChart {
           * });
           * ```      
           */
-        orderBy?: string,
+        orderBy?: string | Array<OrgChart.orderBy>,
+        /**
+          * Filter the OrgChart by the specified fields.
+          * ```typescript       
+          * var chart = new OrgChart('#tree', {
+          *   filterBy: 'all'
+          * });
+          * ```    
+          * ```typescript       
+          * var chart = new OrgChart('#tree', {
+          *   filterBy: ['country', 'title']
+          * });
+          * ```      
+          */
+        filterBy?: string | Array<string> | boolean,
         /**
           * @ignore
           */
@@ -1686,6 +1834,10 @@ declare namespace OrgChart {
           * @ignore
           */
         searchUI?: OrgChart.searchUI,
+        /**
+          * @ignore
+          */
+        filterUI?: OrgChart.filterUI,        
         /**
           * @ignore
           */
@@ -1923,7 +2075,7 @@ declare class OrgChartBase {
      * @param type A case-sensitive string representing the event type to listen for.
      * @param listener The object that receives a notification when an event of the specified type occurs. This must be a JavaScript function. 
      */
-    on(type: "init" | "field" | "update" | "add" | "remove" | "renderbuttons" | "label" | "render-link" | "drag" | "drop" | "redraw" | "expcollclick" | "exportstart" | "exportend" | "click" | "dbclick" | "slink-click" | "clink-click" | "up-click" | "searchclick" | "import" | "adding" | "added" | "updated" | "key-down" | "visibility-change" | "renderdefs" | "render" | "prerender" | "screen-reader-text" | "removed" | "ready" | "ripple", listener: (sender: OrgChart, args?: any, args1?: any, args2?: any) => void | boolean): OrgChart;
+    on(type: "init" | "field" | "update" | "add" | "remove" | "renderbuttons" | "label" | "render-link" | "drag" | "drop" | "redraw" | "expcollclick" | "exportstart" | "exportend" | "click" | "dbclick" | "slink-click" | "clink-click" | "up-click" | "searchclick" | "import" | "adding" | "added" | "updated" | "key-down" | "visibility-change" | "renderdefs" | "render" | "prerender" | "screen-reader-text" | "removed" | "ready" | "ripple" | "node-initialized" | "node-layout", listener: (sender: OrgChart, args?: any, args1?: any, args2?: any) => void | boolean): OrgChart;
 
     /**
      * Occurs when the node data has been updated by updateNode method.
@@ -2033,120 +2185,10 @@ declare class OrgChartBase {
 declare namespace OrgChart {
     
     interface node {
-        /**
-         * the same id you provided in the source node
-         */
-        id?: string | number,
         /**
          * same pid you provided in the source node, the default value is null if not provided or if node with the same id does not exist
          */
         pid?: string | number,
-        /**
-         *  partner parent id, it is the partner parent node id of the partner node, it is the same ppid you provided in the source node, the default value is undefined.
-         */
-        ppid?: string | number,
-        /**
-         * a reference to the parent node, default value is null, if the nodes is collapse this proprty is not initalized and can be null even if pid is not null
-         */
-        parent?: node,
-        /**
-         * ub tree parent id, it is the parent node id of the root node of the sub tree, it is the same stpid you provided in the source node, the default value is null if not provided or if node with the same id does not exist.
-         */
-        stpid?: string | number,
-        /**
-         * - a reference to the parent node of a sub tree, default value is null, if the parent node is minimized this proprty is not initalized and can be null even if we have stpid
-         */
-        stParent?: node,
-        isPartner?: boolean,
-        partnerSeparation?: number,
-        /**
-         * array of ids, always initialized
-         */
-        childrenIds?: Array<string | number>,
-        /**
-         * array of children nodes, initialized on demand if all children are collpased it will be empty array
-         */
-        children?: Array<node>,
-        /**
-         * array of sub tree children root node ids, always initialized
-         */
-        stChildrenIds?: Array<string | number>,
-        /**
-         * array of sub tree children root nodes, initialized on demand if the node is minimized it will be empty array
-         */
-        stChildren?: Array<node>,
-        /**
-         * array of string values, the same array you provided in the source node
-         */
-        tags?: Array<string>,
-        /**
-         * template name, you can specify multiple templates with tags in one chart
-         */
-        templateName?: string,
-        /**
-         * a reference to the left node neighbor, the default value is undefined
-         */
-        leftNeighbor?: node | undefined,
-        /**
-         *  a reference to the right node neighbor, the default value is undefined
-         */
-        rightNeighbor?: node | undefined,
-        /**
-         * x position, default value undefined
-         */
-        x?: number | undefined,
-        /**
-         *  y position, default value undefined
-         */
-        y?: number | undefined,
-        /**
-         * width of the node, default value undefined
-         */
-        w?: number | undefined,
-        /**
-         * height of the node, default value undefined
-         */
-        h?: number | undefined,
-        /**
-         * if the node is assistant is true if not false if the node is not initialized is undefined
-         */
-        isAssistant?: boolean | undefined,
-        /**
-         * sub tree container nodes array, property only for the root node, default value undefined
-         */
-        stContainerNodes?: Array<node> | undefined,
-        /**
-         * it is set only if you define order option, default value undefined
-         */
-        order?: number | undefined,
-        /**
-         * true if the node is collpased, false if it is not and undefined if not initalized
-         */
-        collapsed?: boolean | undefined,
-        /**
-         * a level of the node starting from zero
-         */
-        level?: number,
-        /**
-         * true if the node is minimized, default value undefined
-         */
-        min?: boolean | undefined,
-        /**
-         * sub levels, default value undefined
-         */
-        subLevels?: number | undefined,
-        /**
-         * set only if the node contains sub trees and padding is defined in the template, default value undefined
-         */
-        padding?: number | undefined,
-        /**
-         * layout configuration name, default value undefined
-         */
-        lcn?: string | undefined,
-        /**
-         * for assistant nodes and mixed layout we create dynamic nodes called splits, default value undefined
-         */
-        isSplit?: boolean | undefined
     }
     /**
      * deprecated, use OrgChart.align.center isntead