@balkangraph/orgchart.js 8.14.100 → 8.14.101

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
@@ -1684,7 +1684,19 @@ declare class OrgChart {
1684
1684
  static wrapText(text: string, field: Object): string;
1685
1685
 
1686
1686
  static filterUI: {
1687
+ /**
1688
+ * Change the text "Filter by"
1689
+ * ```typescript
1690
+ * OrgChart.filterUI.textFilterBy = 'Filtre par';
1691
+ * ```
1692
+ */
1687
1693
  textFilterBy: string,
1694
+ /**
1695
+ * Chart the text "all"
1696
+ * ```typescript
1697
+ * OrgChart.filterUI.all = '[Toute]'
1698
+ * ```
1699
+ */
1688
1700
  all: string,
1689
1701
  };
1690
1702
 
@@ -1692,22 +1704,64 @@ declare class OrgChart {
1692
1704
  * Shows/hides lloading image. Usefull when export large data to pdf. You can override and show your own loading image.
1693
1705
  */
1694
1706
  static loading: {
1707
+ /**
1708
+ * ```typescript
1709
+ * let chart = new OrgChart('#tree', {});
1710
+ * chart.on('init', function (sender) {
1711
+ * OrgChart.loading.show(sender);
1712
+ *});
1713
+ * ```
1714
+ * @param chart
1715
+ * @returns void
1716
+ */
1695
1717
  show: (chart: OrgChart) => void,
1718
+ /**
1719
+ * ```typescript
1720
+ * let chart = new OrgChart('#tree', {});
1721
+ * fetch('https://balkan.app/content/100k.json')
1722
+ * .then((response) => response.json())
1723
+ * .then((data) => chart.load(data, function () {
1724
+ * OrgChart.loading.hide(chart);
1725
+ * }));
1726
+ * ```
1727
+ * @param chart
1728
+ * @returns void
1729
+ */
1696
1730
  hide: (chart: OrgChart) => void
1697
1731
  }
1698
-
1732
+ /**
1733
+ * ```typescript
1734
+ * OrgChart.clinkTemplates.myTemplate = Object.assign({}, OrgChart.clinkTemplates.orange);
1735
+ * ```
1736
+ */
1699
1737
  static clinkTemplates: {
1700
1738
  [key: string]: OrgChart.linkTemplate
1701
1739
  }
1702
-
1740
+ /**
1741
+ * ```typescript
1742
+ * OrgChart.slinkTemplates.myTemplate = Object.assign({}, OrgChart.slinkTemplates.orange);
1743
+ * ```
1744
+ */
1703
1745
  static slinkTemplates: {
1704
1746
  [key: string]: OrgChart.linkTemplate
1705
1747
  }
1706
1748
 
1707
-
1749
+ /**
1750
+ * ```typescript
1751
+ * OrgChart.templates.mainTemplate = Object.assign({}, OrgChart.templates.ana);
1752
+ * ```
1753
+ */
1708
1754
  static templates: { [key: string]: OrgChart.template} ;
1709
1755
 
1710
1756
 
1757
+ /**
1758
+ * ```typescript
1759
+ * let chart = new OrgChart(document.getElementById("tree"), {
1760
+ * ...
1761
+ * showXScroll: OrgChart.scroll.visible,
1762
+ * });
1763
+ * ```
1764
+ */
1711
1765
  static scroll: {
1712
1766
  visible?: boolean,
1713
1767
  smooth?: number,