@balkangraph/orgchart.js 8.15.30 → 8.15.32

package/orgchart.d.ts

@@ -2651,6 +2651,18 @@ declare namespace OrgChart {
             [name: string]: any
         }
 
+
+    /**
+     * Edit/Details Form User Interface
+     * ```typescript
+     * let chart = new OrgChart("#tree", {
+     * });
+     * chart.onInit(function(){
+     *  chart.editUI.show(1); 
+     * });
+     * chart.load(nodes)
+     * ```
+     */
     interface editUI {
         /**
          * Inits edit ui
@@ -2679,7 +2691,18 @@ declare namespace OrgChart {
         // static renderHeaderContent(title: string, photo: string, node: OrgChart.node, data: object): string;        
     }
 
-    
+    /**
+     * AI User Interface
+     * ```typescript
+     * let chart = new OrgChart("#tree", {
+     *  enableAI: true,
+     * });
+     * chart.onInit(function(){
+     *  chart.aiUI.show(); 
+     * });
+     * chart.load(nodes)
+     * ```
+     */
     interface aiUI {
         /**
          * Prompt text box
@@ -2910,9 +2933,42 @@ declare namespace OrgChart {
         layoutIcon?: string;
     }
 
-
     /**
      * When you implement function calling in a prompt, you create a tools object, which contains one or more function declarations.
+     * ```typescript     
+     * var chart = new OrgChart('#tree', {
+     *  enableAI: true,
+     *      aiChatTools: [{
+     *          functionName: 'sendEmail',
+     *          functionDescription: 'Send an email to a given employee with a subject and message.',
+     *          functionParameters: {
+     *              type: "object",
+     *                  properties: {
+     *                      to: {
+     *                          type: "string",
+     *                          description: "The employee email address."
+     *                      },
+     *                      subject: {
+     *                          type: "string",
+     *                          description: "Email subject line."
+     *                      },
+     *                      body: {
+     *                          type: "string",
+     *                          description: "Body of the email message."
+     *                      }
+     *                  },
+     *                  required: [
+     *                      "to",
+     *                      "subject",
+     *                      "body"
+     *                  },
+     *                  additionalProperties: false
+     *              },
+     *              strict: true
+     *      }]
+     * });
+     * ```
+     * [Go to AI doc page for more details](https://balkan.app/OrgChartJS/Docs/AI)
      */
     interface aiChatTool  {
         /**
@@ -3194,6 +3250,10 @@ declare namespace OrgChart {
         template?: string,
         label?: string
     }
+
+    /**
+     * @ignore
+     */
     interface backdrop {
         id?: string | number,
         levels?: number,
@@ -4255,14 +4315,7 @@ declare namespace OrgChart {
         slinks?: Array<OrgChart.link>,
 
         /**
-         * Adds backdrops to the specidied nodes.
-         * ```typescript     
-         * var chart = new OrgChart('#tree', {
-         *   backdrops: [
-         *       { id: 5, levels: 2, color: '#039BE5', opacity: 0.2 }
-         *   ]
-         * });
-         * ```
+         * @ignore
          */
         backdrops?: Array<OrgChart.backdrop>,
 
@@ -4520,7 +4573,12 @@ declare namespace OrgChart {
             text?: string
         } }},
         /**
-          * @ignore
+          * ```typescript
+          * let chart = new OrgChart('#tree', {
+          *     editUI: new editForm(),
+          * });
+          * ```
+          * [Go to edit doc page for more details](https://balkan.app/OrgChartJS/Docs/Edit#custom)
           */
         editUI?: OrgChart.editUI,
         /**