@balkangraph/orgchart.js 8.2.7 → 8.2.11

package/orgchart.d.ts

@@ -174,7 +174,13 @@ declare class OrgChart extends OrgChartBase {
      * @param retrieveFields retrive data for fields
      * {@link https://balkan.app/OrgChartJS/Docs/Search | See doc...}            
      */
-    search(value: string, searchInFileds?: Array<string>, retrieveFields?: Array<string>): void;
+    search(value: string, searchInFileds?: Array<string>, retrieveFields?: Array<string>): Array<{
+        id: number | string,
+        name: string,
+        __score: number,
+        __searchField: string,
+        __searchMarks: string
+    }>;
     /**
      * Gets collpased node ids of the specifeid node
      * @param node 
@@ -547,7 +553,8 @@ declare class OrgChart extends OrgChartBase {
     nodeCircleMenuUI: OrgChart.circleMenuUI;
     nodeContextMenuUI: OrgChart.menuUI;
     menuUI: OrgChart.menuUI;
-    toolbarUI: OrgChart.toolbarUI;
+    toolbarUI: OrgChart.toolbarUI;    
+    config: OrgChart.options
 
     static fileUploadDialog(callback: () => void): void;
     static isMobile(): boolean;
@@ -596,21 +603,21 @@ declare class OrgChart extends OrgChartBase {
 
 
     static icon: {
-        png: (w: string, h: string, c: string) => string,
-        pdf: (w: string, h: string, c: string) => string,
-        svg: (w: string, h: string, c: string) => string,
-        csv: (w: string, h: string, c: string) => string,
-        excel: (w: string, h: string, c: string) => string,
-        edit: (w: string, h: string, c: string) => string,
-        details: (w: string, h: string, c: string) => string,
-        remove: (w: string, h: string, c: string) => string,
-        add: (w: string, h: string, c: string) => string,
-        xml: (w: string, h: string, c: string) => string,
-        link: (w: string, h: string, c: string) => string,
-        happy: (w: string, h: string, c: string) => string,
-        sad: (w: string, h: string, c: string) => string,
-        share: (w: string, h: string, c: string, x: string, y: string) => string,
-        user: (w: string, h: string, c: string, x: string, y: string) => string
+        png: (w: string| number, h: string | number, c: string) => string,
+        pdf: (w: string | number| number, h: string | number, c: string) => string,
+        svg: (w: string| number, h: string| number, c: string | number) => string,
+        csv: (w: string| number, h: string| number, c: string| number) => string,
+        excel: (w: string| number, h: string| number, c: string| number) => string,
+        edit: (w: string| number, h: string| number, c: string| number) => string,
+        details: (w: string| number, h: string| number, c: string| number) => string,
+        remove: (w: string| number, h: string| number, c: string| number) => string,
+        add: (w: string| number, h: string| number, c: string| number) => string,
+        xml: (w: string| number, h: string| number, c: string| number) => string,
+        link: (w: string| number, h: string| number, c: string| number) => string,
+        happy: (w: string| number, h: string| number, c: string| number) => string,
+        sad: (w: string| number, h: string| number, c: string| number) => string,
+        share: (w: string| number, h: string| number, c: string| number, x?: string| number, y?: string| number) => string,
+        user: (w: string| number, h: string| number, c: string| number, x?: string| number, y?: string| number) => string
     }
 
 
@@ -736,6 +743,8 @@ declare class OrgChart extends OrgChartBase {
     */
     static LAZY_LOADING_FACTOR: number;
 
+
+
 }
 
 declare namespace OrgChart {    
@@ -1924,4 +1933,196 @@ declare namespace OrgChart {
             elements?: { [key: string]: OrgChart.editFormElement | Array<OrgChart.editFormElement> }
         }
     }
-}export default OrgChart
+}
+/// <reference path="OrgChart.d.ts" />
+
+declare class OrgChartBase {
+
+    /**
+     * Removes specified node from nodes collection, redraws the chart and fires remove event.
+     * @param id identification number of the node
+     * @param callback called at the end of animation
+     * @param fireEvent indicates if the remove event will be called or not
+     */
+    removeNode(id: string | number, callback?: () => void, fireEvent?: boolean): void;
+    /**
+     * Updates the node data, redraws the chart and fires update event.
+     * @param data node data
+     * @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;
+    /**
+     * Adds new node to the nodes collection, redraws the chart and fires remove event
+     * @param data node data
+     * @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;         
+
+    /**
+     * The on() method of the OrgChart class sets up a function that will be called whenever the specified event is delivered to the target.     * 
+     * @category Event Listeners
+     * @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" | "import" | "adding" | "added" | "updated" | "key-down" | "visibility-change" | "renderdefs" | "render" | "prerender" | "screen-reader-text" | "removed" | "ready" | "ripple", listener: (sender: OrgChart, args?: unknown, args1?: unknown, args2?: unknown) => void | boolean): OrgChart;
+
+    /**
+     * Occurs when the node data has been updated by updateNode method.
+     *  ```typescript     
+     * var chart = new OrgChart('#tree', {});
+     * chart.onUpdateNode((args) => {
+     *  //return false; to cancel the operation
+     * });
+     * ```
+     * @category Event Listeners
+     * @param listener 
+     */
+    onUpdateNode(listener: (args: {
+        /**
+         * old node data
+         */
+        oldData: object,
+        /**
+         * new node data
+         */
+        newData: object
+    }) => void): OrgChart;
+
+
+    /**
+     * Occurs when a node has been removed by removeNode method. 
+     *  ```typescript     
+     * var chart = new OrgChart('#tree', {});
+     * chart.onRemoveNode((args) => {
+     *  //return false; to cancel the operation
+     * });
+     * ```
+     * @category Event Listeners
+     * @param listener 
+     */
+    onRemoveNode(listener: (args: {
+        /**
+         * node id
+         */
+        id: number | string,
+        /**
+         * parent ids and sub tree parents ids that needs to be updated on the server. For example if you remove a node that has children all chilren nodes will change their pid to the parent node id of the removed node.
+         */
+        newPidsAndStpidsForIds: {
+            newPidsForIds: { [key: string | number]: string | number },
+            newStpidsForIds: { [key: string | number]: string | number }
+        }
+    }) => void): OrgChart;
+
+    /**
+     * Occurs when a node has been added by addNode method.
+     *  ```typescript     
+     * var chart = new OrgChart('#tree', {});
+     * chart.onAddNode((args) => {     
+     *  //return false; to cancel the operation
+     * });
+     * ```
+     * @category Event Listeners
+     * @param listener 
+     */
+    onAddNode(listener: (args: {
+        /**
+         * new added data node
+         */
+        data: object
+    }) => void): OrgChart;
+    /**
+     * The onDrag event occurs when a node is dragged. *enableDragDrop* option has to be turned on.
+     *  ```typescript     
+     * var chart = new OrgChart('#tree', {});
+     * chart.onDrag(() => {
+     *  //return false; to cancel the operation
+     * });
+     * ```
+     * @category Event Listeners
+     * @param listener 
+     */
+    onDrag(listener: (args: {
+        /**
+         * dragged node id
+         */
+        dragId: string | number
+    }) => void): OrgChart;
+    /**
+     * The onDrop event occurs when a node is dropped. *enableDragDrop* option has to be turned on.
+     *  ```typescript     
+     * var chart = new OrgChart('#tree', {});
+     * chart.onDrop(() => {
+     *  //return false; to cancel the operation
+     * });
+     * ```
+     * @category Event Listeners
+     * @param listener 
+     */
+    onDrop(listener: (args: {
+        /**
+         * dragged node id
+         */
+        dragId: string | number,
+        /**
+         * dropped node id
+         */
+        dropId: string | number
+    }) => void): OrgChart;
+}
+
+declare namespace OrgChart {
+    /**
+     * deprecated, use OrgChart.align.center isntead
+     * @ignore
+     */
+    const CENTER: number;
+    /**
+     * deprecated, use OrgChart.align.orientation isntead
+     * @ignore
+     */
+    const ORIENTATION: number;
+
+
+    /**
+     * deprecated, use OrgChart.layout.normal isntead
+     * @ignore
+     */
+    const normal: number;
+
+    /**
+     * deprecated, use OrgChart.layout.mixed isntead
+     * @ignore
+     */
+    const mixed: number;
+    /**
+     * deprecated, use OrgChart.layout.tree isntead
+     * @ignore
+     */
+    const tree: number;
+    /**
+     * deprecated, use OrgChart.layout.treeLeftOffset isntead
+     * @ignore
+     */
+    const treeLeftOffset: any;
+    /**
+     * deprecated, use OrgChart.layout.treeRightOffset isntead
+     * @ignore
+     */
+    const treeRightOffset: any;
+
+    interface options {
+        /**
+ * With the drag and drop features enabled you can move nodes easily and change the tree structure. Default value - *false*.
+ * ```typescript     
+ * var chart = new OrgChart('#tree', {
+ *      enableDragDrop: true
+ * });
+ * ```
+ */
+        enableDragDrop?: boolean,
+    }
+}
+export default OrgChart