@d3plus/core 3.0.0-alpha.2 → 3.0.0-alpha.3
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 +183 -240
- package/es/src/charts/AreaPlot.js +0 -1
- package/es/src/charts/BarChart.js +0 -1
- package/es/src/charts/BoxWhisker.js +0 -1
- package/es/src/charts/BumpChart.js +0 -2
- package/es/src/charts/LinePlot.js +0 -1
- package/es/src/charts/Pack.js +7 -6
- package/es/src/charts/Plot.js +12 -21
- package/es/src/charts/Viz.js +3 -0
- package/es/src/components/Tooltip.js +1 -1
- package/es/src/shapes/Shape.js +30 -3
- package/package.json +8 -8
- package/umd/d3plus-core.full.js +56 -53
- package/umd/d3plus-core.full.js.map +1 -1
- package/umd/d3plus-core.full.min.js +445 -449
- package/umd/d3plus-core.js +54 -34
- package/umd/d3plus-core.js.map +1 -1
- package/umd/d3plus-core.min.js +125 -121
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ import modules from "@d3plus/core";
|
|
|
13
13
|
In vanilla JavaScript, a `d3plus` global is exported from the pre-bundled version:
|
|
14
14
|
|
|
15
15
|
```html
|
|
16
|
-
<script src="https://cdn.jsdelivr.net/npm/@d3plus/core@3.0.0-alpha.
|
|
16
|
+
<script src="https://cdn.jsdelivr.net/npm/@d3plus/core@3.0.0-alpha.3"></script>
|
|
17
17
|
<script>
|
|
18
18
|
console.log(d3plus);
|
|
19
19
|
</script>
|
|
@@ -70,10 +70,6 @@ Live examples can be found on [d3plus.org](https://d3plus.org/), which includes
|
|
|
70
70
|
* [BaseClass](#BaseClass) - An abstract class that contains some global methods and functionality.
|
|
71
71
|
|
|
72
72
|
#####
|
|
73
|
-
* [defaultPadding](#defaultPadding) - Default padding logic that will return false if the screen is less than 600 pixels wide.
|
|
74
|
-
* [listify](#listify) - Turns an array of values into a list string.
|
|
75
|
-
* [_thresholdFunction](#_thresholdFunction) - Applies the threshold algorithm according to the type of chart used.
|
|
76
|
-
* [generateReference](#generateReference) - Creates a reference element for popper.
|
|
77
73
|
* [accessor](#accessor) - Wraps an object key in a simple accessor function.
|
|
78
74
|
* [configPrep](#configPrep) - Preps a config object for d3plus data, and optionally bubbles up a specific nested type. When using this function, you must bind a d3plus class' `this` context.
|
|
79
75
|
* [constant](#constant) - Wraps non-function variables in a simple return function.
|
|
@@ -109,7 +105,7 @@ new d3plus.Plot()
|
|
|
109
105
|
---
|
|
110
106
|
|
|
111
107
|
<a name="BarChart"></a>
|
|
112
|
-
#### **BarChart** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/BarChart.js#
|
|
108
|
+
#### **BarChart** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/BarChart.js#L4)
|
|
113
109
|
|
|
114
110
|
|
|
115
111
|
This is a global class, and extends all of the methods and functionality of [<code>Plot</code>](#Plot).
|
|
@@ -174,7 +170,6 @@ the equivalent of calling:
|
|
|
174
170
|
new d3plus.Plot()
|
|
175
171
|
.discrete("x")
|
|
176
172
|
.shape("Line")
|
|
177
|
-
.x("x")
|
|
178
173
|
.y2(d => this._y(d))
|
|
179
174
|
.yConfig({
|
|
180
175
|
tickFormat: val => {
|
|
@@ -755,7 +750,7 @@ Uses the [d3 pack layout](https://github.com/d3/d3-hierarchy#pack) to creates Ci
|
|
|
755
750
|
|
|
756
751
|
|
|
757
752
|
|
|
758
|
-
<a name="Pack.hover" href="#Pack.hover">#</a> Pack.**hover**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#
|
|
753
|
+
<a name="Pack.hover" href="#Pack.hover">#</a> Pack.**hover**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#L144)
|
|
759
754
|
|
|
760
755
|
If *value* is specified, sets the hover method to the specified function and returns the current class instance.
|
|
761
756
|
|
|
@@ -763,7 +758,7 @@ If *value* is specified, sets the hover method to the specified function and ret
|
|
|
763
758
|
This is a static method of [<code>Pack</code>](#Pack), and is chainable with other methods of this Class.
|
|
764
759
|
|
|
765
760
|
|
|
766
|
-
<a name="Pack.layoutPadding" href="#Pack.layoutPadding">#</a> Pack.**layoutPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#
|
|
761
|
+
<a name="Pack.layoutPadding" href="#Pack.layoutPadding">#</a> Pack.**layoutPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#L157)
|
|
767
762
|
|
|
768
763
|
If *value* is specified, sets the opacity accessor to the specified function or number and returns the current class instance. If *value* is not specified, returns the current pack opacity accessor.
|
|
769
764
|
|
|
@@ -771,7 +766,7 @@ If *value* is specified, sets the opacity accessor to the specified function or
|
|
|
771
766
|
This is a static method of [<code>Pack</code>](#Pack)
|
|
772
767
|
|
|
773
768
|
|
|
774
|
-
<a name="Pack.packOpacity" href="#Pack.packOpacity">#</a> Pack.**packOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#
|
|
769
|
+
<a name="Pack.packOpacity" href="#Pack.packOpacity">#</a> Pack.**packOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#L166)
|
|
775
770
|
|
|
776
771
|
If *value* is specified, sets the padding accessor to the specified function or number and returns the current class instance. If *value* is not specified, returns the current pack opacity accessor.
|
|
777
772
|
|
|
@@ -779,7 +774,7 @@ If *value* is specified, sets the padding accessor to the specified function or
|
|
|
779
774
|
This is a static method of [<code>Pack</code>](#Pack)
|
|
780
775
|
|
|
781
776
|
|
|
782
|
-
<a name="Pack.sort" href="#Pack.sort">#</a> Pack.**sort**([*comparator*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#
|
|
777
|
+
<a name="Pack.sort" href="#Pack.sort">#</a> Pack.**sort**([*comparator*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#L179)
|
|
783
778
|
|
|
784
779
|
If *comparator* is specified, sets the sort order for the pack using the specified comparator function. If *comparator* is not specified, returns the current group sort order, which defaults to descending order by the associated input data's numeric value attribute.
|
|
785
780
|
|
|
@@ -794,7 +789,7 @@ function comparator(a, b) {
|
|
|
794
789
|
```
|
|
795
790
|
|
|
796
791
|
|
|
797
|
-
<a name="Pack.sum" href="#Pack.sum">#</a> Pack.**sum**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#
|
|
792
|
+
<a name="Pack.sum" href="#Pack.sum">#</a> Pack.**sum**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack.js#L193)
|
|
798
793
|
|
|
799
794
|
If *value* is specified, sets the sum accessor to the specified function or number and returns the current class instance. If *value* is not specified, returns the current sum accessor.
|
|
800
795
|
|
|
@@ -898,7 +893,6 @@ This is a global class, and extends all of the methods and functionality of [<co
|
|
|
898
893
|
* [.buffer([*value*])](#Plot.buffer) ↩︎
|
|
899
894
|
* [.confidence(*value*)](#Plot.confidence) ↩︎
|
|
900
895
|
* [.confidenceConfig([*value*])](#Plot.confidenceConfig) ↩︎
|
|
901
|
-
* [.discrete(*value*)](#Plot.discrete) ↩︎
|
|
902
896
|
* [.discreteCutoff(*value*)](#Plot.discreteCutoff) ↩︎
|
|
903
897
|
* [.groupPadding([*value*])](#Plot.groupPadding) ↩︎
|
|
904
898
|
* [.labelConnectorConfig([*value*])](#Plot.labelConnectorConfig) ↩︎
|
|
@@ -941,7 +935,7 @@ Creates an x/y plot based on an array of data.
|
|
|
941
935
|
|
|
942
936
|
|
|
943
937
|
|
|
944
|
-
<a name="Plot.annotations" href="#Plot.annotations">#</a> Plot.**annotations**(*annotations*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
938
|
+
<a name="Plot.annotations" href="#Plot.annotations">#</a> Plot.**annotations**(*annotations*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1484)
|
|
945
939
|
|
|
946
940
|
Allows drawing custom shapes to be used as annotations in the provided x/y plot. This method accepts custom config objects for the [Shape](http://d3plus.org/docs/#Shape) class, either a single config object or an array of config objects. Each config object requires an additional parameter, the "shape", which denotes which [Shape](http://d3plus.org/docs/#Shape) sub-class to use ([Rect](http://d3plus.org/docs/#Rect), [Line](http://d3plus.org/docs/#Line), etc).
|
|
947
941
|
|
|
@@ -951,7 +945,7 @@ Additionally, each config object can also contain an optional "layer" key, which
|
|
|
951
945
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
952
946
|
|
|
953
947
|
|
|
954
|
-
<a name="Plot.axisPersist" href="#Plot.axisPersist">#</a> Plot.**axisPersist**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
948
|
+
<a name="Plot.axisPersist" href="#Plot.axisPersist">#</a> Plot.**axisPersist**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1494)
|
|
955
949
|
|
|
956
950
|
Determines whether the x and y axes should have their scales persist while users filter the data, the timeline being the prime example (set this to `true` to make the axes stay consistent when the timeline changes).
|
|
957
951
|
|
|
@@ -959,7 +953,7 @@ Determines whether the x and y axes should have their scales persist while users
|
|
|
959
953
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
960
954
|
|
|
961
955
|
|
|
962
|
-
<a name="Plot.backgroundConfig" href="#Plot.backgroundConfig">#</a> Plot.**backgroundConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
956
|
+
<a name="Plot.backgroundConfig" href="#Plot.backgroundConfig">#</a> Plot.**backgroundConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1504)
|
|
963
957
|
|
|
964
958
|
A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).
|
|
965
959
|
|
|
@@ -967,7 +961,7 @@ A d3plus-shape configuration Object used for styling the background rectangle of
|
|
|
967
961
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
968
962
|
|
|
969
963
|
|
|
970
|
-
<a name="Plot.barPadding" href="#Plot.barPadding">#</a> Plot.**barPadding**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
964
|
+
<a name="Plot.barPadding" href="#Plot.barPadding">#</a> Plot.**barPadding**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1514)
|
|
971
965
|
|
|
972
966
|
Sets the pixel space between each bar in a group of bars.
|
|
973
967
|
|
|
@@ -975,7 +969,7 @@ Sets the pixel space between each bar in a group of bars.
|
|
|
975
969
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
976
970
|
|
|
977
971
|
|
|
978
|
-
<a name="Plot.baseline" href="#Plot.baseline">#</a> Plot.**baseline**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
972
|
+
<a name="Plot.baseline" href="#Plot.baseline">#</a> Plot.**baseline**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1524)
|
|
979
973
|
|
|
980
974
|
Sets the baseline for the x/y plot. If *value* is not specified, returns the current baseline.
|
|
981
975
|
|
|
@@ -983,7 +977,7 @@ Sets the baseline for the x/y plot. If *value* is not specified, returns the cur
|
|
|
983
977
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
984
978
|
|
|
985
979
|
|
|
986
|
-
<a name="Plot.buffer" href="#Plot.buffer">#</a> Plot.**buffer**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
980
|
+
<a name="Plot.buffer" href="#Plot.buffer">#</a> Plot.**buffer**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1534)
|
|
987
981
|
|
|
988
982
|
Determines whether or not to add additional padding at the ends of x or y scales. The most commone use for this is in Scatter Plots, so that the shapes do not appear directly on the axis itself. The value provided can either be `true` or `false` to toggle the behavior for all shape types, or a keyed Object for each shape type (ie. `{Bar: false, Circle: true, Line: false}`).
|
|
989
983
|
|
|
@@ -991,7 +985,7 @@ Determines whether or not to add additional padding at the ends of x or y scales
|
|
|
991
985
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
992
986
|
|
|
993
987
|
|
|
994
|
-
<a name="Plot.confidence" href="#Plot.confidence">#</a> Plot.**confidence**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
988
|
+
<a name="Plot.confidence" href="#Plot.confidence">#</a> Plot.**confidence**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1563)
|
|
995
989
|
|
|
996
990
|
Sets the confidence to the specified array of lower and upper bounds.
|
|
997
991
|
|
|
@@ -1010,7 +1004,7 @@ Can be called with accessor functions or static keys:
|
|
|
1010
1004
|
```
|
|
1011
1005
|
|
|
1012
1006
|
|
|
1013
|
-
<a name="Plot.confidenceConfig" href="#Plot.confidenceConfig">#</a> Plot.**confidenceConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1007
|
+
<a name="Plot.confidenceConfig" href="#Plot.confidenceConfig">#</a> Plot.**confidenceConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1582)
|
|
1014
1008
|
|
|
1015
1009
|
If *value* is specified, sets the config method for each shape rendered as a confidence interval and returns the current class instance.
|
|
1016
1010
|
|
|
@@ -1018,15 +1012,7 @@ If *value* is specified, sets the config method for each shape rendered as a con
|
|
|
1018
1012
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1019
1013
|
|
|
1020
1014
|
|
|
1021
|
-
<a name="Plot.
|
|
1022
|
-
|
|
1023
|
-
Sets the discrete axis to the specified string. If *value* is not specified, returns the current discrete axis.
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
<a name="Plot.discreteCutoff" href="#Plot.discreteCutoff">#</a> Plot.**discreteCutoff**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1600)
|
|
1015
|
+
<a name="Plot.discreteCutoff" href="#Plot.discreteCutoff">#</a> Plot.**discreteCutoff**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1592)
|
|
1030
1016
|
|
|
1031
1017
|
When the width or height of the chart is less than or equal to this pixel value, the discrete axis will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.
|
|
1032
1018
|
|
|
@@ -1034,7 +1020,7 @@ When the width or height of the chart is less than or equal to this pixel value,
|
|
|
1034
1020
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1035
1021
|
|
|
1036
1022
|
|
|
1037
|
-
<a name="Plot.groupPadding" href="#Plot.groupPadding">#</a> Plot.**groupPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1023
|
+
<a name="Plot.groupPadding" href="#Plot.groupPadding">#</a> Plot.**groupPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1602)
|
|
1038
1024
|
|
|
1039
1025
|
Sets the pixel space between groups of bars.
|
|
1040
1026
|
|
|
@@ -1042,7 +1028,7 @@ Sets the pixel space between groups of bars.
|
|
|
1042
1028
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1043
1029
|
|
|
1044
1030
|
|
|
1045
|
-
<a name="Plot.labelConnectorConfig" href="#Plot.labelConnectorConfig">#</a> Plot.**labelConnectorConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1031
|
+
<a name="Plot.labelConnectorConfig" href="#Plot.labelConnectorConfig">#</a> Plot.**labelConnectorConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1612)
|
|
1046
1032
|
|
|
1047
1033
|
The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.
|
|
1048
1034
|
|
|
@@ -1050,7 +1036,7 @@ The d3plus-shape config used on the Line shapes created to connect lineLabels to
|
|
|
1050
1036
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1051
1037
|
|
|
1052
1038
|
|
|
1053
|
-
<a name="Plot.lineLabels" href="#Plot.lineLabels">#</a> Plot.**lineLabels**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1039
|
+
<a name="Plot.lineLabels" href="#Plot.lineLabels">#</a> Plot.**lineLabels**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1632)
|
|
1054
1040
|
|
|
1055
1041
|
Draws labels on the right side of any Line shapes that are drawn on the plot.
|
|
1056
1042
|
|
|
@@ -1058,7 +1044,7 @@ Draws labels on the right side of any Line shapes that are drawn on the plot.
|
|
|
1058
1044
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1059
1045
|
|
|
1060
1046
|
|
|
1061
|
-
<a name="Plot.lineMarkerConfig" href="#Plot.lineMarkerConfig">#</a> Plot.**lineMarkerConfig**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1047
|
+
<a name="Plot.lineMarkerConfig" href="#Plot.lineMarkerConfig">#</a> Plot.**lineMarkerConfig**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1642)
|
|
1062
1048
|
|
|
1063
1049
|
Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
1064
1050
|
|
|
@@ -1066,7 +1052,7 @@ Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
|
1066
1052
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1067
1053
|
|
|
1068
1054
|
|
|
1069
|
-
<a name="Plot.lineMarkers" href="#Plot.lineMarkers">#</a> Plot.**lineMarkers**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1055
|
+
<a name="Plot.lineMarkers" href="#Plot.lineMarkers">#</a> Plot.**lineMarkers**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1652)
|
|
1070
1056
|
|
|
1071
1057
|
Draws circle markers on each vertex of a Line.
|
|
1072
1058
|
|
|
@@ -1074,7 +1060,7 @@ Draws circle markers on each vertex of a Line.
|
|
|
1074
1060
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1075
1061
|
|
|
1076
1062
|
|
|
1077
|
-
<a name="Plot.shapeSort" href="#Plot.shapeSort">#</a> Plot.**shapeSort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1063
|
+
<a name="Plot.shapeSort" href="#Plot.shapeSort">#</a> Plot.**shapeSort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1662)
|
|
1078
1064
|
|
|
1079
1065
|
A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) that receives each shape Class (ie. "Circle", "Line", etc) as it's comparator arguments. Shapes are drawn in groups based on their type, so you are defining the layering order for all shapes of said type.
|
|
1080
1066
|
|
|
@@ -1082,7 +1068,7 @@ A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs
|
|
|
1082
1068
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1083
1069
|
|
|
1084
1070
|
|
|
1085
|
-
<a name="Plot.size" href="#Plot.size">#</a> Plot.**size**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1071
|
+
<a name="Plot.size" href="#Plot.size">#</a> Plot.**size**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1672)
|
|
1086
1072
|
|
|
1087
1073
|
Sets the size of bubbles to the given Number, data key, or function.
|
|
1088
1074
|
|
|
@@ -1090,7 +1076,7 @@ Sets the size of bubbles to the given Number, data key, or function.
|
|
|
1090
1076
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1091
1077
|
|
|
1092
1078
|
|
|
1093
|
-
<a name="Plot.sizeMax" href="#Plot.sizeMax">#</a> Plot.**sizeMax**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1079
|
+
<a name="Plot.sizeMax" href="#Plot.sizeMax">#</a> Plot.**sizeMax**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1682)
|
|
1094
1080
|
|
|
1095
1081
|
Sets the size scale maximum to the specified number.
|
|
1096
1082
|
|
|
@@ -1098,7 +1084,7 @@ Sets the size scale maximum to the specified number.
|
|
|
1098
1084
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1099
1085
|
|
|
1100
1086
|
|
|
1101
|
-
<a name="Plot.sizeMin" href="#Plot.sizeMin">#</a> Plot.**sizeMin**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1087
|
+
<a name="Plot.sizeMin" href="#Plot.sizeMin">#</a> Plot.**sizeMin**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1692)
|
|
1102
1088
|
|
|
1103
1089
|
Sets the size scale minimum to the specified number.
|
|
1104
1090
|
|
|
@@ -1106,7 +1092,7 @@ Sets the size scale minimum to the specified number.
|
|
|
1106
1092
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1107
1093
|
|
|
1108
1094
|
|
|
1109
|
-
<a name="Plot.sizeScale" href="#Plot.sizeScale">#</a> Plot.**sizeScale**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1095
|
+
<a name="Plot.sizeScale" href="#Plot.sizeScale">#</a> Plot.**sizeScale**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1702)
|
|
1110
1096
|
|
|
1111
1097
|
Sets the size scale to the specified string.
|
|
1112
1098
|
|
|
@@ -1114,7 +1100,7 @@ Sets the size scale to the specified string.
|
|
|
1114
1100
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1115
1101
|
|
|
1116
1102
|
|
|
1117
|
-
<a name="Plot.stacked" href="#Plot.stacked">#</a> Plot.**stacked**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1103
|
+
<a name="Plot.stacked" href="#Plot.stacked">#</a> Plot.**stacked**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1712)
|
|
1118
1104
|
|
|
1119
1105
|
If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.
|
|
1120
1106
|
|
|
@@ -1122,7 +1108,7 @@ If *value* is specified, toggles shape stacking. If *value* is not specified, re
|
|
|
1122
1108
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1123
1109
|
|
|
1124
1110
|
|
|
1125
|
-
<a name="Plot.stackOffset" href="#Plot.stackOffset">#</a> Plot.**stackOffset**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1111
|
+
<a name="Plot.stackOffset" href="#Plot.stackOffset">#</a> Plot.**stackOffset**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1722)
|
|
1126
1112
|
|
|
1127
1113
|
Sets the stack offset. If *value* is not specified, returns the current stack offset function.
|
|
1128
1114
|
|
|
@@ -1130,7 +1116,7 @@ Sets the stack offset. If *value* is not specified, returns the current stack of
|
|
|
1130
1116
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1131
1117
|
|
|
1132
1118
|
|
|
1133
|
-
<a name="Plot.stackOrder" href="#Plot.stackOrder">#</a> Plot.**stackOrder**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1119
|
+
<a name="Plot.stackOrder" href="#Plot.stackOrder">#</a> Plot.**stackOrder**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1732)
|
|
1134
1120
|
|
|
1135
1121
|
Sets the stack order. If *value* is not specified, returns the current stack order function.
|
|
1136
1122
|
|
|
@@ -1138,23 +1124,23 @@ Sets the stack order. If *value* is not specified, returns the current stack ord
|
|
|
1138
1124
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1139
1125
|
|
|
1140
1126
|
|
|
1141
|
-
<a name="Plot.x" href="#Plot.x">#</a> Plot.**x**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1127
|
+
<a name="Plot.x" href="#Plot.x">#</a> Plot.**x**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1747)
|
|
1142
1128
|
|
|
1143
|
-
Sets the x accessor to the specified
|
|
1129
|
+
Sets the x accessor to the specified accessor Function or String representing which key in the data to reference. If *value* is not specified, returns the current x accessor.
|
|
1144
1130
|
|
|
1145
1131
|
|
|
1146
1132
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1147
1133
|
|
|
1148
1134
|
|
|
1149
|
-
<a name="Plot.x2" href="#Plot.x2">#</a> Plot.**x2**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1135
|
+
<a name="Plot.x2" href="#Plot.x2">#</a> Plot.**x2**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1765)
|
|
1150
1136
|
|
|
1151
|
-
Sets the x2 accessor to the specified
|
|
1137
|
+
Sets the x2 accessor to the specified accessor Function or String representing which key in the data to reference. If *value* is not specified, returns the current x2 accessor.
|
|
1152
1138
|
|
|
1153
1139
|
|
|
1154
1140
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1155
1141
|
|
|
1156
1142
|
|
|
1157
|
-
<a name="Plot.xConfig" href="#Plot.xConfig">#</a> Plot.**xConfig**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1143
|
+
<a name="Plot.xConfig" href="#Plot.xConfig">#</a> Plot.**xConfig**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1783)
|
|
1158
1144
|
|
|
1159
1145
|
A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.
|
|
1160
1146
|
|
|
@@ -1162,7 +1148,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
1162
1148
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1163
1149
|
|
|
1164
1150
|
|
|
1165
|
-
<a name="Plot.xCutoff" href="#Plot.xCutoff">#</a> Plot.**xCutoff**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1151
|
+
<a name="Plot.xCutoff" href="#Plot.xCutoff">#</a> Plot.**xCutoff**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1793)
|
|
1166
1152
|
|
|
1167
1153
|
When the width of the chart is less than or equal to this pixel value, and the x-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.
|
|
1168
1154
|
|
|
@@ -1170,7 +1156,7 @@ When the width of the chart is less than or equal to this pixel value, and the x
|
|
|
1170
1156
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1171
1157
|
|
|
1172
1158
|
|
|
1173
|
-
<a name="Plot.x2Config" href="#Plot.x2Config">#</a> Plot.**x2Config**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1159
|
+
<a name="Plot.x2Config" href="#Plot.x2Config">#</a> Plot.**x2Config**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1803)
|
|
1174
1160
|
|
|
1175
1161
|
A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.
|
|
1176
1162
|
|
|
@@ -1178,7 +1164,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
1178
1164
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1179
1165
|
|
|
1180
1166
|
|
|
1181
|
-
<a name="Plot.xDomain" href="#Plot.xDomain">#</a> Plot.**xDomain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1167
|
+
<a name="Plot.xDomain" href="#Plot.xDomain">#</a> Plot.**xDomain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1813)
|
|
1182
1168
|
|
|
1183
1169
|
Sets the x domain to the specified array. If *value* is not specified, returns the current x domain. Additionally, if either value of the array is undefined, it will be calculated from the data.
|
|
1184
1170
|
|
|
@@ -1186,7 +1172,7 @@ Sets the x domain to the specified array. If *value* is not specified, returns t
|
|
|
1186
1172
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1187
1173
|
|
|
1188
1174
|
|
|
1189
|
-
<a name="Plot.x2Domain" href="#Plot.x2Domain">#</a> Plot.**x2Domain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1175
|
+
<a name="Plot.x2Domain" href="#Plot.x2Domain">#</a> Plot.**x2Domain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1823)
|
|
1190
1176
|
|
|
1191
1177
|
Sets the x2 domain to the specified array. If *value* is not specified, returns the current x2 domain. Additionally, if either value of the array is undefined, it will be calculated from the data.
|
|
1192
1178
|
|
|
@@ -1194,7 +1180,7 @@ Sets the x2 domain to the specified array. If *value* is not specified, returns
|
|
|
1194
1180
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1195
1181
|
|
|
1196
1182
|
|
|
1197
|
-
<a name="Plot.xSort" href="#Plot.xSort">#</a> Plot.**xSort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1183
|
+
<a name="Plot.xSort" href="#Plot.xSort">#</a> Plot.**xSort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1833)
|
|
1198
1184
|
|
|
1199
1185
|
Defines a custom sorting comparitor function to be used for discrete x axes.
|
|
1200
1186
|
|
|
@@ -1202,7 +1188,7 @@ Defines a custom sorting comparitor function to be used for discrete x axes.
|
|
|
1202
1188
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1203
1189
|
|
|
1204
1190
|
|
|
1205
|
-
<a name="Plot.x2Sort" href="#Plot.x2Sort">#</a> Plot.**x2Sort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1191
|
+
<a name="Plot.x2Sort" href="#Plot.x2Sort">#</a> Plot.**x2Sort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1843)
|
|
1206
1192
|
|
|
1207
1193
|
Defines a custom sorting comparitor function to be used for discrete x2 axes.
|
|
1208
1194
|
|
|
@@ -1210,23 +1196,23 @@ Defines a custom sorting comparitor function to be used for discrete x2 axes.
|
|
|
1210
1196
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1211
1197
|
|
|
1212
1198
|
|
|
1213
|
-
<a name="Plot.y" href="#Plot.y">#</a> Plot.**y**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1199
|
+
<a name="Plot.y" href="#Plot.y">#</a> Plot.**y**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1853)
|
|
1214
1200
|
|
|
1215
|
-
Sets the y accessor to the specified
|
|
1201
|
+
Sets the y accessor to the specified accessor Function or String representing which key in the data to reference. If *value* is not specified, returns the current y accessor.
|
|
1216
1202
|
|
|
1217
1203
|
|
|
1218
1204
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1219
1205
|
|
|
1220
1206
|
|
|
1221
|
-
<a name="Plot.y2" href="#Plot.y2">#</a> Plot.**y2**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1207
|
+
<a name="Plot.y2" href="#Plot.y2">#</a> Plot.**y2**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1871)
|
|
1222
1208
|
|
|
1223
|
-
Sets the y2 accessor to the specified
|
|
1209
|
+
Sets the y2 accessor to the specified accessor Function or String representing which key in the data to reference. If *value* is not specified, returns the current y2 accessor.
|
|
1224
1210
|
|
|
1225
1211
|
|
|
1226
1212
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1227
1213
|
|
|
1228
1214
|
|
|
1229
|
-
<a name="Plot.yConfig" href="#Plot.yConfig">#</a> Plot.**yConfig**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1215
|
+
<a name="Plot.yConfig" href="#Plot.yConfig">#</a> Plot.**yConfig**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1891)
|
|
1230
1216
|
|
|
1231
1217
|
A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.
|
|
1232
1218
|
Note:* If a "domain" array is passed to the y-axis config, it will be reversed.
|
|
@@ -1235,7 +1221,7 @@ Note:* If a "domain" array is passed to the y-axis config, it will be reversed.
|
|
|
1235
1221
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1236
1222
|
|
|
1237
1223
|
|
|
1238
|
-
<a name="Plot.yCutoff" href="#Plot.yCutoff">#</a> Plot.**yCutoff**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1224
|
+
<a name="Plot.yCutoff" href="#Plot.yCutoff">#</a> Plot.**yCutoff**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1906)
|
|
1239
1225
|
|
|
1240
1226
|
When the height of the chart is less than or equal to this pixel value, and the y-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.
|
|
1241
1227
|
|
|
@@ -1243,7 +1229,7 @@ When the height of the chart is less than or equal to this pixel value, and the
|
|
|
1243
1229
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1244
1230
|
|
|
1245
1231
|
|
|
1246
|
-
<a name="Plot.y2Config" href="#Plot.y2Config">#</a> Plot.**y2Config**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1232
|
+
<a name="Plot.y2Config" href="#Plot.y2Config">#</a> Plot.**y2Config**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1916)
|
|
1247
1233
|
|
|
1248
1234
|
A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.
|
|
1249
1235
|
|
|
@@ -1251,7 +1237,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
1251
1237
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1252
1238
|
|
|
1253
1239
|
|
|
1254
|
-
<a name="Plot.yDomain" href="#Plot.yDomain">#</a> Plot.**yDomain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1240
|
+
<a name="Plot.yDomain" href="#Plot.yDomain">#</a> Plot.**yDomain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1931)
|
|
1255
1241
|
|
|
1256
1242
|
Sets the y domain to the specified array. If *value* is not specified, returns the current y domain. Additionally, if either value of the array is undefined, it will be calculated from the data.
|
|
1257
1243
|
|
|
@@ -1259,7 +1245,7 @@ Sets the y domain to the specified array. If *value* is not specified, returns t
|
|
|
1259
1245
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1260
1246
|
|
|
1261
1247
|
|
|
1262
|
-
<a name="Plot.y2Domain" href="#Plot.y2Domain">#</a> Plot.**y2Domain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1248
|
+
<a name="Plot.y2Domain" href="#Plot.y2Domain">#</a> Plot.**y2Domain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1941)
|
|
1263
1249
|
|
|
1264
1250
|
Sets the y2 domain to the specified array. If *value* is not specified, returns the current y2 domain. Additionally, if either value of the array is undefined, it will be calculated from the data.
|
|
1265
1251
|
|
|
@@ -1267,7 +1253,7 @@ Sets the y2 domain to the specified array. If *value* is not specified, returns
|
|
|
1267
1253
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1268
1254
|
|
|
1269
1255
|
|
|
1270
|
-
<a name="Plot.ySort" href="#Plot.ySort">#</a> Plot.**ySort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1256
|
+
<a name="Plot.ySort" href="#Plot.ySort">#</a> Plot.**ySort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1951)
|
|
1271
1257
|
|
|
1272
1258
|
Defines a custom sorting comparitor function to be used for discrete y axes.
|
|
1273
1259
|
|
|
@@ -1275,7 +1261,7 @@ Defines a custom sorting comparitor function to be used for discrete y axes.
|
|
|
1275
1261
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1276
1262
|
|
|
1277
1263
|
|
|
1278
|
-
<a name="Plot.y2Sort" href="#Plot.y2Sort">#</a> Plot.**y2Sort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
1264
|
+
<a name="Plot.y2Sort" href="#Plot.y2Sort">#</a> Plot.**y2Sort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1961)
|
|
1279
1265
|
|
|
1280
1266
|
Defines a custom sorting comparitor function to be used for discrete y2 axes.
|
|
1281
1267
|
|
|
@@ -1921,7 +1907,7 @@ This is a static method of [<code>Treemap</code>](#Treemap)
|
|
|
1921
1907
|
---
|
|
1922
1908
|
|
|
1923
1909
|
<a name="Viz"></a>
|
|
1924
|
-
#### **Viz** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
1910
|
+
#### **Viz** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L81)
|
|
1925
1911
|
|
|
1926
1912
|
|
|
1927
1913
|
This is a global class, and extends all of the methods and functionality of [<code>BaseClass</code>](#BaseClass).
|
|
@@ -2030,7 +2016,7 @@ Creates an x/y plot based on an array of data. If *data* is specified, immediate
|
|
|
2030
2016
|
|
|
2031
2017
|
|
|
2032
2018
|
|
|
2033
|
-
<a name="Viz.labelPosition" href="#Viz.labelPosition">#</a> Viz.**labelPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
2019
|
+
<a name="Viz.labelPosition" href="#Viz.labelPosition">#</a> Viz.**labelPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1622)
|
|
2034
2020
|
|
|
2035
2021
|
The behavior to be used when calculating the position and size of each shape's label(s). The value passed can either be the _String_ name of the behavior to be used for all shapes, or an accessor _Function_ that will be provided each data point and will be expected to return the behavior to be used for that data point. The availability and options for this method depend on the default logic for each Shape. As an example, the values "outside" or "inside" can be set for Bar shapes, whose "auto" default will calculate the best position dynamically based on the available space.
|
|
2036
2022
|
|
|
@@ -2038,7 +2024,7 @@ The behavior to be used when calculating the position and size of each shape's l
|
|
|
2038
2024
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2039
2025
|
|
|
2040
2026
|
|
|
2041
|
-
<a name="Viz.render" href="#Viz.render">#</a> Viz.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2027
|
+
<a name="Viz.render" href="#Viz.render">#</a> Viz.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L560)
|
|
2042
2028
|
|
|
2043
2029
|
Draws the visualization given the specified configuration.
|
|
2044
2030
|
|
|
@@ -2046,7 +2032,7 @@ Draws the visualization given the specified configuration.
|
|
|
2046
2032
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2047
2033
|
|
|
2048
2034
|
|
|
2049
|
-
<a name="Viz.active" href="#Viz.active">#</a> Viz.**active**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2035
|
+
<a name="Viz.active" href="#Viz.active">#</a> Viz.**active**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L764)
|
|
2050
2036
|
|
|
2051
2037
|
If *value* is specified, sets the active method to the specified function and returns the current class instance.
|
|
2052
2038
|
|
|
@@ -2054,7 +2040,7 @@ If *value* is specified, sets the active method to the specified function and re
|
|
|
2054
2040
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2055
2041
|
|
|
2056
2042
|
|
|
2057
|
-
<a name="Viz.aggs" href="#Viz.aggs">#</a> Viz.**aggs**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2043
|
+
<a name="Viz.aggs" href="#Viz.aggs">#</a> Viz.**aggs**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L782)
|
|
2058
2044
|
|
|
2059
2045
|
If *value* is specified, sets the aggregation method for each key in the object and returns the current class instance.
|
|
2060
2046
|
|
|
@@ -2062,7 +2048,7 @@ If *value* is specified, sets the aggregation method for each key in the object
|
|
|
2062
2048
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2063
2049
|
|
|
2064
2050
|
|
|
2065
|
-
<a name="Viz.ariaHidden" href="#Viz.ariaHidden">#</a> Viz.**ariaHidden**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2051
|
+
<a name="Viz.ariaHidden" href="#Viz.ariaHidden">#</a> Viz.**ariaHidden**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L792)
|
|
2066
2052
|
|
|
2067
2053
|
Sets the "aria-hidden" attribute of the containing SVG element. The default value is "false", but it you need to hide the SVG from screen readers set this property to "true".
|
|
2068
2054
|
|
|
@@ -2070,7 +2056,7 @@ Sets the "aria-hidden" attribute of the containing SVG element. The default valu
|
|
|
2070
2056
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2071
2057
|
|
|
2072
2058
|
|
|
2073
|
-
<a name="Viz.attribution" href="#Viz.attribution">#</a> Viz.**attribution**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2059
|
+
<a name="Viz.attribution" href="#Viz.attribution">#</a> Viz.**attribution**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L802)
|
|
2074
2060
|
|
|
2075
2061
|
Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).
|
|
2076
2062
|
|
|
@@ -2078,7 +2064,7 @@ Sets text to be shown positioned absolute on top of the visualization in the bot
|
|
|
2078
2064
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2079
2065
|
|
|
2080
2066
|
|
|
2081
|
-
<a name="Viz.attributionStyle" href="#Viz.attributionStyle">#</a> Viz.**attributionStyle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2067
|
+
<a name="Viz.attributionStyle" href="#Viz.attributionStyle">#</a> Viz.**attributionStyle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L812)
|
|
2082
2068
|
|
|
2083
2069
|
If *value* is specified, sets the config method for the back button and returns the current class instance.
|
|
2084
2070
|
|
|
@@ -2086,7 +2072,7 @@ If *value* is specified, sets the config method for the back button and returns
|
|
|
2086
2072
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2087
2073
|
|
|
2088
2074
|
|
|
2089
|
-
<a name="Viz.backConfig" href="#Viz.backConfig">#</a> Viz.**backConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2075
|
+
<a name="Viz.backConfig" href="#Viz.backConfig">#</a> Viz.**backConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L822)
|
|
2090
2076
|
|
|
2091
2077
|
If *value* is specified, sets the config method for the back button and returns the current class instance.
|
|
2092
2078
|
|
|
@@ -2094,7 +2080,7 @@ If *value* is specified, sets the config method for the back button and returns
|
|
|
2094
2080
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2095
2081
|
|
|
2096
2082
|
|
|
2097
|
-
<a name="Viz.cache" href="#Viz.cache">#</a> Viz.**cache**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2083
|
+
<a name="Viz.cache" href="#Viz.cache">#</a> Viz.**cache**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L832)
|
|
2098
2084
|
|
|
2099
2085
|
Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.
|
|
2100
2086
|
|
|
@@ -2102,7 +2088,7 @@ Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful wh
|
|
|
2102
2088
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2103
2089
|
|
|
2104
2090
|
|
|
2105
|
-
<a name="Viz.color" href="#Viz.color">#</a> Viz.**color**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2091
|
+
<a name="Viz.color" href="#Viz.color">#</a> Viz.**color**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L842)
|
|
2106
2092
|
|
|
2107
2093
|
Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.
|
|
2108
2094
|
|
|
@@ -2110,7 +2096,7 @@ Defines the main color to be used for each data point in a visualization. Can be
|
|
|
2110
2096
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2111
2097
|
|
|
2112
2098
|
|
|
2113
|
-
<a name="Viz.colorScale" href="#Viz.colorScale">#</a> Viz.**colorScale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2099
|
+
<a name="Viz.colorScale" href="#Viz.colorScale">#</a> Viz.**colorScale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L852)
|
|
2114
2100
|
|
|
2115
2101
|
Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.
|
|
2116
2102
|
|
|
@@ -2118,7 +2104,7 @@ Defines the value to be used for a color scale. Can be either an accessor functi
|
|
|
2118
2104
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2119
2105
|
|
|
2120
2106
|
|
|
2121
|
-
<a name="Viz.colorScaleConfig" href="#Viz.colorScaleConfig">#</a> Viz.**colorScaleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2107
|
+
<a name="Viz.colorScaleConfig" href="#Viz.colorScaleConfig">#</a> Viz.**colorScaleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L862)
|
|
2122
2108
|
|
|
2123
2109
|
A pass-through to the config method of ColorScale.
|
|
2124
2110
|
|
|
@@ -2126,7 +2112,7 @@ A pass-through to the config method of ColorScale.
|
|
|
2126
2112
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2127
2113
|
|
|
2128
2114
|
|
|
2129
|
-
<a name="Viz.colorScalePadding" href="#Viz.colorScalePadding">#</a> Viz.**colorScalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2115
|
+
<a name="Viz.colorScalePadding" href="#Viz.colorScalePadding">#</a> Viz.**colorScalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L872)
|
|
2130
2116
|
|
|
2131
2117
|
Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
2132
2118
|
|
|
@@ -2134,7 +2120,7 @@ Tells the colorScale whether or not to use the internal padding defined by the v
|
|
|
2134
2120
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2135
2121
|
|
|
2136
2122
|
|
|
2137
|
-
<a name="Viz.colorScalePosition" href="#Viz.colorScalePosition">#</a> Viz.**colorScalePosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2123
|
+
<a name="Viz.colorScalePosition" href="#Viz.colorScalePosition">#</a> Viz.**colorScalePosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L882)
|
|
2138
2124
|
|
|
2139
2125
|
Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.
|
|
2140
2126
|
|
|
@@ -2142,7 +2128,7 @@ Defines which side of the visualization to anchor the color scale. Acceptable va
|
|
|
2142
2128
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2143
2129
|
|
|
2144
2130
|
|
|
2145
|
-
<a name="Viz.colorScaleMaxSize" href="#Viz.colorScaleMaxSize">#</a> Viz.**colorScaleMaxSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2131
|
+
<a name="Viz.colorScaleMaxSize" href="#Viz.colorScaleMaxSize">#</a> Viz.**colorScaleMaxSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L892)
|
|
2146
2132
|
|
|
2147
2133
|
Sets the maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.
|
|
2148
2134
|
|
|
@@ -2150,7 +2136,7 @@ Sets the maximum pixel size for drawing the color scale: width for horizontal sc
|
|
|
2150
2136
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2151
2137
|
|
|
2152
2138
|
|
|
2153
|
-
<a name="Viz.data" href="#Viz.data">#</a> Viz.**data**(*data*, [*formatter*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2139
|
+
<a name="Viz.data" href="#Viz.data">#</a> Viz.**data**(*data*, [*formatter*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L911)
|
|
2154
2140
|
|
|
2155
2141
|
Sets the primary data array to be used when drawing the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.
|
|
2156
2142
|
|
|
@@ -2166,7 +2152,7 @@ If *data* is not specified, this method returns the current primary data array,
|
|
|
2166
2152
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2167
2153
|
|
|
2168
2154
|
|
|
2169
|
-
<a name="Viz.dataCutoff" href="#Viz.dataCutoff">#</a> Viz.**dataCutoff**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2155
|
+
<a name="Viz.dataCutoff" href="#Viz.dataCutoff">#</a> Viz.**dataCutoff**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L932)
|
|
2170
2156
|
|
|
2171
2157
|
If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).
|
|
2172
2158
|
|
|
@@ -2174,7 +2160,7 @@ If the number of visible data points exceeds this number, the default hover beha
|
|
|
2174
2160
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2175
2161
|
|
|
2176
2162
|
|
|
2177
|
-
<a name="Viz.depth" href="#Viz.depth">#</a> Viz.**depth**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2163
|
+
<a name="Viz.depth" href="#Viz.depth">#</a> Viz.**depth**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L942)
|
|
2178
2164
|
|
|
2179
2165
|
If *value* is specified, sets the depth to the specified number and returns the current class instance. The *value* should correspond with an index in the [groupBy](#groupBy) array.
|
|
2180
2166
|
|
|
@@ -2182,7 +2168,7 @@ If *value* is specified, sets the depth to the specified number and returns the
|
|
|
2182
2168
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2183
2169
|
|
|
2184
2170
|
|
|
2185
|
-
<a name="Viz.detectResize" href="#Viz.detectResize">#</a> Viz.**detectResize**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2171
|
+
<a name="Viz.detectResize" href="#Viz.detectResize">#</a> Viz.**detectResize**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L952)
|
|
2186
2172
|
|
|
2187
2173
|
If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.
|
|
2188
2174
|
|
|
@@ -2190,7 +2176,7 @@ If the width and/or height of a Viz is not user-defined, it is determined by the
|
|
|
2190
2176
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2191
2177
|
|
|
2192
2178
|
|
|
2193
|
-
<a name="Viz.detectResizeDelay" href="#Viz.detectResizeDelay">#</a> Viz.**detectResizeDelay**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2179
|
+
<a name="Viz.detectResizeDelay" href="#Viz.detectResizeDelay">#</a> Viz.**detectResizeDelay**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L962)
|
|
2194
2180
|
|
|
2195
2181
|
When resizing the browser window, this is the millisecond delay to trigger the resize event.
|
|
2196
2182
|
|
|
@@ -2198,7 +2184,7 @@ When resizing the browser window, this is the millisecond delay to trigger the r
|
|
|
2198
2184
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2199
2185
|
|
|
2200
2186
|
|
|
2201
|
-
<a name="Viz.detectVisible" href="#Viz.detectVisible">#</a> Viz.**detectVisible**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2187
|
+
<a name="Viz.detectVisible" href="#Viz.detectVisible">#</a> Viz.**detectVisible**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L972)
|
|
2202
2188
|
|
|
2203
2189
|
Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.
|
|
2204
2190
|
|
|
@@ -2206,7 +2192,7 @@ Toggles whether or not the Viz should try to detect if it visible in the current
|
|
|
2206
2192
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2207
2193
|
|
|
2208
2194
|
|
|
2209
|
-
<a name="Viz.detectVisibleInterval" href="#Viz.detectVisibleInterval">#</a> Viz.**detectVisibleInterval**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2195
|
+
<a name="Viz.detectVisibleInterval" href="#Viz.detectVisibleInterval">#</a> Viz.**detectVisibleInterval**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L982)
|
|
2210
2196
|
|
|
2211
2197
|
The interval, in milliseconds, for checking if the visualization is visible on the page.
|
|
2212
2198
|
|
|
@@ -2214,7 +2200,7 @@ The interval, in milliseconds, for checking if the visualization is visible on t
|
|
|
2214
2200
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2215
2201
|
|
|
2216
2202
|
|
|
2217
|
-
<a name="Viz.discrete" href="#Viz.discrete">#</a> Viz.**discrete**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2203
|
+
<a name="Viz.discrete" href="#Viz.discrete">#</a> Viz.**discrete**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L992)
|
|
2218
2204
|
|
|
2219
2205
|
If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.
|
|
2220
2206
|
|
|
@@ -2222,7 +2208,7 @@ If *value* is specified, sets the discrete accessor to the specified method name
|
|
|
2222
2208
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2223
2209
|
|
|
2224
2210
|
|
|
2225
|
-
<a name="Viz.downloadButton" href="#Viz.downloadButton">#</a> Viz.**downloadButton**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2211
|
+
<a name="Viz.downloadButton" href="#Viz.downloadButton">#</a> Viz.**downloadButton**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1002)
|
|
2226
2212
|
|
|
2227
2213
|
Shows a button that allows for downloading the current visualization.
|
|
2228
2214
|
|
|
@@ -2230,7 +2216,7 @@ Shows a button that allows for downloading the current visualization.
|
|
|
2230
2216
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2231
2217
|
|
|
2232
2218
|
|
|
2233
|
-
<a name="Viz.downloadConfig" href="#Viz.downloadConfig">#</a> Viz.**downloadConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2219
|
+
<a name="Viz.downloadConfig" href="#Viz.downloadConfig">#</a> Viz.**downloadConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1012)
|
|
2234
2220
|
|
|
2235
2221
|
Sets specific options of the saveElement function used when downloading the visualization.
|
|
2236
2222
|
|
|
@@ -2238,7 +2224,7 @@ Sets specific options of the saveElement function used when downloading the visu
|
|
|
2238
2224
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2239
2225
|
|
|
2240
2226
|
|
|
2241
|
-
<a name="Viz.downloadPosition" href="#Viz.downloadPosition">#</a> Viz.**downloadPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2227
|
+
<a name="Viz.downloadPosition" href="#Viz.downloadPosition">#</a> Viz.**downloadPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1022)
|
|
2242
2228
|
|
|
2243
2229
|
Defines which control group to add the download button into.
|
|
2244
2230
|
|
|
@@ -2246,7 +2232,7 @@ Defines which control group to add the download button into.
|
|
|
2246
2232
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2247
2233
|
|
|
2248
2234
|
|
|
2249
|
-
<a name="Viz.duration" href="#Viz.duration">#</a> Viz.**duration**([*ms*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2235
|
+
<a name="Viz.duration" href="#Viz.duration">#</a> Viz.**duration**([*ms*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1032)
|
|
2250
2236
|
|
|
2251
2237
|
If *ms* is specified, sets the animation duration to the specified number and returns the current class instance. If *ms* is not specified, returns the current animation duration.
|
|
2252
2238
|
|
|
@@ -2254,7 +2240,7 @@ If *ms* is specified, sets the animation duration to the specified number and re
|
|
|
2254
2240
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2255
2241
|
|
|
2256
2242
|
|
|
2257
|
-
<a name="Viz.filter" href="#Viz.filter">#</a> Viz.**filter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2243
|
+
<a name="Viz.filter" href="#Viz.filter">#</a> Viz.**filter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1042)
|
|
2258
2244
|
|
|
2259
2245
|
If *value* is specified, sets the filter to the specified function and returns the current class instance.
|
|
2260
2246
|
|
|
@@ -2262,7 +2248,7 @@ If *value* is specified, sets the filter to the specified function and returns t
|
|
|
2262
2248
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2263
2249
|
|
|
2264
2250
|
|
|
2265
|
-
<a name="Viz.fontFamily" href="#Viz.fontFamily">#</a> Viz.**fontFamily**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2251
|
+
<a name="Viz.fontFamily" href="#Viz.fontFamily">#</a> Viz.**fontFamily**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1052)
|
|
2266
2252
|
|
|
2267
2253
|
If *value* is specified, sets the filter to the specified function and returns the current class instance.
|
|
2268
2254
|
|
|
@@ -2270,7 +2256,7 @@ If *value* is specified, sets the filter to the specified function and returns t
|
|
|
2270
2256
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2271
2257
|
|
|
2272
2258
|
|
|
2273
|
-
<a name="Viz.groupBy" href="#Viz.groupBy">#</a> Viz.**groupBy**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2259
|
+
<a name="Viz.groupBy" href="#Viz.groupBy">#</a> Viz.**groupBy**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1088)
|
|
2274
2260
|
|
|
2275
2261
|
If *value* is specified, sets the group accessor(s) to the specified string, function, or array of values and returns the current class instance.
|
|
2276
2262
|
|
|
@@ -2285,7 +2271,7 @@ function value(d) {
|
|
|
2285
2271
|
```
|
|
2286
2272
|
|
|
2287
2273
|
|
|
2288
|
-
<a name="Viz.height" href="#Viz.height">#</a> Viz.**height**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2274
|
+
<a name="Viz.height" href="#Viz.height">#</a> Viz.**height**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1112)
|
|
2289
2275
|
|
|
2290
2276
|
If *value* is specified, sets the overall height to the specified number and returns the current class instance.
|
|
2291
2277
|
|
|
@@ -2293,7 +2279,7 @@ If *value* is specified, sets the overall height to the specified number and ret
|
|
|
2293
2279
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2294
2280
|
|
|
2295
2281
|
|
|
2296
|
-
<a name="Viz.hiddenColor" href="#Viz.hiddenColor">#</a> Viz.**hiddenColor**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2282
|
+
<a name="Viz.hiddenColor" href="#Viz.hiddenColor">#</a> Viz.**hiddenColor**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1122)
|
|
2297
2283
|
|
|
2298
2284
|
Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
2299
2285
|
|
|
@@ -2301,7 +2287,7 @@ Defines the color used for legend shapes when the corresponding grouping is hidd
|
|
|
2301
2287
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2302
2288
|
|
|
2303
2289
|
|
|
2304
|
-
<a name="Viz.hiddenOpacity" href="#Viz.hiddenOpacity">#</a> Viz.**hiddenOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2290
|
+
<a name="Viz.hiddenOpacity" href="#Viz.hiddenOpacity">#</a> Viz.**hiddenOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1132)
|
|
2305
2291
|
|
|
2306
2292
|
Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
2307
2293
|
|
|
@@ -2309,7 +2295,7 @@ Defines the opacity used for legend labels when the corresponding grouping is hi
|
|
|
2309
2295
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2310
2296
|
|
|
2311
2297
|
|
|
2312
|
-
<a name="Viz.hover" href="#Viz.hover">#</a> Viz.**hover**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2298
|
+
<a name="Viz.hover" href="#Viz.hover">#</a> Viz.**hover**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1142)
|
|
2313
2299
|
|
|
2314
2300
|
If *value* is specified, sets the hover method to the specified function and returns the current class instance.
|
|
2315
2301
|
|
|
@@ -2317,7 +2303,7 @@ If *value* is specified, sets the hover method to the specified function and ret
|
|
|
2317
2303
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2318
2304
|
|
|
2319
2305
|
|
|
2320
|
-
<a name="Viz.label" href="#Viz.label">#</a> Viz.**label**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2306
|
+
<a name="Viz.label" href="#Viz.label">#</a> Viz.**label**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1180)
|
|
2321
2307
|
|
|
2322
2308
|
If *value* is specified, sets the label accessor to the specified function or string and returns the current class instance.
|
|
2323
2309
|
|
|
@@ -2325,7 +2311,7 @@ If *value* is specified, sets the label accessor to the specified function or st
|
|
|
2325
2311
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2326
2312
|
|
|
2327
2313
|
|
|
2328
|
-
<a name="Viz.legend" href="#Viz.legend">#</a> Viz.**legend**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2314
|
+
<a name="Viz.legend" href="#Viz.legend">#</a> Viz.**legend**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1190)
|
|
2329
2315
|
|
|
2330
2316
|
If *value* is specified, toggles the legend based on the specified boolean and returns the current class instance.
|
|
2331
2317
|
|
|
@@ -2333,7 +2319,7 @@ If *value* is specified, toggles the legend based on the specified boolean and r
|
|
|
2333
2319
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2334
2320
|
|
|
2335
2321
|
|
|
2336
|
-
<a name="Viz.legendConfig" href="#Viz.legendConfig">#</a> Viz.**legendConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2322
|
+
<a name="Viz.legendConfig" href="#Viz.legendConfig">#</a> Viz.**legendConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1200)
|
|
2337
2323
|
|
|
2338
2324
|
If *value* is specified, the object is passed to the legend's config method.
|
|
2339
2325
|
|
|
@@ -2341,7 +2327,7 @@ If *value* is specified, the object is passed to the legend's config method.
|
|
|
2341
2327
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2342
2328
|
|
|
2343
2329
|
|
|
2344
|
-
<a name="Viz.legendFilterInvert" href="#Viz.legendFilterInvert">#</a> Viz.**legendFilterInvert**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2330
|
+
<a name="Viz.legendFilterInvert" href="#Viz.legendFilterInvert">#</a> Viz.**legendFilterInvert**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1210)
|
|
2345
2331
|
|
|
2346
2332
|
Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.
|
|
2347
2333
|
|
|
@@ -2349,7 +2335,7 @@ Defines the click functionality of categorical legend squares. When set to false
|
|
|
2349
2335
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2350
2336
|
|
|
2351
2337
|
|
|
2352
|
-
<a name="Viz.legendPadding" href="#Viz.legendPadding">#</a> Viz.**legendPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2338
|
+
<a name="Viz.legendPadding" href="#Viz.legendPadding">#</a> Viz.**legendPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1220)
|
|
2353
2339
|
|
|
2354
2340
|
Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
2355
2341
|
|
|
@@ -2357,7 +2343,7 @@ Tells the legend whether or not to use the internal padding defined by the visua
|
|
|
2357
2343
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2358
2344
|
|
|
2359
2345
|
|
|
2360
|
-
<a name="Viz.legendPosition" href="#Viz.legendPosition">#</a> Viz.**legendPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2346
|
+
<a name="Viz.legendPosition" href="#Viz.legendPosition">#</a> Viz.**legendPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1230)
|
|
2361
2347
|
|
|
2362
2348
|
Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.
|
|
2363
2349
|
|
|
@@ -2365,7 +2351,7 @@ Defines which side of the visualization to anchor the legend. Expected values ar
|
|
|
2365
2351
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2366
2352
|
|
|
2367
2353
|
|
|
2368
|
-
<a name="Viz.legendSort" href="#Viz.legendSort">#</a> Viz.**legendSort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2354
|
+
<a name="Viz.legendSort" href="#Viz.legendSort">#</a> Viz.**legendSort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1240)
|
|
2369
2355
|
|
|
2370
2356
|
A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.
|
|
2371
2357
|
|
|
@@ -2373,7 +2359,7 @@ A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs
|
|
|
2373
2359
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2374
2360
|
|
|
2375
2361
|
|
|
2376
|
-
<a name="Viz.legendTooltip" href="#Viz.legendTooltip">#</a> Viz.**legendTooltip**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2362
|
+
<a name="Viz.legendTooltip" href="#Viz.legendTooltip">#</a> Viz.**legendTooltip**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1250)
|
|
2377
2363
|
|
|
2378
2364
|
If *value* is specified, sets the config method for the legend tooltip and returns the current class instance.
|
|
2379
2365
|
|
|
@@ -2381,7 +2367,7 @@ If *value* is specified, sets the config method for the legend tooltip and retur
|
|
|
2381
2367
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2382
2368
|
|
|
2383
2369
|
|
|
2384
|
-
<a name="Viz.loadingHTML" href="#Viz.loadingHTML">#</a> Viz.**loadingHTML**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2370
|
+
<a name="Viz.loadingHTML" href="#Viz.loadingHTML">#</a> Viz.**loadingHTML**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1260)
|
|
2385
2371
|
|
|
2386
2372
|
Sets the inner HTML of the status message that is displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.
|
|
2387
2373
|
|
|
@@ -2389,7 +2375,7 @@ Sets the inner HTML of the status message that is displayed when loading AJAX re
|
|
|
2389
2375
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2390
2376
|
|
|
2391
2377
|
|
|
2392
|
-
<a name="Viz.loadingMessage" href="#Viz.loadingMessage">#</a> Viz.**loadingMessage**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2378
|
+
<a name="Viz.loadingMessage" href="#Viz.loadingMessage">#</a> Viz.**loadingMessage**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1270)
|
|
2393
2379
|
|
|
2394
2380
|
Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.
|
|
2395
2381
|
|
|
@@ -2397,7 +2383,7 @@ Toggles the visibility of the status message that is displayed when loading AJAX
|
|
|
2397
2383
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2398
2384
|
|
|
2399
2385
|
|
|
2400
|
-
<a name="Viz.messageMask" href="#Viz.messageMask">#</a> Viz.**messageMask**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2386
|
+
<a name="Viz.messageMask" href="#Viz.messageMask">#</a> Viz.**messageMask**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1280)
|
|
2401
2387
|
|
|
2402
2388
|
Sets the color of the mask used underneath the status message that is displayed when loading AJAX requests and displaying errors. Additionally, `false` will turn off the mask completely.
|
|
2403
2389
|
|
|
@@ -2405,7 +2391,7 @@ Sets the color of the mask used underneath the status message that is displayed
|
|
|
2405
2391
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2406
2392
|
|
|
2407
2393
|
|
|
2408
|
-
<a name="Viz.messageStyle" href="#Viz.messageStyle">#</a> Viz.**messageStyle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2394
|
+
<a name="Viz.messageStyle" href="#Viz.messageStyle">#</a> Viz.**messageStyle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1290)
|
|
2409
2395
|
|
|
2410
2396
|
Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.
|
|
2411
2397
|
|
|
@@ -2413,7 +2399,7 @@ Defines the CSS style properties for the status message that is displayed when l
|
|
|
2413
2399
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2414
2400
|
|
|
2415
2401
|
|
|
2416
|
-
<a name="Viz.noDataHTML" href="#Viz.noDataHTML">#</a> Viz.**noDataHTML**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2402
|
+
<a name="Viz.noDataHTML" href="#Viz.noDataHTML">#</a> Viz.**noDataHTML**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1300)
|
|
2417
2403
|
|
|
2418
2404
|
Sets the inner HTML of the status message that is displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.
|
|
2419
2405
|
|
|
@@ -2421,7 +2407,7 @@ Sets the inner HTML of the status message that is displayed when no data is supp
|
|
|
2421
2407
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2422
2408
|
|
|
2423
2409
|
|
|
2424
|
-
<a name="Viz.noDataMessage" href="#Viz.noDataMessage">#</a> Viz.**noDataMessage**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2410
|
+
<a name="Viz.noDataMessage" href="#Viz.noDataMessage">#</a> Viz.**noDataMessage**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1310)
|
|
2425
2411
|
|
|
2426
2412
|
Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.
|
|
2427
2413
|
|
|
@@ -2429,7 +2415,7 @@ Toggles the visibility of the status message that is displayed when no data is s
|
|
|
2429
2415
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2430
2416
|
|
|
2431
2417
|
|
|
2432
|
-
<a name="Viz.resizeContainer" href="#Viz.resizeContainer">#</a> Viz.**resizeContainer**(*selector*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2418
|
+
<a name="Viz.resizeContainer" href="#Viz.resizeContainer">#</a> Viz.**resizeContainer**(*selector*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1320)
|
|
2433
2419
|
|
|
2434
2420
|
If using resize detection, this method allow a custom override of the element to which the resize detection function gets attached.
|
|
2435
2421
|
|
|
@@ -2437,7 +2423,7 @@ If using resize detection, this method allow a custom override of the element to
|
|
|
2437
2423
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2438
2424
|
|
|
2439
2425
|
|
|
2440
|
-
<a name="Viz.scrollContainer" href="#Viz.scrollContainer">#</a> Viz.**scrollContainer**(*selector*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2426
|
+
<a name="Viz.scrollContainer" href="#Viz.scrollContainer">#</a> Viz.**scrollContainer**(*selector*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1330)
|
|
2441
2427
|
|
|
2442
2428
|
If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.
|
|
2443
2429
|
|
|
@@ -2445,7 +2431,7 @@ If using scroll or visibility detection, this method allow a custom override of
|
|
|
2445
2431
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2446
2432
|
|
|
2447
2433
|
|
|
2448
|
-
<a name="Viz.select" href="#Viz.select">#</a> Viz.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2434
|
+
<a name="Viz.select" href="#Viz.select">#</a> Viz.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1340)
|
|
2449
2435
|
|
|
2450
2436
|
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, which is `undefined` by default.
|
|
2451
2437
|
|
|
@@ -2453,7 +2439,7 @@ If *selector* is specified, sets the SVG container element to the specified d3 s
|
|
|
2453
2439
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2454
2440
|
|
|
2455
2441
|
|
|
2456
|
-
<a name="Viz.shape" href="#Viz.shape">#</a> Viz.**shape**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2442
|
+
<a name="Viz.shape" href="#Viz.shape">#</a> Viz.**shape**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1350)
|
|
2457
2443
|
|
|
2458
2444
|
If *value* is specified, sets the shape accessor to the specified function or number and returns the current class instance.
|
|
2459
2445
|
|
|
@@ -2461,7 +2447,7 @@ If *value* is specified, sets the shape accessor to the specified function or nu
|
|
|
2461
2447
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2462
2448
|
|
|
2463
2449
|
|
|
2464
|
-
<a name="Viz.shapeConfig" href="#Viz.shapeConfig">#</a> Viz.**shapeConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2450
|
+
<a name="Viz.shapeConfig" href="#Viz.shapeConfig">#</a> Viz.**shapeConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1360)
|
|
2465
2451
|
|
|
2466
2452
|
If *value* is specified, sets the config method for each shape and returns the current class instance.
|
|
2467
2453
|
|
|
@@ -2469,7 +2455,7 @@ If *value* is specified, sets the config method for each shape and returns the c
|
|
|
2469
2455
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2470
2456
|
|
|
2471
2457
|
|
|
2472
|
-
<a name="Viz.subtitle" href="#Viz.subtitle">#</a> Viz.**subtitle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2458
|
+
<a name="Viz.subtitle" href="#Viz.subtitle">#</a> Viz.**subtitle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1370)
|
|
2473
2459
|
|
|
2474
2460
|
If *value* is specified, sets the subtitle accessor to the specified function or string and returns the current class instance.
|
|
2475
2461
|
|
|
@@ -2477,7 +2463,7 @@ If *value* is specified, sets the subtitle accessor to the specified function or
|
|
|
2477
2463
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2478
2464
|
|
|
2479
2465
|
|
|
2480
|
-
<a name="Viz.subtitleConfig" href="#Viz.subtitleConfig">#</a> Viz.**subtitleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2466
|
+
<a name="Viz.subtitleConfig" href="#Viz.subtitleConfig">#</a> Viz.**subtitleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1380)
|
|
2481
2467
|
|
|
2482
2468
|
If *value* is specified, sets the config method for the subtitle and returns the current class instance.
|
|
2483
2469
|
|
|
@@ -2485,7 +2471,7 @@ If *value* is specified, sets the config method for the subtitle and returns the
|
|
|
2485
2471
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2486
2472
|
|
|
2487
2473
|
|
|
2488
|
-
<a name="Viz.subtitlePadding" href="#Viz.subtitlePadding">#</a> Viz.**subtitlePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2474
|
+
<a name="Viz.subtitlePadding" href="#Viz.subtitlePadding">#</a> Viz.**subtitlePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1390)
|
|
2489
2475
|
|
|
2490
2476
|
Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
2491
2477
|
|
|
@@ -2493,7 +2479,7 @@ Tells the subtitle whether or not to use the internal padding defined by the vis
|
|
|
2493
2479
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2494
2480
|
|
|
2495
2481
|
|
|
2496
|
-
<a name="Viz.svgDesc" href="#Viz.svgDesc">#</a> Viz.**svgDesc**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2482
|
+
<a name="Viz.svgDesc" href="#Viz.svgDesc">#</a> Viz.**svgDesc**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1400)
|
|
2497
2483
|
|
|
2498
2484
|
If *value* is specified, sets the description accessor to the specified string and returns the current class instance.
|
|
2499
2485
|
|
|
@@ -2501,7 +2487,7 @@ If *value* is specified, sets the description accessor to the specified string a
|
|
|
2501
2487
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2502
2488
|
|
|
2503
2489
|
|
|
2504
|
-
<a name="Viz.svgTitle" href="#Viz.svgTitle">#</a> Viz.**svgTitle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2490
|
+
<a name="Viz.svgTitle" href="#Viz.svgTitle">#</a> Viz.**svgTitle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1410)
|
|
2505
2491
|
|
|
2506
2492
|
If *value* is specified, sets the title accessor to the specified string and returns the current class instance.
|
|
2507
2493
|
|
|
@@ -2509,7 +2495,7 @@ If *value* is specified, sets the title accessor to the specified string and ret
|
|
|
2509
2495
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2510
2496
|
|
|
2511
2497
|
|
|
2512
|
-
<a name="Viz.threshold" href="#Viz.threshold">#</a> Viz.**threshold**([value]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2498
|
+
<a name="Viz.threshold" href="#Viz.threshold">#</a> Viz.**threshold**([value]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1420)
|
|
2513
2499
|
|
|
2514
2500
|
If *value* is specified, sets the threshold for buckets to the specified function or string, and returns the current class instance.
|
|
2515
2501
|
|
|
@@ -2517,7 +2503,7 @@ If *value* is specified, sets the threshold for buckets to the specified functio
|
|
|
2517
2503
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2518
2504
|
|
|
2519
2505
|
|
|
2520
|
-
<a name="Viz.thresholdKey" href="#Viz.thresholdKey">#</a> Viz.**thresholdKey**([value]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2506
|
+
<a name="Viz.thresholdKey" href="#Viz.thresholdKey">#</a> Viz.**thresholdKey**([value]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1439)
|
|
2521
2507
|
|
|
2522
2508
|
If *value* is specified, sets the accesor for the value used in the threshold algorithm, and returns the current class instance.
|
|
2523
2509
|
|
|
@@ -2525,7 +2511,7 @@ If *value* is specified, sets the accesor for the value used in the threshold al
|
|
|
2525
2511
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2526
2512
|
|
|
2527
2513
|
|
|
2528
|
-
<a name="Viz.thresholdName" href="#Viz.thresholdName">#</a> Viz.**thresholdName**([value]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2514
|
+
<a name="Viz.thresholdName" href="#Viz.thresholdName">#</a> Viz.**thresholdName**([value]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1458)
|
|
2529
2515
|
|
|
2530
2516
|
If *value* is specified, sets the label for the bucket item, and returns the current class instance.
|
|
2531
2517
|
|
|
@@ -2533,7 +2519,7 @@ If *value* is specified, sets the label for the bucket item, and returns the cur
|
|
|
2533
2519
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2534
2520
|
|
|
2535
2521
|
|
|
2536
|
-
<a name="Viz.time" href="#Viz.time">#</a> Viz.**time**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2522
|
+
<a name="Viz.time" href="#Viz.time">#</a> Viz.**time**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1468)
|
|
2537
2523
|
|
|
2538
2524
|
If *value* is specified, sets the time accessor to the specified function or string and returns the current class instance.
|
|
2539
2525
|
|
|
@@ -2541,7 +2527,7 @@ If *value* is specified, sets the time accessor to the specified function or str
|
|
|
2541
2527
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2542
2528
|
|
|
2543
2529
|
|
|
2544
|
-
<a name="Viz.timeFilter" href="#Viz.timeFilter">#</a> Viz.**timeFilter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2530
|
+
<a name="Viz.timeFilter" href="#Viz.timeFilter">#</a> Viz.**timeFilter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1498)
|
|
2545
2531
|
|
|
2546
2532
|
If *value* is specified, sets the time filter to the specified function and returns the current class instance.
|
|
2547
2533
|
|
|
@@ -2549,7 +2535,7 @@ If *value* is specified, sets the time filter to the specified function and retu
|
|
|
2549
2535
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2550
2536
|
|
|
2551
2537
|
|
|
2552
|
-
<a name="Viz.timeline" href="#Viz.timeline">#</a> Viz.**timeline**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2538
|
+
<a name="Viz.timeline" href="#Viz.timeline">#</a> Viz.**timeline**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1508)
|
|
2553
2539
|
|
|
2554
2540
|
If *value* is specified, toggles the timeline based on the specified boolean and returns the current class instance.
|
|
2555
2541
|
|
|
@@ -2557,7 +2543,7 @@ If *value* is specified, toggles the timeline based on the specified boolean and
|
|
|
2557
2543
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2558
2544
|
|
|
2559
2545
|
|
|
2560
|
-
<a name="Viz.timelineConfig" href="#Viz.timelineConfig">#</a> Viz.**timelineConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2546
|
+
<a name="Viz.timelineConfig" href="#Viz.timelineConfig">#</a> Viz.**timelineConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1518)
|
|
2561
2547
|
|
|
2562
2548
|
If *value* is specified, sets the config method for the timeline and returns the current class instance.
|
|
2563
2549
|
|
|
@@ -2565,7 +2551,7 @@ If *value* is specified, sets the config method for the timeline and returns the
|
|
|
2565
2551
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2566
2552
|
|
|
2567
2553
|
|
|
2568
|
-
<a name="Viz.timelineDefault" href="#Viz.timelineDefault">#</a> Viz.**timelineDefault**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2554
|
+
<a name="Viz.timelineDefault" href="#Viz.timelineDefault">#</a> Viz.**timelineDefault**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1528)
|
|
2569
2555
|
|
|
2570
2556
|
Sets the starting time or range for the timeline. The value provided can either be a single Date/String, or an Array of 2 values representing the min and max.
|
|
2571
2557
|
|
|
@@ -2573,7 +2559,7 @@ Sets the starting time or range for the timeline. The value provided can either
|
|
|
2573
2559
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2574
2560
|
|
|
2575
2561
|
|
|
2576
|
-
<a name="Viz.timelinePadding" href="#Viz.timelinePadding">#</a> Viz.**timelinePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2562
|
+
<a name="Viz.timelinePadding" href="#Viz.timelinePadding">#</a> Viz.**timelinePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1543)
|
|
2577
2563
|
|
|
2578
2564
|
Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
2579
2565
|
|
|
@@ -2581,7 +2567,7 @@ Tells the timeline whether or not to use the internal padding defined by the vis
|
|
|
2581
2567
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2582
2568
|
|
|
2583
2569
|
|
|
2584
|
-
<a name="Viz.title" href="#Viz.title">#</a> Viz.**title**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2570
|
+
<a name="Viz.title" href="#Viz.title">#</a> Viz.**title**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1553)
|
|
2585
2571
|
|
|
2586
2572
|
If *value* is specified, sets the title accessor to the specified function or string and returns the current class instance.
|
|
2587
2573
|
|
|
@@ -2589,7 +2575,7 @@ If *value* is specified, sets the title accessor to the specified function or st
|
|
|
2589
2575
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2590
2576
|
|
|
2591
2577
|
|
|
2592
|
-
<a name="Viz.titleConfig" href="#Viz.titleConfig">#</a> Viz.**titleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2578
|
+
<a name="Viz.titleConfig" href="#Viz.titleConfig">#</a> Viz.**titleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1563)
|
|
2593
2579
|
|
|
2594
2580
|
If *value* is specified, sets the config method for the title and returns the current class instance.
|
|
2595
2581
|
|
|
@@ -2597,7 +2583,7 @@ If *value* is specified, sets the config method for the title and returns the cu
|
|
|
2597
2583
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2598
2584
|
|
|
2599
2585
|
|
|
2600
|
-
<a name="Viz.titlePadding" href="#Viz.titlePadding">#</a> Viz.**titlePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2586
|
+
<a name="Viz.titlePadding" href="#Viz.titlePadding">#</a> Viz.**titlePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1573)
|
|
2601
2587
|
|
|
2602
2588
|
Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
2603
2589
|
|
|
@@ -2605,7 +2591,7 @@ Tells the title whether or not to use the internal padding defined by the visual
|
|
|
2605
2591
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2606
2592
|
|
|
2607
2593
|
|
|
2608
|
-
<a name="Viz.tooltip" href="#Viz.tooltip">#</a> Viz.**tooltip**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2594
|
+
<a name="Viz.tooltip" href="#Viz.tooltip">#</a> Viz.**tooltip**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1583)
|
|
2609
2595
|
|
|
2610
2596
|
If *value* is specified, toggles the tooltip based on the specified boolean and returns the current class instance.
|
|
2611
2597
|
|
|
@@ -2613,7 +2599,7 @@ If *value* is specified, toggles the tooltip based on the specified boolean and
|
|
|
2613
2599
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2614
2600
|
|
|
2615
2601
|
|
|
2616
|
-
<a name="Viz.tooltipConfig" href="#Viz.tooltipConfig">#</a> Viz.**tooltipConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2602
|
+
<a name="Viz.tooltipConfig" href="#Viz.tooltipConfig">#</a> Viz.**tooltipConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1593)
|
|
2617
2603
|
|
|
2618
2604
|
If *value* is specified, sets the config method for the tooltip and returns the current class instance.
|
|
2619
2605
|
|
|
@@ -2621,7 +2607,7 @@ If *value* is specified, sets the config method for the tooltip and returns the
|
|
|
2621
2607
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2622
2608
|
|
|
2623
2609
|
|
|
2624
|
-
<a name="Viz.total" href="#Viz.total">#</a> Viz.**total**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2610
|
+
<a name="Viz.total" href="#Viz.total">#</a> Viz.**total**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1603)
|
|
2625
2611
|
|
|
2626
2612
|
If *value* is specified, sets the total accessor to the specified function or string and returns the current class instance.
|
|
2627
2613
|
|
|
@@ -2629,7 +2615,7 @@ If *value* is specified, sets the total accessor to the specified function or st
|
|
|
2629
2615
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2630
2616
|
|
|
2631
2617
|
|
|
2632
|
-
<a name="Viz.totalConfig" href="#Viz.totalConfig">#</a> Viz.**totalConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2618
|
+
<a name="Viz.totalConfig" href="#Viz.totalConfig">#</a> Viz.**totalConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1619)
|
|
2633
2619
|
|
|
2634
2620
|
If *value* is specified, sets the config method for the total and returns the current class instance.
|
|
2635
2621
|
|
|
@@ -2637,7 +2623,7 @@ If *value* is specified, sets the config method for the total and returns the cu
|
|
|
2637
2623
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2638
2624
|
|
|
2639
2625
|
|
|
2640
|
-
<a name="Viz.totalFormat" href="#Viz.totalFormat">#</a> Viz.**totalFormat**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2626
|
+
<a name="Viz.totalFormat" href="#Viz.totalFormat">#</a> Viz.**totalFormat**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1629)
|
|
2641
2627
|
|
|
2642
2628
|
Formatter function for the value in the total bar.
|
|
2643
2629
|
|
|
@@ -2645,7 +2631,7 @@ Formatter function for the value in the total bar.
|
|
|
2645
2631
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2646
2632
|
|
|
2647
2633
|
|
|
2648
|
-
<a name="Viz.totalPadding" href="#Viz.totalPadding">#</a> Viz.**totalPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2634
|
+
<a name="Viz.totalPadding" href="#Viz.totalPadding">#</a> Viz.**totalPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1639)
|
|
2649
2635
|
|
|
2650
2636
|
Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
2651
2637
|
|
|
@@ -2653,7 +2639,7 @@ Tells the total whether or not to use the internal padding defined by the visual
|
|
|
2653
2639
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2654
2640
|
|
|
2655
2641
|
|
|
2656
|
-
<a name="Viz.width" href="#Viz.width">#</a> Viz.**width**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2642
|
+
<a name="Viz.width" href="#Viz.width">#</a> Viz.**width**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1649)
|
|
2657
2643
|
|
|
2658
2644
|
If *value* is specified, sets the overallwidth to the specified number and returns the current class instance.
|
|
2659
2645
|
|
|
@@ -2661,7 +2647,7 @@ If *value* is specified, sets the overallwidth to the specified number and retur
|
|
|
2661
2647
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2662
2648
|
|
|
2663
2649
|
|
|
2664
|
-
<a name="Viz.zoom" href="#Viz.zoom">#</a> Viz.**zoom**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2650
|
+
<a name="Viz.zoom" href="#Viz.zoom">#</a> Viz.**zoom**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1659)
|
|
2665
2651
|
|
|
2666
2652
|
Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.
|
|
2667
2653
|
|
|
@@ -2669,7 +2655,7 @@ Toggles the ability to zoom/pan the visualization. Certain parameters for zoomin
|
|
|
2669
2655
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2670
2656
|
|
|
2671
2657
|
|
|
2672
|
-
<a name="Viz.zoomBrushHandleSize" href="#Viz.zoomBrushHandleSize">#</a> Viz.**zoomBrushHandleSize**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2658
|
+
<a name="Viz.zoomBrushHandleSize" href="#Viz.zoomBrushHandleSize">#</a> Viz.**zoomBrushHandleSize**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1669)
|
|
2673
2659
|
|
|
2674
2660
|
The pixel stroke-width of the zoom brush area.
|
|
2675
2661
|
|
|
@@ -2677,7 +2663,7 @@ The pixel stroke-width of the zoom brush area.
|
|
|
2677
2663
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2678
2664
|
|
|
2679
2665
|
|
|
2680
|
-
<a name="Viz.zoomBrushHandleStyle" href="#Viz.zoomBrushHandleStyle">#</a> Viz.**zoomBrushHandleStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2666
|
+
<a name="Viz.zoomBrushHandleStyle" href="#Viz.zoomBrushHandleStyle">#</a> Viz.**zoomBrushHandleStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1679)
|
|
2681
2667
|
|
|
2682
2668
|
An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.
|
|
2683
2669
|
|
|
@@ -2685,7 +2671,7 @@ An object containing CSS key/value pairs that is used to style the outer handle
|
|
|
2685
2671
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2686
2672
|
|
|
2687
2673
|
|
|
2688
|
-
<a name="Viz.zoomBrushSelectionStyle" href="#Viz.zoomBrushSelectionStyle">#</a> Viz.**zoomBrushSelectionStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2674
|
+
<a name="Viz.zoomBrushSelectionStyle" href="#Viz.zoomBrushSelectionStyle">#</a> Viz.**zoomBrushSelectionStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1689)
|
|
2689
2675
|
|
|
2690
2676
|
An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.
|
|
2691
2677
|
|
|
@@ -2693,7 +2679,7 @@ An object containing CSS key/value pairs that is used to style the inner selecti
|
|
|
2693
2679
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2694
2680
|
|
|
2695
2681
|
|
|
2696
|
-
<a name="Viz.zoomControlStyle" href="#Viz.zoomControlStyle">#</a> Viz.**zoomControlStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2682
|
+
<a name="Viz.zoomControlStyle" href="#Viz.zoomControlStyle">#</a> Viz.**zoomControlStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1699)
|
|
2697
2683
|
|
|
2698
2684
|
An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.
|
|
2699
2685
|
|
|
@@ -2701,7 +2687,7 @@ An object containing CSS key/value pairs that is used to style each zoom control
|
|
|
2701
2687
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2702
2688
|
|
|
2703
2689
|
|
|
2704
|
-
<a name="Viz.zoomControlStyleActive" href="#Viz.zoomControlStyleActive">#</a> Viz.**zoomControlStyleActive**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2690
|
+
<a name="Viz.zoomControlStyleActive" href="#Viz.zoomControlStyleActive">#</a> Viz.**zoomControlStyleActive**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1709)
|
|
2705
2691
|
|
|
2706
2692
|
An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.
|
|
2707
2693
|
|
|
@@ -2709,7 +2695,7 @@ An object containing CSS key/value pairs that is used to style each zoom control
|
|
|
2709
2695
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2710
2696
|
|
|
2711
2697
|
|
|
2712
|
-
<a name="Viz.zoomControlStyleHover" href="#Viz.zoomControlStyleHover">#</a> Viz.**zoomControlStyleHover**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2698
|
+
<a name="Viz.zoomControlStyleHover" href="#Viz.zoomControlStyleHover">#</a> Viz.**zoomControlStyleHover**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1719)
|
|
2713
2699
|
|
|
2714
2700
|
An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.
|
|
2715
2701
|
|
|
@@ -2717,7 +2703,7 @@ An object containing CSS key/value pairs that is used to style each zoom control
|
|
|
2717
2703
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2718
2704
|
|
|
2719
2705
|
|
|
2720
|
-
<a name="Viz.zoomFactor" href="#Viz.zoomFactor">#</a> Viz.**zoomFactor**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2706
|
+
<a name="Viz.zoomFactor" href="#Viz.zoomFactor">#</a> Viz.**zoomFactor**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1729)
|
|
2721
2707
|
|
|
2722
2708
|
The multiplier that is used in with the control buttons when zooming in and out.
|
|
2723
2709
|
|
|
@@ -2725,7 +2711,7 @@ The multiplier that is used in with the control buttons when zooming in and out.
|
|
|
2725
2711
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2726
2712
|
|
|
2727
2713
|
|
|
2728
|
-
<a name="Viz.zoomMax" href="#Viz.zoomMax">#</a> Viz.**zoomMax**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2714
|
+
<a name="Viz.zoomMax" href="#Viz.zoomMax">#</a> Viz.**zoomMax**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1739)
|
|
2729
2715
|
|
|
2730
2716
|
If *value* is specified, sets the max zoom scale to the specified number and returns the current class instance. If *value* is not specified, returns the current max zoom scale.
|
|
2731
2717
|
|
|
@@ -2733,7 +2719,7 @@ If *value* is specified, sets the max zoom scale to the specified number and ret
|
|
|
2733
2719
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2734
2720
|
|
|
2735
2721
|
|
|
2736
|
-
<a name="Viz.zoomPan" href="#Viz.zoomPan">#</a> Viz.**zoomPan**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2722
|
+
<a name="Viz.zoomPan" href="#Viz.zoomPan">#</a> Viz.**zoomPan**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1749)
|
|
2737
2723
|
|
|
2738
2724
|
If *value* is specified, toggles panning to the specified boolean and returns the current class instance. If *value* is not specified, returns the current panning value.
|
|
2739
2725
|
|
|
@@ -2741,7 +2727,7 @@ If *value* is specified, toggles panning to the specified boolean and returns th
|
|
|
2741
2727
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2742
2728
|
|
|
2743
2729
|
|
|
2744
|
-
<a name="Viz.zoomPadding" href="#Viz.zoomPadding">#</a> Viz.**zoomPadding**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2730
|
+
<a name="Viz.zoomPadding" href="#Viz.zoomPadding">#</a> Viz.**zoomPadding**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1759)
|
|
2745
2731
|
|
|
2746
2732
|
A pixel value to be used to pad all sides of a zoomed area.
|
|
2747
2733
|
|
|
@@ -2749,7 +2735,7 @@ A pixel value to be used to pad all sides of a zoomed area.
|
|
|
2749
2735
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2750
2736
|
|
|
2751
2737
|
|
|
2752
|
-
<a name="Viz.zoomScroll" href="#Viz.zoomScroll">#</a> Viz.**zoomScroll**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2738
|
+
<a name="Viz.zoomScroll" href="#Viz.zoomScroll">#</a> Viz.**zoomScroll**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1769)
|
|
2753
2739
|
|
|
2754
2740
|
If *value* is specified, toggles scroll zooming to the specified boolean and returns the current class instance. If *value* is not specified, returns the current scroll zooming value.
|
|
2755
2741
|
|
|
@@ -5446,7 +5432,7 @@ function(d) {
|
|
|
5446
5432
|
---
|
|
5447
5433
|
|
|
5448
5434
|
<a name="Shape"></a>
|
|
5449
|
-
#### **Shape** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5435
|
+
#### **Shape** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L36)
|
|
5450
5436
|
|
|
5451
5437
|
|
|
5452
5438
|
This is a global class, and extends all of the methods and functionality of [<code>BaseClass</code>](#BaseClass).
|
|
@@ -5505,7 +5491,7 @@ An abstracted class for generating shapes.
|
|
|
5505
5491
|
|
|
5506
5492
|
|
|
5507
5493
|
|
|
5508
|
-
<a name="Shape.render" href="#Shape.render">#</a> Shape.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5494
|
+
<a name="Shape.render" href="#Shape.render">#</a> Shape.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L568)
|
|
5509
5495
|
|
|
5510
5496
|
Renders the current Shape to the page. If a *callback* is specified, it will be called once the shapes are done drawing.
|
|
5511
5497
|
|
|
@@ -5513,7 +5499,7 @@ Renders the current Shape to the page. If a *callback* is specified, it will be
|
|
|
5513
5499
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5514
5500
|
|
|
5515
5501
|
|
|
5516
|
-
<a name="Shape.active" href="#Shape.active">#</a> Shape.**active**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5502
|
+
<a name="Shape.active" href="#Shape.active">#</a> Shape.**active**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L732)
|
|
5517
5503
|
|
|
5518
5504
|
If *value* is specified, sets the highlight accessor to the specified function and returns the current class instance.
|
|
5519
5505
|
|
|
@@ -5521,7 +5507,7 @@ If *value* is specified, sets the highlight accessor to the specified function a
|
|
|
5521
5507
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5522
5508
|
|
|
5523
5509
|
|
|
5524
|
-
<a name="Shape.activeOpacity" href="#Shape.activeOpacity">#</a> Shape.**activeOpacity**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5510
|
+
<a name="Shape.activeOpacity" href="#Shape.activeOpacity">#</a> Shape.**activeOpacity**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L751)
|
|
5525
5511
|
|
|
5526
5512
|
When shapes are active, this is the opacity of any shape that is not active.
|
|
5527
5513
|
|
|
@@ -5529,7 +5515,7 @@ When shapes are active, this is the opacity of any shape that is not active.
|
|
|
5529
5515
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5530
5516
|
|
|
5531
5517
|
|
|
5532
|
-
<a name="Shape.activeStyle" href="#Shape.activeStyle">#</a> Shape.**activeStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5518
|
+
<a name="Shape.activeStyle" href="#Shape.activeStyle">#</a> Shape.**activeStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L761)
|
|
5533
5519
|
|
|
5534
5520
|
The style to apply to active shapes.
|
|
5535
5521
|
|
|
@@ -5537,7 +5523,7 @@ The style to apply to active shapes.
|
|
|
5537
5523
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5538
5524
|
|
|
5539
5525
|
|
|
5540
|
-
<a name="Shape.ariaLabel" href="#Shape.ariaLabel">#</a> Shape.**ariaLabel**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5526
|
+
<a name="Shape.ariaLabel" href="#Shape.ariaLabel">#</a> Shape.**ariaLabel**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L771)
|
|
5541
5527
|
|
|
5542
5528
|
If *value* is specified, sets the aria-label attribute to the specified function or string and returns the current class instance.
|
|
5543
5529
|
|
|
@@ -5545,7 +5531,7 @@ If *value* is specified, sets the aria-label attribute to the specified function
|
|
|
5545
5531
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5546
5532
|
|
|
5547
5533
|
|
|
5548
|
-
<a name="Shape.backgroundImage" href="#Shape.backgroundImage">#</a> Shape.**backgroundImage**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5534
|
+
<a name="Shape.backgroundImage" href="#Shape.backgroundImage">#</a> Shape.**backgroundImage**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L783)
|
|
5549
5535
|
|
|
5550
5536
|
If *value* is specified, sets the background-image accessor to the specified function or string and returns the current class instance.
|
|
5551
5537
|
|
|
@@ -5553,7 +5539,7 @@ If *value* is specified, sets the background-image accessor to the specified fun
|
|
|
5553
5539
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5554
5540
|
|
|
5555
5541
|
|
|
5556
|
-
<a name="Shape.data" href="#Shape.data">#</a> Shape.**data**([*data*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5542
|
+
<a name="Shape.data" href="#Shape.data">#</a> Shape.**data**([*data*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L795)
|
|
5557
5543
|
|
|
5558
5544
|
If *data* is specified, sets the data array to the specified array and returns the current class instance. If *data* is not specified, returns the current data array. A shape will be drawn for each object in the array.
|
|
5559
5545
|
|
|
@@ -5561,7 +5547,7 @@ If *data* is specified, sets the data array to the specified array and returns t
|
|
|
5561
5547
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5562
5548
|
|
|
5563
5549
|
|
|
5564
|
-
<a name="Shape.discrete" href="#Shape.discrete">#</a> Shape.**discrete**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5550
|
+
<a name="Shape.discrete" href="#Shape.discrete">#</a> Shape.**discrete**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L807)
|
|
5565
5551
|
|
|
5566
5552
|
Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.
|
|
5567
5553
|
|
|
@@ -5569,7 +5555,7 @@ Determines if either the X or Y position is discrete along a Line, which helps i
|
|
|
5569
5555
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5570
5556
|
|
|
5571
5557
|
|
|
5572
|
-
<a name="Shape.duration" href="#Shape.duration">#</a> Shape.**duration**([*ms*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5558
|
+
<a name="Shape.duration" href="#Shape.duration">#</a> Shape.**duration**([*ms*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L817)
|
|
5573
5559
|
|
|
5574
5560
|
If *ms* is specified, sets the animation duration to the specified number and returns the current class instance. If *ms* is not specified, returns the current animation duration.
|
|
5575
5561
|
|
|
@@ -5577,7 +5563,7 @@ If *ms* is specified, sets the animation duration to the specified number and re
|
|
|
5577
5563
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5578
5564
|
|
|
5579
5565
|
|
|
5580
|
-
<a name="Shape.fill" href="#Shape.fill">#</a> Shape.**fill**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5566
|
+
<a name="Shape.fill" href="#Shape.fill">#</a> Shape.**fill**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L829)
|
|
5581
5567
|
|
|
5582
5568
|
If *value* is specified, sets the fill accessor to the specified function or string and returns the current class instance.
|
|
5583
5569
|
|
|
@@ -5585,7 +5571,7 @@ If *value* is specified, sets the fill accessor to the specified function or str
|
|
|
5585
5571
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5586
5572
|
|
|
5587
5573
|
|
|
5588
|
-
<a name="Shape.fillOpacity" href="#Shape.fillOpacity">#</a> Shape.**fillOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5574
|
+
<a name="Shape.fillOpacity" href="#Shape.fillOpacity">#</a> Shape.**fillOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L841)
|
|
5589
5575
|
|
|
5590
5576
|
Defines the "fill-opacity" attribute for the shapes.
|
|
5591
5577
|
|
|
@@ -5593,7 +5579,7 @@ Defines the "fill-opacity" attribute for the shapes.
|
|
|
5593
5579
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5594
5580
|
|
|
5595
5581
|
|
|
5596
|
-
<a name="Shape.hover" href="#Shape.hover">#</a> Shape.**hover**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5582
|
+
<a name="Shape.hover" href="#Shape.hover">#</a> Shape.**hover**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L853)
|
|
5597
5583
|
|
|
5598
5584
|
If *value* is specified, sets the highlight accessor to the specified function and returns the current class instance.
|
|
5599
5585
|
|
|
@@ -5601,7 +5587,7 @@ If *value* is specified, sets the highlight accessor to the specified function a
|
|
|
5601
5587
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5602
5588
|
|
|
5603
5589
|
|
|
5604
|
-
<a name="Shape.hoverStyle" href="#Shape.hoverStyle">#</a> Shape.**hoverStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5590
|
+
<a name="Shape.hoverStyle" href="#Shape.hoverStyle">#</a> Shape.**hoverStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L872)
|
|
5605
5591
|
|
|
5606
5592
|
The style to apply to hovered shapes.
|
|
5607
5593
|
|
|
@@ -5609,7 +5595,7 @@ The style to apply to hovered shapes.
|
|
|
5609
5595
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5610
5596
|
|
|
5611
5597
|
|
|
5612
|
-
<a name="Shape.hoverOpacity" href="#Shape.hoverOpacity">#</a> Shape.**hoverOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5598
|
+
<a name="Shape.hoverOpacity" href="#Shape.hoverOpacity">#</a> Shape.**hoverOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L882)
|
|
5613
5599
|
|
|
5614
5600
|
If *value* is specified, sets the hover opacity to the specified function and returns the current class instance.
|
|
5615
5601
|
|
|
@@ -5617,7 +5603,7 @@ If *value* is specified, sets the hover opacity to the specified function and re
|
|
|
5617
5603
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5618
5604
|
|
|
5619
5605
|
|
|
5620
|
-
<a name="Shape.hitArea" href="#Shape.hitArea">#</a> Shape.**hitArea**([*bounds*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5606
|
+
<a name="Shape.hitArea" href="#Shape.hitArea">#</a> Shape.**hitArea**([*bounds*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L901)
|
|
5621
5607
|
|
|
5622
5608
|
If *bounds* is specified, sets the mouse hit area to the specified function and returns the current class instance. If *bounds* is not specified, returns the current mouse hit area accessor.
|
|
5623
5609
|
|
|
@@ -5637,7 +5623,7 @@ function(d, i, shape) {
|
|
|
5637
5623
|
```
|
|
5638
5624
|
|
|
5639
5625
|
|
|
5640
|
-
<a name="Shape.id" href="#Shape.id">#</a> Shape.**id**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5626
|
+
<a name="Shape.id" href="#Shape.id">#</a> Shape.**id**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L911)
|
|
5641
5627
|
|
|
5642
5628
|
If *value* is specified, sets the id accessor to the specified function and returns the current class instance.
|
|
5643
5629
|
|
|
@@ -5645,7 +5631,7 @@ If *value* is specified, sets the id accessor to the specified function and retu
|
|
|
5645
5631
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5646
5632
|
|
|
5647
5633
|
|
|
5648
|
-
<a name="Shape.label" href="#Shape.label">#</a> Shape.**label**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5634
|
+
<a name="Shape.label" href="#Shape.label">#</a> Shape.**label**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L921)
|
|
5649
5635
|
|
|
5650
5636
|
If *value* is specified, sets the label accessor to the specified function or string and returns the current class instance.
|
|
5651
5637
|
|
|
@@ -5653,7 +5639,7 @@ If *value* is specified, sets the label accessor to the specified function or st
|
|
|
5653
5639
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5654
5640
|
|
|
5655
5641
|
|
|
5656
|
-
<a name="Shape.labelBounds" href="#Shape.labelBounds">#</a> Shape.**labelBounds**([*bounds*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5642
|
+
<a name="Shape.labelBounds" href="#Shape.labelBounds">#</a> Shape.**labelBounds**([*bounds*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L940)
|
|
5657
5643
|
|
|
5658
5644
|
If *bounds* is specified, sets the label bounds to the specified function and returns the current class instance. If *bounds* is not specified, returns the current inner bounds accessor.
|
|
5659
5645
|
|
|
@@ -5673,7 +5659,7 @@ function(d, i, shape) {
|
|
|
5673
5659
|
```
|
|
5674
5660
|
|
|
5675
5661
|
|
|
5676
|
-
<a name="Shape.labelConfig" href="#Shape.labelConfig">#</a> Shape.**labelConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5662
|
+
<a name="Shape.labelConfig" href="#Shape.labelConfig">#</a> Shape.**labelConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L950)
|
|
5677
5663
|
|
|
5678
5664
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
5679
5665
|
|
|
@@ -5681,7 +5667,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
5681
5667
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5682
5668
|
|
|
5683
5669
|
|
|
5684
|
-
<a name="Shape.opacity" href="#Shape.opacity">#</a> Shape.**opacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5670
|
+
<a name="Shape.opacity" href="#Shape.opacity">#</a> Shape.**opacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L960)
|
|
5685
5671
|
|
|
5686
5672
|
If *value* is specified, sets the opacity accessor to the specified function or number and returns the current class instance.
|
|
5687
5673
|
|
|
@@ -5689,7 +5675,7 @@ If *value* is specified, sets the opacity accessor to the specified function or
|
|
|
5689
5675
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5690
5676
|
|
|
5691
5677
|
|
|
5692
|
-
<a name="Shape.pointerEvents" href="#Shape.pointerEvents">#</a> Shape.**pointerEvents**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5678
|
+
<a name="Shape.pointerEvents" href="#Shape.pointerEvents">#</a> Shape.**pointerEvents**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L970)
|
|
5693
5679
|
|
|
5694
5680
|
If *value* is specified, sets the pointerEvents accessor to the specified function or string and returns the current class instance.
|
|
5695
5681
|
|
|
@@ -5697,7 +5683,7 @@ If *value* is specified, sets the pointerEvents accessor to the specified functi
|
|
|
5697
5683
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5698
5684
|
|
|
5699
5685
|
|
|
5700
|
-
<a name="Shape.role" href="#Shape.role">#</a> Shape.**role**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5686
|
+
<a name="Shape.role" href="#Shape.role">#</a> Shape.**role**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L980)
|
|
5701
5687
|
|
|
5702
5688
|
If *value* is specified, sets the role attribute to the specified function or string and returns the current class instance.
|
|
5703
5689
|
|
|
@@ -5705,7 +5691,7 @@ If *value* is specified, sets the role attribute to the specified function or st
|
|
|
5705
5691
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5706
5692
|
|
|
5707
5693
|
|
|
5708
|
-
<a name="Shape.rotate" href="#Shape.rotate">#</a> Shape.**rotate**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5694
|
+
<a name="Shape.rotate" href="#Shape.rotate">#</a> Shape.**rotate**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L992)
|
|
5709
5695
|
|
|
5710
5696
|
If *value* is specified, sets the rotate accessor to the specified function or number and returns the current class instance.
|
|
5711
5697
|
|
|
@@ -5713,7 +5699,7 @@ If *value* is specified, sets the rotate accessor to the specified function or n
|
|
|
5713
5699
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5714
5700
|
|
|
5715
5701
|
|
|
5716
|
-
<a name="Shape.rx" href="#Shape.rx">#</a> Shape.**rx**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5702
|
+
<a name="Shape.rx" href="#Shape.rx">#</a> Shape.**rx**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1002)
|
|
5717
5703
|
|
|
5718
5704
|
Defines the "rx" attribute for the shapes.
|
|
5719
5705
|
|
|
@@ -5721,7 +5707,7 @@ Defines the "rx" attribute for the shapes.
|
|
|
5721
5707
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5722
5708
|
|
|
5723
5709
|
|
|
5724
|
-
<a name="Shape.ry" href="#Shape.ry">#</a> Shape.**ry**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5710
|
+
<a name="Shape.ry" href="#Shape.ry">#</a> Shape.**ry**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1012)
|
|
5725
5711
|
|
|
5726
5712
|
Defines the "rx" attribute for the shapes.
|
|
5727
5713
|
|
|
@@ -5729,7 +5715,7 @@ Defines the "rx" attribute for the shapes.
|
|
|
5729
5715
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5730
5716
|
|
|
5731
5717
|
|
|
5732
|
-
<a name="Shape.scale" href="#Shape.scale">#</a> Shape.**scale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5718
|
+
<a name="Shape.scale" href="#Shape.scale">#</a> Shape.**scale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1022)
|
|
5733
5719
|
|
|
5734
5720
|
If *value* is specified, sets the scale accessor to the specified function or string and returns the current class instance.
|
|
5735
5721
|
|
|
@@ -5737,7 +5723,7 @@ If *value* is specified, sets the scale accessor to the specified function or st
|
|
|
5737
5723
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5738
5724
|
|
|
5739
5725
|
|
|
5740
|
-
<a name="Shape.select" href="#Shape.select">#</a> Shape.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5726
|
+
<a name="Shape.select" href="#Shape.select">#</a> Shape.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1032)
|
|
5741
5727
|
|
|
5742
5728
|
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.
|
|
5743
5729
|
|
|
@@ -5745,7 +5731,7 @@ If *selector* is specified, sets the SVG container element to the specified d3 s
|
|
|
5745
5731
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5746
5732
|
|
|
5747
5733
|
|
|
5748
|
-
<a name="Shape.shapeRendering" href="#Shape.shapeRendering">#</a> Shape.**shapeRendering**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5734
|
+
<a name="Shape.shapeRendering" href="#Shape.shapeRendering">#</a> Shape.**shapeRendering**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1046)
|
|
5749
5735
|
|
|
5750
5736
|
If *value* is specified, sets the shape-rendering accessor to the specified function or string and returns the current class instance.
|
|
5751
5737
|
|
|
@@ -5760,7 +5746,7 @@ function(d) {
|
|
|
5760
5746
|
```
|
|
5761
5747
|
|
|
5762
5748
|
|
|
5763
|
-
<a name="Shape.sort" href="#Shape.sort">#</a> Shape.**sort**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5749
|
+
<a name="Shape.sort" href="#Shape.sort">#</a> Shape.**sort**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1056)
|
|
5764
5750
|
|
|
5765
5751
|
If *value* is specified, sets the sort comparator to the specified function and returns the current class instance.
|
|
5766
5752
|
|
|
@@ -5768,7 +5754,7 @@ If *value* is specified, sets the sort comparator to the specified function and
|
|
|
5768
5754
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5769
5755
|
|
|
5770
5756
|
|
|
5771
|
-
<a name="Shape.stroke" href="#Shape.stroke">#</a> Shape.**stroke**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5757
|
+
<a name="Shape.stroke" href="#Shape.stroke">#</a> Shape.**stroke**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1066)
|
|
5772
5758
|
|
|
5773
5759
|
If *value* is specified, sets the stroke accessor to the specified function or string and returns the current class instance.
|
|
5774
5760
|
|
|
@@ -5776,7 +5762,7 @@ If *value* is specified, sets the stroke accessor to the specified function or s
|
|
|
5776
5762
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5777
5763
|
|
|
5778
5764
|
|
|
5779
|
-
<a name="Shape.strokeDasharray" href="#Shape.strokeDasharray">#</a> Shape.**strokeDasharray**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5765
|
+
<a name="Shape.strokeDasharray" href="#Shape.strokeDasharray">#</a> Shape.**strokeDasharray**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1076)
|
|
5780
5766
|
|
|
5781
5767
|
Defines the "stroke-dasharray" attribute for the shapes.
|
|
5782
5768
|
|
|
@@ -5784,7 +5770,7 @@ Defines the "stroke-dasharray" attribute for the shapes.
|
|
|
5784
5770
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5785
5771
|
|
|
5786
5772
|
|
|
5787
|
-
<a name="Shape.strokeLinecap" href="#Shape.strokeLinecap">#</a> Shape.**strokeLinecap**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5773
|
+
<a name="Shape.strokeLinecap" href="#Shape.strokeLinecap">#</a> Shape.**strokeLinecap**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1086)
|
|
5788
5774
|
|
|
5789
5775
|
Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.
|
|
5790
5776
|
|
|
@@ -5792,7 +5778,7 @@ Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"but
|
|
|
5792
5778
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5793
5779
|
|
|
5794
5780
|
|
|
5795
|
-
<a name="Shape.strokeOpacity" href="#Shape.strokeOpacity">#</a> Shape.**strokeOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5781
|
+
<a name="Shape.strokeOpacity" href="#Shape.strokeOpacity">#</a> Shape.**strokeOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1096)
|
|
5796
5782
|
|
|
5797
5783
|
Defines the "stroke-opacity" attribute for the shapes.
|
|
5798
5784
|
|
|
@@ -5800,7 +5786,7 @@ Defines the "stroke-opacity" attribute for the shapes.
|
|
|
5800
5786
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5801
5787
|
|
|
5802
5788
|
|
|
5803
|
-
<a name="Shape.strokeWidth" href="#Shape.strokeWidth">#</a> Shape.**strokeWidth**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5789
|
+
<a name="Shape.strokeWidth" href="#Shape.strokeWidth">#</a> Shape.**strokeWidth**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1106)
|
|
5804
5790
|
|
|
5805
5791
|
If *value* is specified, sets the stroke-width accessor to the specified function or string and returns the current class instance.
|
|
5806
5792
|
|
|
@@ -5808,7 +5794,7 @@ If *value* is specified, sets the stroke-width accessor to the specified functio
|
|
|
5808
5794
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5809
5795
|
|
|
5810
5796
|
|
|
5811
|
-
<a name="Shape.textAnchor" href="#Shape.textAnchor">#</a> Shape.**textAnchor**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5797
|
+
<a name="Shape.textAnchor" href="#Shape.textAnchor">#</a> Shape.**textAnchor**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1116)
|
|
5812
5798
|
|
|
5813
5799
|
If *value* is specified, sets the text-anchor accessor to the specified function or string and returns the current class instance.
|
|
5814
5800
|
|
|
@@ -5816,7 +5802,7 @@ If *value* is specified, sets the text-anchor accessor to the specified function
|
|
|
5816
5802
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5817
5803
|
|
|
5818
5804
|
|
|
5819
|
-
<a name="Shape.texture" href="#Shape.texture">#</a> Shape.**texture**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5805
|
+
<a name="Shape.texture" href="#Shape.texture">#</a> Shape.**texture**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1126)
|
|
5820
5806
|
|
|
5821
5807
|
Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.
|
|
5822
5808
|
|
|
@@ -5824,7 +5810,7 @@ Defines the texture used inside of each shape. This uses the [textures.js](https
|
|
|
5824
5810
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5825
5811
|
|
|
5826
5812
|
|
|
5827
|
-
<a name="Shape.textureDefault" href="#Shape.textureDefault">#</a> Shape.**textureDefault**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5813
|
+
<a name="Shape.textureDefault" href="#Shape.textureDefault">#</a> Shape.**textureDefault**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1136)
|
|
5828
5814
|
|
|
5829
5815
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
5830
5816
|
|
|
@@ -5832,7 +5818,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
5832
5818
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5833
5819
|
|
|
5834
5820
|
|
|
5835
|
-
<a name="Shape.vectorEffect" href="#Shape.vectorEffect">#</a> Shape.**vectorEffect**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5821
|
+
<a name="Shape.vectorEffect" href="#Shape.vectorEffect">#</a> Shape.**vectorEffect**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1146)
|
|
5836
5822
|
|
|
5837
5823
|
If *value* is specified, sets the vector-effect accessor to the specified function or string and returns the current class instance.
|
|
5838
5824
|
|
|
@@ -5840,7 +5826,7 @@ If *value* is specified, sets the vector-effect accessor to the specified functi
|
|
|
5840
5826
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5841
5827
|
|
|
5842
5828
|
|
|
5843
|
-
<a name="Shape.verticalAlign" href="#Shape.verticalAlign">#</a> Shape.**verticalAlign**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5829
|
+
<a name="Shape.verticalAlign" href="#Shape.verticalAlign">#</a> Shape.**verticalAlign**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1156)
|
|
5844
5830
|
|
|
5845
5831
|
If *value* is specified, sets the vertical alignment accessor to the specified function or string and returns the current class instance.
|
|
5846
5832
|
|
|
@@ -5848,7 +5834,7 @@ If *value* is specified, sets the vertical alignment accessor to the specified f
|
|
|
5848
5834
|
This is a static method of [<code>Shape</code>](#Shape), and is chainable with other methods of this Class.
|
|
5849
5835
|
|
|
5850
5836
|
|
|
5851
|
-
<a name="Shape.x" href="#Shape.x">#</a> Shape.**x**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5837
|
+
<a name="Shape.x" href="#Shape.x">#</a> Shape.**x**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1170)
|
|
5852
5838
|
|
|
5853
5839
|
If *value* is specified, sets the x accessor to the specified function or number and returns the current class instance.
|
|
5854
5840
|
|
|
@@ -5863,7 +5849,7 @@ function(d) {
|
|
|
5863
5849
|
```
|
|
5864
5850
|
|
|
5865
5851
|
|
|
5866
|
-
<a name="Shape.y" href="#Shape.y">#</a> Shape.**y**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#
|
|
5852
|
+
<a name="Shape.y" href="#Shape.y">#</a> Shape.**y**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.js#L1184)
|
|
5867
5853
|
|
|
5868
5854
|
If *value* is specified, sets the y accessor to the specified function or number and returns the current class instance.
|
|
5869
5855
|
|
|
@@ -6100,47 +6086,6 @@ For example, if we wanted to only change the string "Back" and allow a
|
|
|
6100
6086
|
|
|
6101
6087
|
---
|
|
6102
6088
|
|
|
6103
|
-
<a name="defaultPadding"></a>
|
|
6104
|
-
#### d3plus.**defaultPadding**() [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L46)
|
|
6105
|
-
|
|
6106
|
-
Default padding logic that will return false if the screen is less than 600 pixels wide.
|
|
6107
|
-
|
|
6108
|
-
|
|
6109
|
-
This is a global function
|
|
6110
|
-
|
|
6111
|
-
---
|
|
6112
|
-
|
|
6113
|
-
<a name="listify"></a>
|
|
6114
|
-
#### d3plus.**listify**() [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L53)
|
|
6115
|
-
|
|
6116
|
-
Turns an array of values into a list string.
|
|
6117
|
-
|
|
6118
|
-
|
|
6119
|
-
This is a global function
|
|
6120
|
-
|
|
6121
|
-
---
|
|
6122
|
-
|
|
6123
|
-
<a name="_thresholdFunction"></a>
|
|
6124
|
-
#### d3plus.**_thresholdFunction**(data) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L547)
|
|
6125
|
-
|
|
6126
|
-
Applies the threshold algorithm according to the type of chart used.
|
|
6127
|
-
|
|
6128
|
-
|
|
6129
|
-
This is a global function
|
|
6130
|
-
|
|
6131
|
-
---
|
|
6132
|
-
|
|
6133
|
-
<a name="generateReference"></a>
|
|
6134
|
-
#### d3plus.**generateReference**(position) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Tooltip.js#L15)
|
|
6135
|
-
|
|
6136
|
-
Creates a reference element for popper.
|
|
6137
|
-
|
|
6138
|
-
|
|
6139
|
-
This is a global function
|
|
6140
|
-
**Prrivate**:
|
|
6141
|
-
|
|
6142
|
-
---
|
|
6143
|
-
|
|
6144
6089
|
<a name="accessor"></a>
|
|
6145
6090
|
#### d3plus.**accessor**(key, [def]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/accessor.js#L1)
|
|
6146
6091
|
|
|
@@ -6215,5 +6160,3 @@ This is a global constant
|
|
|
6215
6160
|
|
|
6216
6161
|
---
|
|
6217
6162
|
|
|
6218
|
-
|
|
6219
|
-
###### <sub>Documentation generated on Wed, 02 Apr 2025 20:59:31 GMT</sub>
|