@balkangraph/orgchart.js 8.14.73 → 8.14.75

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/orgchart.d.ts CHANGED
@@ -1028,17 +1028,48 @@ declare class OrgChart extends OrgChartBase {
1028
1028
  }) => void): OrgChart;
1029
1029
 
1030
1030
  /**
1031
- * ?
1031
+ * The tree div element.
1032
+ * let chart = new OrgChart('#tree', {});
1033
+ * let element = chart.element;
1032
1034
  */
1033
1035
  element: HTMLElement;
1034
1036
 
1035
-
1037
+ /**
1038
+ * The chart editUI object.
1039
+ * let chart = new OrgChart('#tree', {});
1040
+ * let editUI = chart.editUI;
1041
+ */
1036
1042
  editUI: OrgChart.editUI;
1037
-
1043
+
1044
+ /**
1045
+ * The chart searchUI object.
1046
+ * let chart = new OrgChart('#tree', {});
1047
+ * let searchUI = chart.searchUI;
1048
+ */
1038
1049
  searchUI: OrgChart.searchUI;
1050
+
1051
+ /**
1052
+ * The chart nodeMenuUI object.
1053
+ * let chart = new OrgChart('#tree', {});
1054
+ * let nodeMenuUI = chart.nodeMenuUI;
1055
+ */
1039
1056
  nodeMenuUI: OrgChart.menuUI;
1057
+
1058
+ /**
1059
+ * The chart filterUI object.
1060
+ * let chart = new OrgChart('#tree', {});
1061
+ * let filterUI = chart.filterUI;
1062
+ */
1040
1063
  filterUI: OrgChart.filterUI;
1064
+
1065
+ /**
1066
+ * @ignore
1067
+ */
1041
1068
  xScrollUI: OrgChart.xScrollUI;
1069
+
1070
+ /**
1071
+ * @ignore
1072
+ */
1042
1073
  yScrollUI: OrgChart.yScrollUI;
1043
1074
  undoRedoUI: OrgChart.undoRedoUI;
1044
1075
  nodeCircleMenuUI: OrgChart.circleMenuUI;
@@ -2195,6 +2226,13 @@ declare namespace OrgChart {
2195
2226
  showXScroll?: boolean ,
2196
2227
  /**
2197
2228
  * movable node, move the node anywhere on the canvas
2229
+ * ```typescript
2230
+ * let chart = new OrgChart('#tree', {
2231
+ * movable: OrgChart.movable.node,
2232
+ * // movable: OrgChart.movable.tree,
2233
+ * // movable: OrgChart.movable.detachTree,
2234
+ * });
2235
+ * ```
2198
2236
  */
2199
2237
  movable?: OrgChart.movable,
2200
2238
  /**
@@ -2577,6 +2615,11 @@ declare namespace OrgChart {
2577
2615
  /**
2578
2616
  * Sets the maximum number of columns in grid layout, it has to be even nymber or 'dynamic' string
2579
2617
  * The default id 'dynamic', that means that the maximum colomn numbers are dinamicly calculated
2618
+ * ```typescript
2619
+ * let chart = new OrgChart('#tree', {
2620
+ * layoutGridColumns: 10,
2621
+ * });
2622
+ * ```
2580
2623
  */
2581
2624
  layoutGridColumns?: string | number,
2582
2625
  /**
@@ -2800,8 +2843,14 @@ declare namespace OrgChart {
2800
2843
  },
2801
2844
  /**
2802
2845
  * Set the session storage name to use undo/redo functionallity.
2846
+ * ```typescript
2847
+ * let chart = new OrgChart('#tree', {
2848
+ * undoRedoStorageName: 'myStorageName',
2849
+ * });
2850
+ * ```
2803
2851
  */
2804
2852
  undoRedoStorageName?: string,
2853
+
2805
2854
  /**
2806
2855
  * Configure the buildin edit form.
2807
2856
  * ```typescript