@balkangraph/orgchart.js 8.15.7 → 8.15.9

package/orgchart.d.ts

@@ -2904,29 +2904,175 @@ declare namespace OrgChart {
         }
     }
 
-
+    /**
+     * Toolbar buttons. Set to true if you'd like to show a button
+     */
     interface toolbar  {
+
+        /**
+         * Shows the layout options
+         * ```typescript     
+         * var chart = new OrgChart('#tree', {
+         *      toolbar: {
+         *          layout: true
+         *      }
+         * });
+         * ```
+         */
         layout?: boolean,
+
+        /**
+         * 
+         * Zoom plus and minus buttons
+         * ```typescript     
+         * var chart = new OrgChart('#tree', {
+         *      toolbar: {
+         *          zoom: true
+         *      }
+         * });
+         * ```
+         */
         zoom?: boolean,
+
+        /**
+         * Fit to screen option
+         * ```typescript     
+         * var chart = new OrgChart('#tree', {
+         *      toolbar: {
+         *          fit: true
+         *      }
+         * });
+         * ```
+         */
         fit?: boolean,
+
+        /**
+         * Expand all nodes button
+         * ```typescript     
+         * var chart = new OrgChart('#tree', {
+         *      toolbar: {
+         *          expandAll: true
+         *      }
+         * });
+         * ```
+         */
         expandAll?: boolean,
+
+        /**
+         * Switch to fullscreen button
+         * ```typescript     
+         * var chart = new OrgChart('#tree', {
+         *      toolbar: {
+         *          fullScreen: true
+         *      }
+         * });
+         * ```
+         */
         fullScreen?: boolean
     }
 
+    /**
+     * @ignore
+     */
     interface miniMap  {
+
+        /**
+         * Array of colors to use for the miniMap
+         * ```typescrip
+         * OrgChart.miniMap.colors = ["#FFCA28", "#F57C00", "#039be5", "#757575"];
+         * ```
+         */
         colors?: Array<string>,
+
+        /**
+         * The background color in the miniMAp
+         * ```typescrip
+         * OrgChart.miniMap.selectorBackgroundColor = "#888888";
+         * ```
+         */
         selectorBackgroundColor?: string,
+
+        
+        /**
+         * The background of the focus
+         * ```typescrip
+         * OrgChart.miniMap.backgroundColor = "#fff";
+         * ```
+         */
         backgroundColor?: string,
+
+        /**
+         * The stroke of the focus
+         * ```typescrip
+         * OrgChart.miniMap.focusStroke = "#039BE5";
+         * ```
+         */
         focusStroke?: string,
+
+        /**
+         * The background opacity
+         * ```typescrip
+         * OrgChart.miniMap.opacity = 0.8;
+         * ```
+         */
         opacity?: Number,
+
+        /**
+         * The miniMap border
+         * ```typescrip
+         * OrgChart.miniMap.border = '2px solid #039BE5';
+         * ```
+         */
         border?: string,
+        
+        /**
+         * The miniMap width
+         * ```typescrip
+         * OrgChart.miniMap.width = 200;
+         * ```
+         */
         width?: Number,
+
+        /**
+         * The miniMap height
+         * ```typescrip
+         * OrgChart.miniMap.width = 100;
+         * ```
+         */
         height?: Number,
+
+        /**
+         * The miniMap padding
+         * ```typescrip
+         * OrgChart.miniMap.padding = 10;
+         * ```
+         */
         padding?: Number,
+
+        /**
+         * The miniMap position
+         * ```typescrip
+         * OrgChart.miniMap.padding = {
+         *  top: 'padding',
+         *  left: 'padding',
+         *  right: undefined,
+         *  bottom: undefined
+         * }
+         * ```
+         */
         position?: OrgChart.position,
+
+        /**
+         * Draggable option
+         * default option: true
+         * ```typescrip
+         * OrgChart.miniMap.draggable = false;
+         * ```
+         */
         draggable?: boolean
     }
 
+    
     interface position  {
         top?: string,
         left?: string,