@balkangraph/orgchart.js 8.14.100 → 8.14.102

package/orgchart.d.ts

@@ -1684,7 +1684,19 @@ declare class OrgChart {
     static wrapText(text: string, field: Object): string;
 
     static filterUI: {
+        /**
+         * Change the text "Filter by"
+         * ```typescript
+         * OrgChart.filterUI.textFilterBy = 'Filtre par';
+         * ```
+         */
         textFilterBy: string,
+        /**
+         * Chart the text "all"
+         * ```typescript
+         * OrgChart.filterUI.all = '[Toute]'
+         * ```
+         */
         all: string,
     };
 
@@ -1692,22 +1704,64 @@ declare class OrgChart {
      * Shows/hides lloading image. Usefull when export large data to pdf. You can override and show your own loading image.
      */
     static loading: {
+        /**
+         * ```typescript
+         * let chart = new OrgChart('#tree', {});
+         * chart.on('init', function (sender) {
+         *   OrgChart.loading.show(sender);
+         *});
+         * ```
+         * @param chart 
+         * @returns void
+         */
         show: (chart: OrgChart) => void,
+        /**
+         * ```typescript
+         * let chart = new OrgChart('#tree', {});
+         * fetch('https://balkan.app/content/100k.json')
+         *   .then((response) => response.json())
+         *   .then((data) => chart.load(data, function () {
+         *       OrgChart.loading.hide(chart);
+         *   }));
+         * ```
+         * @param chart 
+         * @returns void
+         */
         hide: (chart: OrgChart) => void
     }
-
+    /**
+     * ```typescript
+     * OrgChart.clinkTemplates.myTemplate = Object.assign({}, OrgChart.clinkTemplates.orange);
+     * ```
+     */
     static clinkTemplates: {
         [key: string]: OrgChart.linkTemplate
     }
-
+    /**
+     * ```typescript
+     * OrgChart.slinkTemplates.myTemplate = Object.assign({}, OrgChart.slinkTemplates.orange);
+     * ```
+     */
     static slinkTemplates: {
         [key: string]: OrgChart.linkTemplate
     }
 
-
+    /**
+     * ```typescript
+     * OrgChart.templates.mainTemplate = Object.assign({}, OrgChart.templates.ana);
+     * ```
+     */
     static templates: { [key: string]: OrgChart.template} ;
     
 
+    /**
+     * ```typescript
+     * let chart = new OrgChart(document.getElementById("tree"), {
+     *     ...
+     *    showXScroll: OrgChart.scroll.visible,
+     * });
+     * ```
+     */
     static scroll: {
         visible?: boolean,
         smooth?: number,
@@ -1878,11 +1932,18 @@ declare class OrgChart {
     /**
      * Can be used to instruct the browser to defer loading of OrgChart that are off-screen until the user scrolls near them.
      * The init event listener will be called as soon as the OrgChart become visible.
+     * Default value: true
+     * ```typescript
+     * OrgChart.LAZY_LOADING = false;
+     * ```
      */
     static LAZY_LOADING: boolean;
 
     /**
-     * Minimum in search input before triggering the  search.
+     * Minimum in search input before triggering the search.
+     * ```typescript
+     * OrgChart.MINIMUM_SYMBOLS_IN_SEARCH_INPUT = 3;
+     * ```
      */
     static MINIMUM_SYMBOLS_IN_SEARCH_INPUT: number;