@d3plus/core 3.0.13 → 3.0.15
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/README.md +78 -51
- package/es/src/charts/Sankey.js +37 -1
- package/es/src/components/Axis.js +21 -5
- package/package.json +8 -8
- package/umd/d3plus-core.full.js +49 -8
- package/umd/d3plus-core.full.js.map +1 -1
- package/umd/d3plus-core.full.min.js +27 -7
- package/umd/d3plus-core.js +49 -8
- package/umd/d3plus-core.js.map +1 -1
- package/umd/d3plus-core.min.js +58 -38
package/README.md
CHANGED
|
@@ -1645,13 +1645,16 @@ This is a global class, and extends all of the methods and functionality of [<co
|
|
|
1645
1645
|
* [Sankey](#Sankey) ⇐ [<code>Viz</code>](#Viz)
|
|
1646
1646
|
* [new Sankey()](#new_Sankey_new)
|
|
1647
1647
|
* [.hover([*value*])](#Sankey.hover) ↩︎
|
|
1648
|
+
* [.iterations([*value*])](#Sankey.iterations) ↩︎
|
|
1648
1649
|
* [.links(*links*)](#Sankey.links) ↩︎
|
|
1650
|
+
* [.linkSort([*value*])](#Sankey.linkSort) ↩︎
|
|
1649
1651
|
* [.linksSource([*value*])](#Sankey.linksSource) ↩︎
|
|
1650
1652
|
* [.linksTarget([*value*])](#Sankey.linksTarget) ↩︎
|
|
1651
1653
|
* [.nodeAlign([*value*])](#Sankey.nodeAlign) ↩︎
|
|
1652
1654
|
* [.nodeId([*value*])](#Sankey.nodeId) ↩︎
|
|
1653
1655
|
* [.nodes(*nodes*)](#Sankey.nodes) ↩︎
|
|
1654
1656
|
* [.nodePadding([*value*])](#Sankey.nodePadding) ↩︎
|
|
1657
|
+
* [.nodeSort([*value*])](#Sankey.nodeSort) ↩︎
|
|
1655
1658
|
* [.nodeWidth([*value*])](#Sankey.nodeWidth) ↩︎
|
|
1656
1659
|
* [.value(*value*)](#Sankey.value)
|
|
1657
1660
|
|
|
@@ -1664,7 +1667,7 @@ Creates a sankey visualization based on a defined set of nodes and links. [Click
|
|
|
1664
1667
|
|
|
1665
1668
|
|
|
1666
1669
|
|
|
1667
|
-
<a name="Sankey.hover" href="#Sankey.hover">#</a> Sankey.**hover**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#
|
|
1670
|
+
<a name="Sankey.hover" href="#Sankey.hover">#</a> Sankey.**hover**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L231)
|
|
1668
1671
|
|
|
1669
1672
|
If *value* is specified, sets the hover method to the specified function and returns the current class instance.
|
|
1670
1673
|
|
|
@@ -1672,7 +1675,15 @@ If *value* is specified, sets the hover method to the specified function and ret
|
|
|
1672
1675
|
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1673
1676
|
|
|
1674
1677
|
|
|
1675
|
-
<a name="Sankey.
|
|
1678
|
+
<a name="Sankey.iterations" href="#Sankey.iterations">#</a> Sankey.**iterations**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L245)
|
|
1679
|
+
|
|
1680
|
+
A pass-through for the d3-sankey [iterations](https://github.com/d3/d3-sankey?tab=readme-ov-file#sankey_iterations) function.
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
<a name="Sankey.links" href="#Sankey.links">#</a> Sankey.**links**(*links*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L258)
|
|
1676
1687
|
|
|
1677
1688
|
A predefined *Array* of edges that connect each object passed to the [node](#Sankey.node) method. The `source` and `target` keys in each link need to map to the nodes in one of one way:
|
|
1678
1689
|
1. A *String* value matching the `id` of the node.
|
|
@@ -1683,7 +1694,15 @@ The value passed should be an *Array* of data. An optional formatting function c
|
|
|
1683
1694
|
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1684
1695
|
|
|
1685
1696
|
|
|
1686
|
-
<a name="Sankey.
|
|
1697
|
+
<a name="Sankey.linkSort" href="#Sankey.linkSort">#</a> Sankey.**linkSort**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L272)
|
|
1698
|
+
|
|
1699
|
+
A pass-through for the d3-sankey [linkSort](https://github.com/d3/d3-sankey?tab=readme-ov-file#sankey_linkSort) function.
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1703
|
+
|
|
1704
|
+
|
|
1705
|
+
<a name="Sankey.linksSource" href="#Sankey.linksSource">#</a> Sankey.**linksSource**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L282)
|
|
1687
1706
|
|
|
1688
1707
|
The key inside of each link Object that references the source node.
|
|
1689
1708
|
|
|
@@ -1691,7 +1710,7 @@ The key inside of each link Object that references the source node.
|
|
|
1691
1710
|
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1692
1711
|
|
|
1693
1712
|
|
|
1694
|
-
<a name="Sankey.linksTarget" href="#Sankey.linksTarget">#</a> Sankey.**linksTarget**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#
|
|
1713
|
+
<a name="Sankey.linksTarget" href="#Sankey.linksTarget">#</a> Sankey.**linksTarget**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L294)
|
|
1695
1714
|
|
|
1696
1715
|
The key inside of each link Object that references the target node.
|
|
1697
1716
|
|
|
@@ -1699,7 +1718,7 @@ The key inside of each link Object that references the target node.
|
|
|
1699
1718
|
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1700
1719
|
|
|
1701
1720
|
|
|
1702
|
-
<a name="Sankey.nodeAlign" href="#Sankey.nodeAlign">#</a> Sankey.**nodeAlign**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#
|
|
1721
|
+
<a name="Sankey.nodeAlign" href="#Sankey.nodeAlign">#</a> Sankey.**nodeAlign**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L306)
|
|
1703
1722
|
|
|
1704
1723
|
Sets the nodeAlign property of the sankey layout, which can either be "left", "right", "center", or "justify".
|
|
1705
1724
|
|
|
@@ -1707,7 +1726,7 @@ Sets the nodeAlign property of the sankey layout, which can either be "left", "r
|
|
|
1707
1726
|
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1708
1727
|
|
|
1709
1728
|
|
|
1710
|
-
<a name="Sankey.nodeId" href="#Sankey.nodeId">#</a> Sankey.**nodeId**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#
|
|
1729
|
+
<a name="Sankey.nodeId" href="#Sankey.nodeId">#</a> Sankey.**nodeId**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L319)
|
|
1711
1730
|
|
|
1712
1731
|
If *value* is specified, sets the node id accessor(s) to the specified array of values and returns the current class instance. If *value* is not specified, returns the current node group accessor.
|
|
1713
1732
|
|
|
@@ -1715,7 +1734,7 @@ If *value* is specified, sets the node id accessor(s) to the specified array of
|
|
|
1715
1734
|
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1716
1735
|
|
|
1717
1736
|
|
|
1718
|
-
<a name="Sankey.nodes" href="#Sankey.nodes">#</a> Sankey.**nodes**(*nodes*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#
|
|
1737
|
+
<a name="Sankey.nodes" href="#Sankey.nodes">#</a> Sankey.**nodes**(*nodes*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L333)
|
|
1719
1738
|
|
|
1720
1739
|
The list of nodes to be used for drawing the network. The value passed must be an *Array* of data.
|
|
1721
1740
|
|
|
@@ -1725,7 +1744,7 @@ Additionally, a custom formatting function can be passed as a second argument to
|
|
|
1725
1744
|
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1726
1745
|
|
|
1727
1746
|
|
|
1728
|
-
<a name="Sankey.nodePadding" href="#Sankey.nodePadding">#</a> Sankey.**nodePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#
|
|
1747
|
+
<a name="Sankey.nodePadding" href="#Sankey.nodePadding">#</a> Sankey.**nodePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L347)
|
|
1729
1748
|
|
|
1730
1749
|
If *value* is specified, sets the padding of the node and returns the current class instance. If *value* is not specified, returns the current nodePadding. By default, the nodePadding size is 8.
|
|
1731
1750
|
|
|
@@ -1733,7 +1752,15 @@ If *value* is specified, sets the padding of the node and returns the current cl
|
|
|
1733
1752
|
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1734
1753
|
|
|
1735
1754
|
|
|
1736
|
-
<a name="Sankey.
|
|
1755
|
+
<a name="Sankey.nodeSort" href="#Sankey.nodeSort">#</a> Sankey.**nodeSort**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L359)
|
|
1756
|
+
|
|
1757
|
+
A pass-through for the d3-sankey [nodeSort](https://github.com/d3/d3-sankey?tab=readme-ov-file#sankey_nodeSort) function.
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
<a name="Sankey.nodeWidth" href="#Sankey.nodeWidth">#</a> Sankey.**nodeWidth**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L369)
|
|
1737
1764
|
|
|
1738
1765
|
If *value* is specified, sets the width of the node and returns the current class instance. If *value* is not specified, returns the current nodeWidth. By default, the nodeWidth size is 30.
|
|
1739
1766
|
|
|
@@ -1741,7 +1768,7 @@ If *value* is specified, sets the width of the node and returns the current clas
|
|
|
1741
1768
|
This is a static method of [<code>Sankey</code>](#Sankey), and is chainable with other methods of this Class.
|
|
1742
1769
|
|
|
1743
1770
|
|
|
1744
|
-
<a name="Sankey.value" href="#Sankey.value">#</a> Sankey.**value**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#
|
|
1771
|
+
<a name="Sankey.value" href="#Sankey.value">#</a> Sankey.**value**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Sankey.js#L382)
|
|
1745
1772
|
|
|
1746
1773
|
If *value* is specified, sets the width of the links and returns the current class instance. If *value* is not specified, returns the current value accessor.
|
|
1747
1774
|
|
|
@@ -2738,7 +2765,7 @@ This is a static method of [<code>Viz</code>](#Viz), and is chainable with other
|
|
|
2738
2765
|
---
|
|
2739
2766
|
|
|
2740
2767
|
<a name="Axis"></a>
|
|
2741
|
-
#### **Axis** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2768
|
+
#### **Axis** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L175)
|
|
2742
2769
|
|
|
2743
2770
|
|
|
2744
2771
|
This is a global class, and extends all of the methods and functionality of [<code>BaseClass</code>](#BaseClass).
|
|
@@ -2796,7 +2823,7 @@ Creates an SVG scale based on an array of data.
|
|
|
2796
2823
|
|
|
2797
2824
|
|
|
2798
2825
|
|
|
2799
|
-
<a name="Axis.render" href="#Axis.render">#</a> Axis.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2826
|
+
<a name="Axis.render" href="#Axis.render">#</a> Axis.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L455)
|
|
2800
2827
|
|
|
2801
2828
|
Renders the current Axis to the page. If a *callback* is specified, it will be called once the legend is done drawing.
|
|
2802
2829
|
|
|
@@ -2804,7 +2831,7 @@ Renders the current Axis to the page. If a *callback* is specified, it will be c
|
|
|
2804
2831
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2805
2832
|
|
|
2806
2833
|
|
|
2807
|
-
<a name="Axis.align" href="#Axis.align">#</a> Axis.**align**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2834
|
+
<a name="Axis.align" href="#Axis.align">#</a> Axis.**align**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1370)
|
|
2808
2835
|
|
|
2809
2836
|
If *value* is specified, sets the horizontal alignment to the specified value and returns the current class instance.
|
|
2810
2837
|
|
|
@@ -2812,7 +2839,7 @@ If *value* is specified, sets the horizontal alignment to the specified value an
|
|
|
2812
2839
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2813
2840
|
|
|
2814
2841
|
|
|
2815
|
-
<a name="Axis.barConfig" href="#Axis.barConfig">#</a> Axis.**barConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2842
|
+
<a name="Axis.barConfig" href="#Axis.barConfig">#</a> Axis.**barConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1380)
|
|
2816
2843
|
|
|
2817
2844
|
If *value* is specified, sets the axis line style and returns the current class instance.
|
|
2818
2845
|
|
|
@@ -2820,7 +2847,7 @@ If *value* is specified, sets the axis line style and returns the current class
|
|
|
2820
2847
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2821
2848
|
|
|
2822
2849
|
|
|
2823
|
-
<a name="Axis.data" href="#Axis.data">#</a> Axis.**data**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2850
|
+
<a name="Axis.data" href="#Axis.data">#</a> Axis.**data**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1392)
|
|
2824
2851
|
|
|
2825
2852
|
An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.
|
|
2826
2853
|
|
|
@@ -2828,7 +2855,7 @@ An array of data points, which helps determine which ticks should be shown and w
|
|
|
2828
2855
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2829
2856
|
|
|
2830
2857
|
|
|
2831
|
-
<a name="Axis.domain" href="#Axis.domain">#</a> Axis.**domain**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2858
|
+
<a name="Axis.domain" href="#Axis.domain">#</a> Axis.**domain**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1402)
|
|
2832
2859
|
|
|
2833
2860
|
If *value* is specified, sets the scale domain of the axis and returns the current class instance.
|
|
2834
2861
|
|
|
@@ -2836,7 +2863,7 @@ If *value* is specified, sets the scale domain of the axis and returns the curre
|
|
|
2836
2863
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2837
2864
|
|
|
2838
2865
|
|
|
2839
|
-
<a name="Axis.duration" href="#Axis.duration">#</a> Axis.**duration**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2866
|
+
<a name="Axis.duration" href="#Axis.duration">#</a> Axis.**duration**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1412)
|
|
2840
2867
|
|
|
2841
2868
|
If *value* is specified, sets the transition duration of the axis and returns the current class instance.
|
|
2842
2869
|
|
|
@@ -2844,7 +2871,7 @@ If *value* is specified, sets the transition duration of the axis and returns th
|
|
|
2844
2871
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2845
2872
|
|
|
2846
2873
|
|
|
2847
|
-
<a name="Axis.grid" href="#Axis.grid">#</a> Axis.**grid**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2874
|
+
<a name="Axis.grid" href="#Axis.grid">#</a> Axis.**grid**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1422)
|
|
2848
2875
|
|
|
2849
2876
|
If *value* is specified, sets the grid values of the axis and returns the current class instance.
|
|
2850
2877
|
|
|
@@ -2852,7 +2879,7 @@ If *value* is specified, sets the grid values of the axis and returns the curren
|
|
|
2852
2879
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2853
2880
|
|
|
2854
2881
|
|
|
2855
|
-
<a name="Axis.gridConfig" href="#Axis.gridConfig">#</a> Axis.**gridConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2882
|
+
<a name="Axis.gridConfig" href="#Axis.gridConfig">#</a> Axis.**gridConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1432)
|
|
2856
2883
|
|
|
2857
2884
|
If *value* is specified, sets the grid config of the axis and returns the current class instance.
|
|
2858
2885
|
|
|
@@ -2860,7 +2887,7 @@ If *value* is specified, sets the grid config of the axis and returns the curren
|
|
|
2860
2887
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2861
2888
|
|
|
2862
2889
|
|
|
2863
|
-
<a name="Axis.gridLog" href="#Axis.gridLog">#</a> Axis.**gridLog**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2890
|
+
<a name="Axis.gridLog" href="#Axis.gridLog">#</a> Axis.**gridLog**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1444)
|
|
2864
2891
|
|
|
2865
2892
|
If *value* is specified, sets the grid behavior of the axis when scale is logarithmic and returns the current class instance.
|
|
2866
2893
|
|
|
@@ -2868,7 +2895,7 @@ If *value* is specified, sets the grid behavior of the axis when scale is logari
|
|
|
2868
2895
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2869
2896
|
|
|
2870
2897
|
|
|
2871
|
-
<a name="Axis.gridSize" href="#Axis.gridSize">#</a> Axis.**gridSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2898
|
+
<a name="Axis.gridSize" href="#Axis.gridSize">#</a> Axis.**gridSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1454)
|
|
2872
2899
|
|
|
2873
2900
|
If *value* is specified, sets the grid size of the axis and returns the current class instance.
|
|
2874
2901
|
|
|
@@ -2876,7 +2903,7 @@ If *value* is specified, sets the grid size of the axis and returns the current
|
|
|
2876
2903
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2877
2904
|
|
|
2878
2905
|
|
|
2879
|
-
<a name="Axis.height" href="#Axis.height">#</a> Axis.**height**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2906
|
+
<a name="Axis.height" href="#Axis.height">#</a> Axis.**height**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1464)
|
|
2880
2907
|
|
|
2881
2908
|
If *value* is specified, sets the overall height of the axis and returns the current class instance.
|
|
2882
2909
|
|
|
@@ -2884,7 +2911,7 @@ If *value* is specified, sets the overall height of the axis and returns the cur
|
|
|
2884
2911
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2885
2912
|
|
|
2886
2913
|
|
|
2887
|
-
<a name="Axis.labels" href="#Axis.labels">#</a> Axis.**labels**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2914
|
+
<a name="Axis.labels" href="#Axis.labels">#</a> Axis.**labels**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1474)
|
|
2888
2915
|
|
|
2889
2916
|
If *value* is specified, sets the visible tick labels of the axis and returns the current class instance.
|
|
2890
2917
|
|
|
@@ -2892,7 +2919,7 @@ If *value* is specified, sets the visible tick labels of the axis and returns th
|
|
|
2892
2919
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2893
2920
|
|
|
2894
2921
|
|
|
2895
|
-
<a name="Axis.labelOffset" href="#Axis.labelOffset">#</a> Axis.**labelOffset**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2922
|
+
<a name="Axis.labelOffset" href="#Axis.labelOffset">#</a> Axis.**labelOffset**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1484)
|
|
2896
2923
|
|
|
2897
2924
|
If *value* is specified, sets whether offsets will be used to position some labels further away from the axis in order to allow space for the text.
|
|
2898
2925
|
|
|
@@ -2900,7 +2927,7 @@ If *value* is specified, sets whether offsets will be used to position some labe
|
|
|
2900
2927
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2901
2928
|
|
|
2902
2929
|
|
|
2903
|
-
<a name="Axis.labelRotation" href="#Axis.labelRotation">#</a> Axis.**labelRotation**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2930
|
+
<a name="Axis.labelRotation" href="#Axis.labelRotation">#</a> Axis.**labelRotation**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1496)
|
|
2904
2931
|
|
|
2905
2932
|
If *value* is specified, sets whether whether horizontal axis labels are rotated -90 degrees.
|
|
2906
2933
|
|
|
@@ -2908,7 +2935,7 @@ If *value* is specified, sets whether whether horizontal axis labels are rotated
|
|
|
2908
2935
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2909
2936
|
|
|
2910
2937
|
|
|
2911
|
-
<a name="Axis.maxSize" href="#Axis.maxSize">#</a> Axis.**maxSize**(_) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2938
|
+
<a name="Axis.maxSize" href="#Axis.maxSize">#</a> Axis.**maxSize**(_) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1508)
|
|
2912
2939
|
|
|
2913
2940
|
If *value* is specified, sets the maximum size allowed for the space that contains the axis tick labels and title.
|
|
2914
2941
|
|
|
@@ -2916,7 +2943,7 @@ If *value* is specified, sets the maximum size allowed for the space that contai
|
|
|
2916
2943
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2917
2944
|
|
|
2918
2945
|
|
|
2919
|
-
<a name="Axis.minSize" href="#Axis.minSize">#</a> Axis.**minSize**(_) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2946
|
+
<a name="Axis.minSize" href="#Axis.minSize">#</a> Axis.**minSize**(_) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1518)
|
|
2920
2947
|
|
|
2921
2948
|
If *value* is specified, sets the minimum size alloted for the space that contains the axis tick labels and title.
|
|
2922
2949
|
|
|
@@ -2924,7 +2951,7 @@ If *value* is specified, sets the minimum size alloted for the space that contai
|
|
|
2924
2951
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2925
2952
|
|
|
2926
2953
|
|
|
2927
|
-
<a name="Axis.orient" href="#Axis.orient">#</a> Axis.**orient**([*orient*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2954
|
+
<a name="Axis.orient" href="#Axis.orient">#</a> Axis.**orient**([*orient*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1528)
|
|
2928
2955
|
|
|
2929
2956
|
If *orient* is specified, sets the orientation of the shape and returns the current class instance. If *orient* is not specified, returns the current orientation.
|
|
2930
2957
|
|
|
@@ -2932,7 +2959,7 @@ If *orient* is specified, sets the orientation of the shape and returns the curr
|
|
|
2932
2959
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2933
2960
|
|
|
2934
2961
|
|
|
2935
|
-
<a name="Axis.outerBounds" href="#Axis.outerBounds">#</a> Axis.**outerBounds**() [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2962
|
+
<a name="Axis.outerBounds" href="#Axis.outerBounds">#</a> Axis.**outerBounds**() [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1553)
|
|
2936
2963
|
|
|
2937
2964
|
If called after the elements have been drawn to DOM, will returns the outer bounds of the axis content.
|
|
2938
2965
|
|
|
@@ -2945,7 +2972,7 @@ This is a static method of [<code>Axis</code>](#Axis)
|
|
|
2945
2972
|
```
|
|
2946
2973
|
|
|
2947
2974
|
|
|
2948
|
-
<a name="Axis.padding" href="#Axis.padding">#</a> Axis.**padding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2975
|
+
<a name="Axis.padding" href="#Axis.padding">#</a> Axis.**padding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1563)
|
|
2949
2976
|
|
|
2950
2977
|
If *value* is specified, sets the padding between each tick label to the specified number and returns the current class instance.
|
|
2951
2978
|
|
|
@@ -2953,7 +2980,7 @@ If *value* is specified, sets the padding between each tick label to the specifi
|
|
|
2953
2980
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2954
2981
|
|
|
2955
2982
|
|
|
2956
|
-
<a name="Axis.paddingInner" href="#Axis.paddingInner">#</a> Axis.**paddingInner**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2983
|
+
<a name="Axis.paddingInner" href="#Axis.paddingInner">#</a> Axis.**paddingInner**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1573)
|
|
2957
2984
|
|
|
2958
2985
|
If *value* is specified, sets the inner padding of band scale to the specified number and returns the current class instance.
|
|
2959
2986
|
|
|
@@ -2961,7 +2988,7 @@ If *value* is specified, sets the inner padding of band scale to the specified n
|
|
|
2961
2988
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2962
2989
|
|
|
2963
2990
|
|
|
2964
|
-
<a name="Axis.paddingOuter" href="#Axis.paddingOuter">#</a> Axis.**paddingOuter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2991
|
+
<a name="Axis.paddingOuter" href="#Axis.paddingOuter">#</a> Axis.**paddingOuter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1585)
|
|
2965
2992
|
|
|
2966
2993
|
If *value* is specified, sets the outer padding of band scales to the specified number and returns the current class instance.
|
|
2967
2994
|
|
|
@@ -2969,7 +2996,7 @@ If *value* is specified, sets the outer padding of band scales to the specified
|
|
|
2969
2996
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2970
2997
|
|
|
2971
2998
|
|
|
2972
|
-
<a name="Axis.range" href="#Axis.range">#</a> Axis.**range**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2999
|
+
<a name="Axis.range" href="#Axis.range">#</a> Axis.**range**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1597)
|
|
2973
3000
|
|
|
2974
3001
|
If *value* is specified, sets the scale range (in pixels) of the axis and returns the current class instance. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.
|
|
2975
3002
|
|
|
@@ -2977,7 +3004,7 @@ If *value* is specified, sets the scale range (in pixels) of the axis and return
|
|
|
2977
3004
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2978
3005
|
|
|
2979
3006
|
|
|
2980
|
-
<a name="Axis.rounding" href="#Axis.rounding">#</a> Axis.**rounding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3007
|
+
<a name="Axis.rounding" href="#Axis.rounding">#</a> Axis.**rounding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1607)
|
|
2981
3008
|
|
|
2982
3009
|
Sets the rounding method, so that more evenly spaced ticks appear at the extents of the scale. Can be set to "none" (default), "outside", or "inside".
|
|
2983
3010
|
|
|
@@ -2985,7 +3012,7 @@ Sets the rounding method, so that more evenly spaced ticks appear at the extents
|
|
|
2985
3012
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2986
3013
|
|
|
2987
3014
|
|
|
2988
|
-
<a name="Axis.roundingInsideMinPrefix" href="#Axis.roundingInsideMinPrefix">#</a> Axis.**roundingInsideMinPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3015
|
+
<a name="Axis.roundingInsideMinPrefix" href="#Axis.roundingInsideMinPrefix">#</a> Axis.**roundingInsideMinPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1617)
|
|
2989
3016
|
|
|
2990
3017
|
Sets the prefix used for the minimum value of "inside" rounding scales.
|
|
2991
3018
|
|
|
@@ -2993,7 +3020,7 @@ Sets the prefix used for the minimum value of "inside" rounding scales.
|
|
|
2993
3020
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2994
3021
|
|
|
2995
3022
|
|
|
2996
|
-
<a name="Axis.roundingInsideMinSuffix" href="#Axis.roundingInsideMinSuffix">#</a> Axis.**roundingInsideMinSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3023
|
+
<a name="Axis.roundingInsideMinSuffix" href="#Axis.roundingInsideMinSuffix">#</a> Axis.**roundingInsideMinSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1629)
|
|
2997
3024
|
|
|
2998
3025
|
Sets the suffix used for the minimum value of "inside" rounding scales.
|
|
2999
3026
|
|
|
@@ -3001,7 +3028,7 @@ Sets the suffix used for the minimum value of "inside" rounding scales.
|
|
|
3001
3028
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3002
3029
|
|
|
3003
3030
|
|
|
3004
|
-
<a name="Axis.roundingInsideMaxPrefix" href="#Axis.roundingInsideMaxPrefix">#</a> Axis.**roundingInsideMaxPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3031
|
+
<a name="Axis.roundingInsideMaxPrefix" href="#Axis.roundingInsideMaxPrefix">#</a> Axis.**roundingInsideMaxPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1641)
|
|
3005
3032
|
|
|
3006
3033
|
Sets the prefix used for the maximum value of "inside" rounding scales.
|
|
3007
3034
|
|
|
@@ -3009,7 +3036,7 @@ Sets the prefix used for the maximum value of "inside" rounding scales.
|
|
|
3009
3036
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3010
3037
|
|
|
3011
3038
|
|
|
3012
|
-
<a name="Axis.roundingInsideMaxSuffix" href="#Axis.roundingInsideMaxSuffix">#</a> Axis.**roundingInsideMaxSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3039
|
+
<a name="Axis.roundingInsideMaxSuffix" href="#Axis.roundingInsideMaxSuffix">#</a> Axis.**roundingInsideMaxSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1653)
|
|
3013
3040
|
|
|
3014
3041
|
Sets the suffix used for the maximum value of "inside" rounding scales.
|
|
3015
3042
|
|
|
@@ -3017,7 +3044,7 @@ Sets the suffix used for the maximum value of "inside" rounding scales.
|
|
|
3017
3044
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3018
3045
|
|
|
3019
3046
|
|
|
3020
|
-
<a name="Axis.scale" href="#Axis.scale">#</a> Axis.**scale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3047
|
+
<a name="Axis.scale" href="#Axis.scale">#</a> Axis.**scale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1665)
|
|
3021
3048
|
|
|
3022
3049
|
If *value* is specified, sets the scale of the axis and returns the current class instance.
|
|
3023
3050
|
|
|
@@ -3025,7 +3052,7 @@ If *value* is specified, sets the scale of the axis and returns the current clas
|
|
|
3025
3052
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3026
3053
|
|
|
3027
3054
|
|
|
3028
|
-
<a name="Axis.scalePadding" href="#Axis.scalePadding">#</a> Axis.**scalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3055
|
+
<a name="Axis.scalePadding" href="#Axis.scalePadding">#</a> Axis.**scalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1675)
|
|
3029
3056
|
|
|
3030
3057
|
Sets the "padding" property of the scale, often used in point scales.
|
|
3031
3058
|
|
|
@@ -3033,7 +3060,7 @@ Sets the "padding" property of the scale, often used in point scales.
|
|
|
3033
3060
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3034
3061
|
|
|
3035
3062
|
|
|
3036
|
-
<a name="Axis.select" href="#Axis.select">#</a> Axis.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3063
|
+
<a name="Axis.select" href="#Axis.select">#</a> Axis.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1687)
|
|
3037
3064
|
|
|
3038
3065
|
If *selector* is specified, sets the SVG container element to the specified d3 selector or DOM element and returns the current class instance. If *selector* is not specified, returns the current SVG container element.
|
|
3039
3066
|
|
|
@@ -3041,7 +3068,7 @@ If *selector* is specified, sets the SVG container element to the specified d3 s
|
|
|
3041
3068
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3042
3069
|
|
|
3043
3070
|
|
|
3044
|
-
<a name="Axis.shape" href="#Axis.shape">#</a> Axis.**shape**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3071
|
+
<a name="Axis.shape" href="#Axis.shape">#</a> Axis.**shape**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1697)
|
|
3045
3072
|
|
|
3046
3073
|
If *value* is specified, sets the tick shape constructor and returns the current class instance.
|
|
3047
3074
|
|
|
@@ -3049,7 +3076,7 @@ If *value* is specified, sets the tick shape constructor and returns the current
|
|
|
3049
3076
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3050
3077
|
|
|
3051
3078
|
|
|
3052
|
-
<a name="Axis.shapeConfig" href="#Axis.shapeConfig">#</a> Axis.**shapeConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3079
|
+
<a name="Axis.shapeConfig" href="#Axis.shapeConfig">#</a> Axis.**shapeConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1707)
|
|
3053
3080
|
|
|
3054
3081
|
If *value* is specified, sets the tick style of the axis and returns the current class instance.
|
|
3055
3082
|
|
|
@@ -3057,7 +3084,7 @@ If *value* is specified, sets the tick style of the axis and returns the current
|
|
|
3057
3084
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3058
3085
|
|
|
3059
3086
|
|
|
3060
|
-
<a name="Axis.tickFormat" href="#Axis.tickFormat">#</a> Axis.**tickFormat**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3087
|
+
<a name="Axis.tickFormat" href="#Axis.tickFormat">#</a> Axis.**tickFormat**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1719)
|
|
3061
3088
|
|
|
3062
3089
|
If *value* is specified, sets the tick formatter and returns the current class instance.
|
|
3063
3090
|
|
|
@@ -3065,7 +3092,7 @@ If *value* is specified, sets the tick formatter and returns the current class i
|
|
|
3065
3092
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3066
3093
|
|
|
3067
3094
|
|
|
3068
|
-
<a name="Axis.ticks" href="#Axis.ticks">#</a> Axis.**ticks**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3095
|
+
<a name="Axis.ticks" href="#Axis.ticks">#</a> Axis.**ticks**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1729)
|
|
3069
3096
|
|
|
3070
3097
|
If *value* is specified, sets the tick values of the axis and returns the current class instance.
|
|
3071
3098
|
|
|
@@ -3073,7 +3100,7 @@ If *value* is specified, sets the tick values of the axis and returns the curren
|
|
|
3073
3100
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3074
3101
|
|
|
3075
3102
|
|
|
3076
|
-
<a name="Axis.tickSize" href="#Axis.tickSize">#</a> Axis.**tickSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3103
|
+
<a name="Axis.tickSize" href="#Axis.tickSize">#</a> Axis.**tickSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1739)
|
|
3077
3104
|
|
|
3078
3105
|
If *value* is specified, sets the tick size of the axis and returns the current class instance.
|
|
3079
3106
|
|
|
@@ -3081,7 +3108,7 @@ If *value* is specified, sets the tick size of the axis and returns the current
|
|
|
3081
3108
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3082
3109
|
|
|
3083
3110
|
|
|
3084
|
-
<a name="Axis.tickSuffix" href="#Axis.tickSuffix">#</a> Axis.**tickSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3111
|
+
<a name="Axis.tickSuffix" href="#Axis.tickSuffix">#</a> Axis.**tickSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1749)
|
|
3085
3112
|
|
|
3086
3113
|
Sets the behavior of the abbreviations when you are using linear scale. This method accepts two options: "normal" (uses formatAbbreviate to determinate the abbreviation) and "smallest" (uses suffix from the smallest tick as reference in every tick).
|
|
3087
3114
|
|
|
@@ -3089,7 +3116,7 @@ Sets the behavior of the abbreviations when you are using linear scale. This met
|
|
|
3089
3116
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3090
3117
|
|
|
3091
3118
|
|
|
3092
|
-
<a name="Axis.timeLocale" href="#Axis.timeLocale">#</a> Axis.**timeLocale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3119
|
+
<a name="Axis.timeLocale" href="#Axis.timeLocale">#</a> Axis.**timeLocale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1759)
|
|
3093
3120
|
|
|
3094
3121
|
Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).
|
|
3095
3122
|
|
|
@@ -3097,7 +3124,7 @@ Defines a custom locale object to be used in time scale. This object must includ
|
|
|
3097
3124
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3098
3125
|
|
|
3099
3126
|
|
|
3100
|
-
<a name="Axis.title" href="#Axis.title">#</a> Axis.**title**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3127
|
+
<a name="Axis.title" href="#Axis.title">#</a> Axis.**title**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1769)
|
|
3101
3128
|
|
|
3102
3129
|
If *value* is specified, sets the title of the axis and returns the current class instance.
|
|
3103
3130
|
|
|
@@ -3105,7 +3132,7 @@ If *value* is specified, sets the title of the axis and returns the current clas
|
|
|
3105
3132
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3106
3133
|
|
|
3107
3134
|
|
|
3108
|
-
<a name="Axis.titleConfig" href="#Axis.titleConfig">#</a> Axis.**titleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3135
|
+
<a name="Axis.titleConfig" href="#Axis.titleConfig">#</a> Axis.**titleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1779)
|
|
3109
3136
|
|
|
3110
3137
|
If *value* is specified, sets the title configuration of the axis and returns the current class instance.
|
|
3111
3138
|
|
|
@@ -3113,7 +3140,7 @@ If *value* is specified, sets the title configuration of the axis and returns th
|
|
|
3113
3140
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3114
3141
|
|
|
3115
3142
|
|
|
3116
|
-
<a name="Axis.width" href="#Axis.width">#</a> Axis.**width**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3143
|
+
<a name="Axis.width" href="#Axis.width">#</a> Axis.**width**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1791)
|
|
3117
3144
|
|
|
3118
3145
|
If *value* is specified, sets the overall width of the axis and returns the current class instance.
|
|
3119
3146
|
|
package/es/src/charts/Sankey.js
CHANGED
|
@@ -115,8 +115,11 @@ var Sankey = /*#__PURE__*/ function(Viz) {
|
|
|
115
115
|
_class_call_check(this, Sankey);
|
|
116
116
|
var _this;
|
|
117
117
|
_this = _call_super(this, Sankey);
|
|
118
|
+
_this._iterations = 6;
|
|
118
119
|
_this._nodeId = accessor("id");
|
|
120
|
+
_this._nodeSort = undefined;
|
|
119
121
|
_this._links = accessor("links");
|
|
122
|
+
_this._linkSort = undefined;
|
|
120
123
|
_this._linksSource = "source";
|
|
121
124
|
_this._linksTarget = "target";
|
|
122
125
|
_this._noDataMessage = false;
|
|
@@ -235,7 +238,7 @@ var Sankey = /*#__PURE__*/ function(Viz) {
|
|
|
235
238
|
return obj;
|
|
236
239
|
}, {});
|
|
237
240
|
var transform = "translate(".concat(this._margin.left, ", ").concat(this._margin.top, ")");
|
|
238
|
-
this._sankey.nodeAlign(this._nodeAlign).nodePadding(this._nodePadding).nodeWidth(this._nodeWidth).nodes(nodes).links(links).size([
|
|
241
|
+
this._sankey.nodeAlign(this._nodeAlign).nodePadding(this._nodePadding).nodeWidth(this._nodeWidth).nodes(nodes).nodeSort(this._nodeSort).links(links).linkSort(this._linkSort).iterations(this._iterations).size([
|
|
239
242
|
width,
|
|
240
243
|
height
|
|
241
244
|
])();
|
|
@@ -291,6 +294,17 @@ var Sankey = /*#__PURE__*/ function(Viz) {
|
|
|
291
294
|
{
|
|
292
295
|
/**
|
|
293
296
|
@memberof Sankey
|
|
297
|
+
@desc A pass-through for the d3-sankey [iterations](https://github.com/d3/d3-sankey?tab=readme-ov-file#sankey_iterations) function.
|
|
298
|
+
@param {Number} [*value* = 6]
|
|
299
|
+
@chainable
|
|
300
|
+
*/ key: "iterations",
|
|
301
|
+
value: function iterations(_) {
|
|
302
|
+
return arguments.length ? (this._iterations = _, this) : this._iterations;
|
|
303
|
+
}
|
|
304
|
+
},
|
|
305
|
+
{
|
|
306
|
+
/**
|
|
307
|
+
@memberof Sankey
|
|
294
308
|
@desc A predefined *Array* of edges that connect each object passed to the [node](#Sankey.node) method. The `source` and `target` keys in each link need to map to the nodes in one of one way:
|
|
295
309
|
1. A *String* value matching the `id` of the node.
|
|
296
310
|
|
|
@@ -309,6 +323,17 @@ The value passed should be an *Array* of data. An optional formatting function c
|
|
|
309
323
|
{
|
|
310
324
|
/**
|
|
311
325
|
@memberof Sankey
|
|
326
|
+
@desc A pass-through for the d3-sankey [linkSort](https://github.com/d3/d3-sankey?tab=readme-ov-file#sankey_linkSort) function.
|
|
327
|
+
@param {Function|undefined} [*value* = undefined]
|
|
328
|
+
@chainable
|
|
329
|
+
*/ key: "linkSort",
|
|
330
|
+
value: function linkSort(_) {
|
|
331
|
+
return arguments.length ? (this._linkSort = _, this) : this._linkSort;
|
|
332
|
+
}
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
/**
|
|
336
|
+
@memberof Sankey
|
|
312
337
|
@desc The key inside of each link Object that references the source node.
|
|
313
338
|
@param {String} [*value* = "source"]
|
|
314
339
|
@chainable
|
|
@@ -381,6 +406,17 @@ Additionally, a custom formatting function can be passed as a second argument to
|
|
|
381
406
|
{
|
|
382
407
|
/**
|
|
383
408
|
@memberof Sankey
|
|
409
|
+
@desc A pass-through for the d3-sankey [nodeSort](https://github.com/d3/d3-sankey?tab=readme-ov-file#sankey_nodeSort) function.
|
|
410
|
+
@param {Function|undefined} [*value* = undefined]
|
|
411
|
+
@chainable
|
|
412
|
+
*/ key: "nodeSort",
|
|
413
|
+
value: function nodeSort(_) {
|
|
414
|
+
return arguments.length ? (this._nodeSort = _, this) : this._nodeSort;
|
|
415
|
+
}
|
|
416
|
+
},
|
|
417
|
+
{
|
|
418
|
+
/**
|
|
419
|
+
@memberof Sankey
|
|
384
420
|
@desc If *value* is specified, sets the width of the node and returns the current class instance. If *value* is not specified, returns the current nodeWidth. By default, the nodeWidth size is 30.
|
|
385
421
|
@param {Number} [*value* = 30]
|
|
386
422
|
@chainable
|