@d3plus/core 3.0.4 → 3.0.6
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 +146 -160
- package/es/src/charts/BoxWhisker.js +0 -4
- package/es/src/charts/Plot.js +1 -3
- package/es/src/charts/Tree.js +64 -30
- package/es/src/charts/Viz.js +4 -8
- package/es/src/charts/drawSteps/drawLegend.js +3 -1
- package/es/src/components/Axis.js +3 -2
- package/package.json +8 -8
- package/umd/d3plus-core.full.js +56 -42
- package/umd/d3plus-core.full.js.map +1 -1
- package/umd/d3plus-core.full.min.js +18 -22
- package/umd/d3plus-core.js +55 -41
- package/umd/d3plus-core.js.map +1 -1
- package/umd/d3plus-core.min.js +110 -114
package/README.md
CHANGED
|
@@ -141,13 +141,6 @@ Creates a simple box and whisker based on an array of data.
|
|
|
141
141
|
|
|
142
142
|
|
|
143
143
|
|
|
144
|
-
the equivalent of calling:
|
|
145
|
-
|
|
146
|
-
```js
|
|
147
|
-
new d3plus.Plot()
|
|
148
|
-
.discrete("x")
|
|
149
|
-
.shape("Box")
|
|
150
|
-
```
|
|
151
144
|
|
|
152
145
|
---
|
|
153
146
|
|
|
@@ -935,7 +928,7 @@ Creates an x/y plot based on an array of data.
|
|
|
935
928
|
|
|
936
929
|
|
|
937
930
|
|
|
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#
|
|
931
|
+
<a name="Plot.annotations" href="#Plot.annotations">#</a> Plot.**annotations**(*annotations*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1485)
|
|
939
932
|
|
|
940
933
|
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).
|
|
941
934
|
|
|
@@ -945,7 +938,7 @@ Additionally, each config object can also contain an optional "layer" key, which
|
|
|
945
938
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
946
939
|
|
|
947
940
|
|
|
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#
|
|
941
|
+
<a name="Plot.axisPersist" href="#Plot.axisPersist">#</a> Plot.**axisPersist**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1495)
|
|
949
942
|
|
|
950
943
|
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).
|
|
951
944
|
|
|
@@ -953,7 +946,7 @@ Determines whether the x and y axes should have their scales persist while users
|
|
|
953
946
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
954
947
|
|
|
955
948
|
|
|
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#
|
|
949
|
+
<a name="Plot.backgroundConfig" href="#Plot.backgroundConfig">#</a> Plot.**backgroundConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1505)
|
|
957
950
|
|
|
958
951
|
A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).
|
|
959
952
|
|
|
@@ -961,7 +954,7 @@ A d3plus-shape configuration Object used for styling the background rectangle of
|
|
|
961
954
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
962
955
|
|
|
963
956
|
|
|
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#
|
|
957
|
+
<a name="Plot.barPadding" href="#Plot.barPadding">#</a> Plot.**barPadding**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1515)
|
|
965
958
|
|
|
966
959
|
Sets the pixel space between each bar in a group of bars.
|
|
967
960
|
|
|
@@ -969,7 +962,7 @@ Sets the pixel space between each bar in a group of bars.
|
|
|
969
962
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
970
963
|
|
|
971
964
|
|
|
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#
|
|
965
|
+
<a name="Plot.baseline" href="#Plot.baseline">#</a> Plot.**baseline**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1525)
|
|
973
966
|
|
|
974
967
|
Sets the baseline for the x/y plot. If *value* is not specified, returns the current baseline.
|
|
975
968
|
|
|
@@ -977,7 +970,7 @@ Sets the baseline for the x/y plot. If *value* is not specified, returns the cur
|
|
|
977
970
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
978
971
|
|
|
979
972
|
|
|
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#
|
|
973
|
+
<a name="Plot.buffer" href="#Plot.buffer">#</a> Plot.**buffer**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1535)
|
|
981
974
|
|
|
982
975
|
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}`).
|
|
983
976
|
|
|
@@ -985,7 +978,7 @@ Determines whether or not to add additional padding at the ends of x or y scales
|
|
|
985
978
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
986
979
|
|
|
987
980
|
|
|
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#
|
|
981
|
+
<a name="Plot.confidence" href="#Plot.confidence">#</a> Plot.**confidence**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1564)
|
|
989
982
|
|
|
990
983
|
Sets the confidence to the specified array of lower and upper bounds.
|
|
991
984
|
|
|
@@ -1004,7 +997,7 @@ Can be called with accessor functions or static keys:
|
|
|
1004
997
|
```
|
|
1005
998
|
|
|
1006
999
|
|
|
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#
|
|
1000
|
+
<a name="Plot.confidenceConfig" href="#Plot.confidenceConfig">#</a> Plot.**confidenceConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1583)
|
|
1008
1001
|
|
|
1009
1002
|
If *value* is specified, sets the config method for each shape rendered as a confidence interval and returns the current class instance.
|
|
1010
1003
|
|
|
@@ -1012,7 +1005,7 @@ If *value* is specified, sets the config method for each shape rendered as a con
|
|
|
1012
1005
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1013
1006
|
|
|
1014
1007
|
|
|
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#
|
|
1008
|
+
<a name="Plot.discreteCutoff" href="#Plot.discreteCutoff">#</a> Plot.**discreteCutoff**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1593)
|
|
1016
1009
|
|
|
1017
1010
|
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.
|
|
1018
1011
|
|
|
@@ -1020,7 +1013,7 @@ When the width or height of the chart is less than or equal to this pixel value,
|
|
|
1020
1013
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1021
1014
|
|
|
1022
1015
|
|
|
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#
|
|
1016
|
+
<a name="Plot.groupPadding" href="#Plot.groupPadding">#</a> Plot.**groupPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1603)
|
|
1024
1017
|
|
|
1025
1018
|
Sets the pixel space between groups of bars.
|
|
1026
1019
|
|
|
@@ -1028,7 +1021,7 @@ Sets the pixel space between groups of bars.
|
|
|
1028
1021
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1029
1022
|
|
|
1030
1023
|
|
|
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#
|
|
1024
|
+
<a name="Plot.labelConnectorConfig" href="#Plot.labelConnectorConfig">#</a> Plot.**labelConnectorConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1613)
|
|
1032
1025
|
|
|
1033
1026
|
The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.
|
|
1034
1027
|
|
|
@@ -1036,7 +1029,7 @@ The d3plus-shape config used on the Line shapes created to connect lineLabels to
|
|
|
1036
1029
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1037
1030
|
|
|
1038
1031
|
|
|
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#
|
|
1032
|
+
<a name="Plot.lineLabels" href="#Plot.lineLabels">#</a> Plot.**lineLabels**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1633)
|
|
1040
1033
|
|
|
1041
1034
|
Draws labels on the right side of any Line shapes that are drawn on the plot.
|
|
1042
1035
|
|
|
@@ -1044,7 +1037,7 @@ Draws labels on the right side of any Line shapes that are drawn on the plot.
|
|
|
1044
1037
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1045
1038
|
|
|
1046
1039
|
|
|
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#
|
|
1040
|
+
<a name="Plot.lineMarkerConfig" href="#Plot.lineMarkerConfig">#</a> Plot.**lineMarkerConfig**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1643)
|
|
1048
1041
|
|
|
1049
1042
|
Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
1050
1043
|
|
|
@@ -1052,7 +1045,7 @@ Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
|
1052
1045
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1053
1046
|
|
|
1054
1047
|
|
|
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#
|
|
1048
|
+
<a name="Plot.lineMarkers" href="#Plot.lineMarkers">#</a> Plot.**lineMarkers**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1653)
|
|
1056
1049
|
|
|
1057
1050
|
Draws circle markers on each vertex of a Line.
|
|
1058
1051
|
|
|
@@ -1060,7 +1053,7 @@ Draws circle markers on each vertex of a Line.
|
|
|
1060
1053
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1061
1054
|
|
|
1062
1055
|
|
|
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#
|
|
1056
|
+
<a name="Plot.shapeSort" href="#Plot.shapeSort">#</a> Plot.**shapeSort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1663)
|
|
1064
1057
|
|
|
1065
1058
|
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.
|
|
1066
1059
|
|
|
@@ -1068,7 +1061,7 @@ A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs
|
|
|
1068
1061
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1069
1062
|
|
|
1070
1063
|
|
|
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#
|
|
1064
|
+
<a name="Plot.size" href="#Plot.size">#</a> Plot.**size**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1673)
|
|
1072
1065
|
|
|
1073
1066
|
Sets the size of bubbles to the given Number, data key, or function.
|
|
1074
1067
|
|
|
@@ -1076,7 +1069,7 @@ Sets the size of bubbles to the given Number, data key, or function.
|
|
|
1076
1069
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1077
1070
|
|
|
1078
1071
|
|
|
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#
|
|
1072
|
+
<a name="Plot.sizeMax" href="#Plot.sizeMax">#</a> Plot.**sizeMax**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1683)
|
|
1080
1073
|
|
|
1081
1074
|
Sets the size scale maximum to the specified number.
|
|
1082
1075
|
|
|
@@ -1084,7 +1077,7 @@ Sets the size scale maximum to the specified number.
|
|
|
1084
1077
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1085
1078
|
|
|
1086
1079
|
|
|
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#
|
|
1080
|
+
<a name="Plot.sizeMin" href="#Plot.sizeMin">#</a> Plot.**sizeMin**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1693)
|
|
1088
1081
|
|
|
1089
1082
|
Sets the size scale minimum to the specified number.
|
|
1090
1083
|
|
|
@@ -1092,7 +1085,7 @@ Sets the size scale minimum to the specified number.
|
|
|
1092
1085
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1093
1086
|
|
|
1094
1087
|
|
|
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#
|
|
1088
|
+
<a name="Plot.sizeScale" href="#Plot.sizeScale">#</a> Plot.**sizeScale**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1703)
|
|
1096
1089
|
|
|
1097
1090
|
Sets the size scale to the specified string.
|
|
1098
1091
|
|
|
@@ -1100,7 +1093,7 @@ Sets the size scale to the specified string.
|
|
|
1100
1093
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1101
1094
|
|
|
1102
1095
|
|
|
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#
|
|
1096
|
+
<a name="Plot.stacked" href="#Plot.stacked">#</a> Plot.**stacked**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1713)
|
|
1104
1097
|
|
|
1105
1098
|
If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.
|
|
1106
1099
|
|
|
@@ -1108,7 +1101,7 @@ If *value* is specified, toggles shape stacking. If *value* is not specified, re
|
|
|
1108
1101
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1109
1102
|
|
|
1110
1103
|
|
|
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#
|
|
1104
|
+
<a name="Plot.stackOffset" href="#Plot.stackOffset">#</a> Plot.**stackOffset**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1723)
|
|
1112
1105
|
|
|
1113
1106
|
Sets the stack offset. If *value* is not specified, returns the current stack offset function.
|
|
1114
1107
|
|
|
@@ -1116,7 +1109,7 @@ Sets the stack offset. If *value* is not specified, returns the current stack of
|
|
|
1116
1109
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1117
1110
|
|
|
1118
1111
|
|
|
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#
|
|
1112
|
+
<a name="Plot.stackOrder" href="#Plot.stackOrder">#</a> Plot.**stackOrder**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1733)
|
|
1120
1113
|
|
|
1121
1114
|
Sets the stack order. If *value* is not specified, returns the current stack order function.
|
|
1122
1115
|
|
|
@@ -1124,7 +1117,7 @@ Sets the stack order. If *value* is not specified, returns the current stack ord
|
|
|
1124
1117
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1125
1118
|
|
|
1126
1119
|
|
|
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#
|
|
1120
|
+
<a name="Plot.x" href="#Plot.x">#</a> Plot.**x**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1748)
|
|
1128
1121
|
|
|
1129
1122
|
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.
|
|
1130
1123
|
|
|
@@ -1132,7 +1125,7 @@ Sets the x accessor to the specified accessor Function or String representing wh
|
|
|
1132
1125
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1133
1126
|
|
|
1134
1127
|
|
|
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#
|
|
1128
|
+
<a name="Plot.x2" href="#Plot.x2">#</a> Plot.**x2**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1766)
|
|
1136
1129
|
|
|
1137
1130
|
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.
|
|
1138
1131
|
|
|
@@ -1140,7 +1133,7 @@ Sets the x2 accessor to the specified accessor Function or String representing w
|
|
|
1140
1133
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1141
1134
|
|
|
1142
1135
|
|
|
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#
|
|
1136
|
+
<a name="Plot.xConfig" href="#Plot.xConfig">#</a> Plot.**xConfig**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1784)
|
|
1144
1137
|
|
|
1145
1138
|
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.
|
|
1146
1139
|
|
|
@@ -1148,7 +1141,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
1148
1141
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1149
1142
|
|
|
1150
1143
|
|
|
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#
|
|
1144
|
+
<a name="Plot.xCutoff" href="#Plot.xCutoff">#</a> Plot.**xCutoff**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1794)
|
|
1152
1145
|
|
|
1153
1146
|
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.
|
|
1154
1147
|
|
|
@@ -1156,7 +1149,7 @@ When the width of the chart is less than or equal to this pixel value, and the x
|
|
|
1156
1149
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1157
1150
|
|
|
1158
1151
|
|
|
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#
|
|
1152
|
+
<a name="Plot.x2Config" href="#Plot.x2Config">#</a> Plot.**x2Config**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1804)
|
|
1160
1153
|
|
|
1161
1154
|
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.
|
|
1162
1155
|
|
|
@@ -1164,7 +1157,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
1164
1157
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1165
1158
|
|
|
1166
1159
|
|
|
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#
|
|
1160
|
+
<a name="Plot.xDomain" href="#Plot.xDomain">#</a> Plot.**xDomain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1814)
|
|
1168
1161
|
|
|
1169
1162
|
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.
|
|
1170
1163
|
|
|
@@ -1172,7 +1165,7 @@ Sets the x domain to the specified array. If *value* is not specified, returns t
|
|
|
1172
1165
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1173
1166
|
|
|
1174
1167
|
|
|
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#
|
|
1168
|
+
<a name="Plot.x2Domain" href="#Plot.x2Domain">#</a> Plot.**x2Domain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1824)
|
|
1176
1169
|
|
|
1177
1170
|
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.
|
|
1178
1171
|
|
|
@@ -1180,7 +1173,7 @@ Sets the x2 domain to the specified array. If *value* is not specified, returns
|
|
|
1180
1173
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1181
1174
|
|
|
1182
1175
|
|
|
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#
|
|
1176
|
+
<a name="Plot.xSort" href="#Plot.xSort">#</a> Plot.**xSort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1834)
|
|
1184
1177
|
|
|
1185
1178
|
Defines a custom sorting comparitor function to be used for discrete x axes.
|
|
1186
1179
|
|
|
@@ -1188,7 +1181,7 @@ Defines a custom sorting comparitor function to be used for discrete x axes.
|
|
|
1188
1181
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1189
1182
|
|
|
1190
1183
|
|
|
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#
|
|
1184
|
+
<a name="Plot.x2Sort" href="#Plot.x2Sort">#</a> Plot.**x2Sort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1844)
|
|
1192
1185
|
|
|
1193
1186
|
Defines a custom sorting comparitor function to be used for discrete x2 axes.
|
|
1194
1187
|
|
|
@@ -1196,7 +1189,7 @@ Defines a custom sorting comparitor function to be used for discrete x2 axes.
|
|
|
1196
1189
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1197
1190
|
|
|
1198
1191
|
|
|
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#
|
|
1192
|
+
<a name="Plot.y" href="#Plot.y">#</a> Plot.**y**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1854)
|
|
1200
1193
|
|
|
1201
1194
|
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.
|
|
1202
1195
|
|
|
@@ -1204,7 +1197,7 @@ Sets the y accessor to the specified accessor Function or String representing wh
|
|
|
1204
1197
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1205
1198
|
|
|
1206
1199
|
|
|
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#
|
|
1200
|
+
<a name="Plot.y2" href="#Plot.y2">#</a> Plot.**y2**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1872)
|
|
1208
1201
|
|
|
1209
1202
|
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.
|
|
1210
1203
|
|
|
@@ -1212,7 +1205,7 @@ Sets the y2 accessor to the specified accessor Function or String representing w
|
|
|
1212
1205
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1213
1206
|
|
|
1214
1207
|
|
|
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#
|
|
1208
|
+
<a name="Plot.yConfig" href="#Plot.yConfig">#</a> Plot.**yConfig**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1892)
|
|
1216
1209
|
|
|
1217
1210
|
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.
|
|
1218
1211
|
Note:* If a "domain" array is passed to the y-axis config, it will be reversed.
|
|
@@ -1221,7 +1214,7 @@ Note:* If a "domain" array is passed to the y-axis config, it will be reversed.
|
|
|
1221
1214
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1222
1215
|
|
|
1223
1216
|
|
|
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#
|
|
1217
|
+
<a name="Plot.yCutoff" href="#Plot.yCutoff">#</a> Plot.**yCutoff**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1907)
|
|
1225
1218
|
|
|
1226
1219
|
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.
|
|
1227
1220
|
|
|
@@ -1229,7 +1222,7 @@ When the height of the chart is less than or equal to this pixel value, and the
|
|
|
1229
1222
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1230
1223
|
|
|
1231
1224
|
|
|
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#
|
|
1225
|
+
<a name="Plot.y2Config" href="#Plot.y2Config">#</a> Plot.**y2Config**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1917)
|
|
1233
1226
|
|
|
1234
1227
|
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.
|
|
1235
1228
|
|
|
@@ -1237,7 +1230,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
1237
1230
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1238
1231
|
|
|
1239
1232
|
|
|
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#
|
|
1233
|
+
<a name="Plot.yDomain" href="#Plot.yDomain">#</a> Plot.**yDomain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1932)
|
|
1241
1234
|
|
|
1242
1235
|
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.
|
|
1243
1236
|
|
|
@@ -1245,7 +1238,7 @@ Sets the y domain to the specified array. If *value* is not specified, returns t
|
|
|
1245
1238
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1246
1239
|
|
|
1247
1240
|
|
|
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#
|
|
1241
|
+
<a name="Plot.y2Domain" href="#Plot.y2Domain">#</a> Plot.**y2Domain**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1942)
|
|
1249
1242
|
|
|
1250
1243
|
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.
|
|
1251
1244
|
|
|
@@ -1253,7 +1246,7 @@ Sets the y2 domain to the specified array. If *value* is not specified, returns
|
|
|
1253
1246
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1254
1247
|
|
|
1255
1248
|
|
|
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#
|
|
1249
|
+
<a name="Plot.ySort" href="#Plot.ySort">#</a> Plot.**ySort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1952)
|
|
1257
1250
|
|
|
1258
1251
|
Defines a custom sorting comparitor function to be used for discrete y axes.
|
|
1259
1252
|
|
|
@@ -1261,7 +1254,7 @@ Defines a custom sorting comparitor function to be used for discrete y axes.
|
|
|
1261
1254
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1262
1255
|
|
|
1263
1256
|
|
|
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#
|
|
1257
|
+
<a name="Plot.y2Sort" href="#Plot.y2Sort">#</a> Plot.**y2Sort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1962)
|
|
1265
1258
|
|
|
1266
1259
|
Defines a custom sorting comparitor function to be used for discrete y2 axes.
|
|
1267
1260
|
|
|
@@ -1787,7 +1780,7 @@ new d3plus.AreaPlot()
|
|
|
1787
1780
|
---
|
|
1788
1781
|
|
|
1789
1782
|
<a name="Tree"></a>
|
|
1790
|
-
#### **Tree** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Tree.js#
|
|
1783
|
+
#### **Tree** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Tree.js#L14)
|
|
1791
1784
|
|
|
1792
1785
|
|
|
1793
1786
|
This is a global class, and extends all of the methods and functionality of [<code>Viz</code>](#Viz).
|
|
@@ -1807,15 +1800,15 @@ Uses d3's [tree layout](https://github.com/d3/d3-hierarchy#tree) to create a tid
|
|
|
1807
1800
|
|
|
1808
1801
|
|
|
1809
1802
|
|
|
1810
|
-
<a name="Tree.orient" href="#Tree.orient">#</a> Tree.**orient**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Tree.js#
|
|
1803
|
+
<a name="Tree.orient" href="#Tree.orient">#</a> Tree.**orient**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Tree.js#L235)
|
|
1811
1804
|
|
|
1812
|
-
|
|
1805
|
+
Changes the orientation of the entire Tree, either "vertical" (top to bottom) or "horizontal" (left to right).
|
|
1813
1806
|
|
|
1814
1807
|
|
|
1815
1808
|
This is a static method of [<code>Tree</code>](#Tree)
|
|
1816
1809
|
|
|
1817
1810
|
|
|
1818
|
-
<a name="Tree.separation" href="#Tree.separation">#</a> Tree.**separation**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Tree.js#
|
|
1811
|
+
<a name="Tree.separation" href="#Tree.separation">#</a> Tree.**separation**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Tree.js#L251)
|
|
1819
1812
|
|
|
1820
1813
|
If *value* is specified, sets the separation accessor to the specified function. If *value* is not specified, returns the current separation accessor.
|
|
1821
1814
|
|
|
@@ -2016,7 +2009,7 @@ Creates an x/y plot based on an array of data. If *data* is specified, immediate
|
|
|
2016
2009
|
|
|
2017
2010
|
|
|
2018
2011
|
|
|
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#
|
|
2012
|
+
<a name="Viz.labelPosition" href="#Viz.labelPosition">#</a> Viz.**labelPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L1623)
|
|
2020
2013
|
|
|
2021
2014
|
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.
|
|
2022
2015
|
|
|
@@ -2256,22 +2249,15 @@ If *value* is specified, sets the filter to the specified function and returns t
|
|
|
2256
2249
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2257
2250
|
|
|
2258
2251
|
|
|
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#
|
|
2252
|
+
<a name="Viz.groupBy" href="#Viz.groupBy">#</a> Viz.**groupBy**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1084)
|
|
2260
2253
|
|
|
2261
|
-
|
|
2254
|
+
Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.
|
|
2262
2255
|
|
|
2263
2256
|
|
|
2264
2257
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2265
2258
|
|
|
2266
2259
|
|
|
2267
|
-
|
|
2268
|
-
function value(d) {
|
|
2269
|
-
return d.id;
|
|
2270
|
-
}
|
|
2271
|
-
```
|
|
2272
|
-
|
|
2273
|
-
|
|
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)
|
|
2260
|
+
<a name="Viz.height" href="#Viz.height">#</a> Viz.**height**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1108)
|
|
2275
2261
|
|
|
2276
2262
|
If *value* is specified, sets the overall height to the specified number and returns the current class instance.
|
|
2277
2263
|
|
|
@@ -2279,7 +2265,7 @@ If *value* is specified, sets the overall height to the specified number and ret
|
|
|
2279
2265
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2280
2266
|
|
|
2281
2267
|
|
|
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#
|
|
2268
|
+
<a name="Viz.hiddenColor" href="#Viz.hiddenColor">#</a> Viz.**hiddenColor**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1118)
|
|
2283
2269
|
|
|
2284
2270
|
Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
2285
2271
|
|
|
@@ -2287,7 +2273,7 @@ Defines the color used for legend shapes when the corresponding grouping is hidd
|
|
|
2287
2273
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2288
2274
|
|
|
2289
2275
|
|
|
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#
|
|
2276
|
+
<a name="Viz.hiddenOpacity" href="#Viz.hiddenOpacity">#</a> Viz.**hiddenOpacity**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1128)
|
|
2291
2277
|
|
|
2292
2278
|
Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
2293
2279
|
|
|
@@ -2295,7 +2281,7 @@ Defines the opacity used for legend labels when the corresponding grouping is hi
|
|
|
2295
2281
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2296
2282
|
|
|
2297
2283
|
|
|
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#
|
|
2284
|
+
<a name="Viz.hover" href="#Viz.hover">#</a> Viz.**hover**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1138)
|
|
2299
2285
|
|
|
2300
2286
|
If *value* is specified, sets the hover method to the specified function and returns the current class instance.
|
|
2301
2287
|
|
|
@@ -2303,7 +2289,7 @@ If *value* is specified, sets the hover method to the specified function and ret
|
|
|
2303
2289
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2304
2290
|
|
|
2305
2291
|
|
|
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#
|
|
2292
|
+
<a name="Viz.label" href="#Viz.label">#</a> Viz.**label**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1176)
|
|
2307
2293
|
|
|
2308
2294
|
If *value* is specified, sets the label accessor to the specified function or string and returns the current class instance.
|
|
2309
2295
|
|
|
@@ -2311,7 +2297,7 @@ If *value* is specified, sets the label accessor to the specified function or st
|
|
|
2311
2297
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2312
2298
|
|
|
2313
2299
|
|
|
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#
|
|
2300
|
+
<a name="Viz.legend" href="#Viz.legend">#</a> Viz.**legend**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1186)
|
|
2315
2301
|
|
|
2316
2302
|
If *value* is specified, toggles the legend based on the specified boolean and returns the current class instance.
|
|
2317
2303
|
|
|
@@ -2319,7 +2305,7 @@ If *value* is specified, toggles the legend based on the specified boolean and r
|
|
|
2319
2305
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2320
2306
|
|
|
2321
2307
|
|
|
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#
|
|
2308
|
+
<a name="Viz.legendConfig" href="#Viz.legendConfig">#</a> Viz.**legendConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1196)
|
|
2323
2309
|
|
|
2324
2310
|
If *value* is specified, the object is passed to the legend's config method.
|
|
2325
2311
|
|
|
@@ -2327,7 +2313,7 @@ If *value* is specified, the object is passed to the legend's config method.
|
|
|
2327
2313
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2328
2314
|
|
|
2329
2315
|
|
|
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#
|
|
2316
|
+
<a name="Viz.legendFilterInvert" href="#Viz.legendFilterInvert">#</a> Viz.**legendFilterInvert**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1206)
|
|
2331
2317
|
|
|
2332
2318
|
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.
|
|
2333
2319
|
|
|
@@ -2335,7 +2321,7 @@ Defines the click functionality of categorical legend squares. When set to false
|
|
|
2335
2321
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2336
2322
|
|
|
2337
2323
|
|
|
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#
|
|
2324
|
+
<a name="Viz.legendPadding" href="#Viz.legendPadding">#</a> Viz.**legendPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1216)
|
|
2339
2325
|
|
|
2340
2326
|
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.
|
|
2341
2327
|
|
|
@@ -2343,7 +2329,7 @@ Tells the legend whether or not to use the internal padding defined by the visua
|
|
|
2343
2329
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2344
2330
|
|
|
2345
2331
|
|
|
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#
|
|
2332
|
+
<a name="Viz.legendPosition" href="#Viz.legendPosition">#</a> Viz.**legendPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1226)
|
|
2347
2333
|
|
|
2348
2334
|
Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.
|
|
2349
2335
|
|
|
@@ -2351,7 +2337,7 @@ Defines which side of the visualization to anchor the legend. Expected values ar
|
|
|
2351
2337
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2352
2338
|
|
|
2353
2339
|
|
|
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#
|
|
2340
|
+
<a name="Viz.legendSort" href="#Viz.legendSort">#</a> Viz.**legendSort**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1236)
|
|
2355
2341
|
|
|
2356
2342
|
A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.
|
|
2357
2343
|
|
|
@@ -2359,7 +2345,7 @@ A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs
|
|
|
2359
2345
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2360
2346
|
|
|
2361
2347
|
|
|
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#
|
|
2348
|
+
<a name="Viz.legendTooltip" href="#Viz.legendTooltip">#</a> Viz.**legendTooltip**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1246)
|
|
2363
2349
|
|
|
2364
2350
|
If *value* is specified, sets the config method for the legend tooltip and returns the current class instance.
|
|
2365
2351
|
|
|
@@ -2367,7 +2353,7 @@ If *value* is specified, sets the config method for the legend tooltip and retur
|
|
|
2367
2353
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2368
2354
|
|
|
2369
2355
|
|
|
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#
|
|
2356
|
+
<a name="Viz.loadingHTML" href="#Viz.loadingHTML">#</a> Viz.**loadingHTML**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1256)
|
|
2371
2357
|
|
|
2372
2358
|
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.
|
|
2373
2359
|
|
|
@@ -2375,7 +2361,7 @@ Sets the inner HTML of the status message that is displayed when loading AJAX re
|
|
|
2375
2361
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2376
2362
|
|
|
2377
2363
|
|
|
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#
|
|
2364
|
+
<a name="Viz.loadingMessage" href="#Viz.loadingMessage">#</a> Viz.**loadingMessage**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1266)
|
|
2379
2365
|
|
|
2380
2366
|
Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.
|
|
2381
2367
|
|
|
@@ -2383,7 +2369,7 @@ Toggles the visibility of the status message that is displayed when loading AJAX
|
|
|
2383
2369
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2384
2370
|
|
|
2385
2371
|
|
|
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#
|
|
2372
|
+
<a name="Viz.messageMask" href="#Viz.messageMask">#</a> Viz.**messageMask**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1276)
|
|
2387
2373
|
|
|
2388
2374
|
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.
|
|
2389
2375
|
|
|
@@ -2391,7 +2377,7 @@ Sets the color of the mask used underneath the status message that is displayed
|
|
|
2391
2377
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2392
2378
|
|
|
2393
2379
|
|
|
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#
|
|
2380
|
+
<a name="Viz.messageStyle" href="#Viz.messageStyle">#</a> Viz.**messageStyle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1286)
|
|
2395
2381
|
|
|
2396
2382
|
Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.
|
|
2397
2383
|
|
|
@@ -2399,7 +2385,7 @@ Defines the CSS style properties for the status message that is displayed when l
|
|
|
2399
2385
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2400
2386
|
|
|
2401
2387
|
|
|
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#
|
|
2388
|
+
<a name="Viz.noDataHTML" href="#Viz.noDataHTML">#</a> Viz.**noDataHTML**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1296)
|
|
2403
2389
|
|
|
2404
2390
|
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.
|
|
2405
2391
|
|
|
@@ -2407,7 +2393,7 @@ Sets the inner HTML of the status message that is displayed when no data is supp
|
|
|
2407
2393
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2408
2394
|
|
|
2409
2395
|
|
|
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#
|
|
2396
|
+
<a name="Viz.noDataMessage" href="#Viz.noDataMessage">#</a> Viz.**noDataMessage**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1306)
|
|
2411
2397
|
|
|
2412
2398
|
Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.
|
|
2413
2399
|
|
|
@@ -2415,7 +2401,7 @@ Toggles the visibility of the status message that is displayed when no data is s
|
|
|
2415
2401
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2416
2402
|
|
|
2417
2403
|
|
|
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#
|
|
2404
|
+
<a name="Viz.resizeContainer" href="#Viz.resizeContainer">#</a> Viz.**resizeContainer**(*selector*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1316)
|
|
2419
2405
|
|
|
2420
2406
|
If using resize detection, this method allow a custom override of the element to which the resize detection function gets attached.
|
|
2421
2407
|
|
|
@@ -2423,7 +2409,7 @@ If using resize detection, this method allow a custom override of the element to
|
|
|
2423
2409
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2424
2410
|
|
|
2425
2411
|
|
|
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#
|
|
2412
|
+
<a name="Viz.scrollContainer" href="#Viz.scrollContainer">#</a> Viz.**scrollContainer**(*selector*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1326)
|
|
2427
2413
|
|
|
2428
2414
|
If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.
|
|
2429
2415
|
|
|
@@ -2431,7 +2417,7 @@ If using scroll or visibility detection, this method allow a custom override of
|
|
|
2431
2417
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2432
2418
|
|
|
2433
2419
|
|
|
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#
|
|
2420
|
+
<a name="Viz.select" href="#Viz.select">#</a> Viz.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1336)
|
|
2435
2421
|
|
|
2436
2422
|
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.
|
|
2437
2423
|
|
|
@@ -2439,15 +2425,15 @@ If *selector* is specified, sets the SVG container element to the specified d3 s
|
|
|
2439
2425
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2440
2426
|
|
|
2441
2427
|
|
|
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#
|
|
2428
|
+
<a name="Viz.shape" href="#Viz.shape">#</a> Viz.**shape**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1346)
|
|
2443
2429
|
|
|
2444
|
-
|
|
2430
|
+
Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.
|
|
2445
2431
|
|
|
2446
2432
|
|
|
2447
2433
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2448
2434
|
|
|
2449
2435
|
|
|
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#
|
|
2436
|
+
<a name="Viz.shapeConfig" href="#Viz.shapeConfig">#</a> Viz.**shapeConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1356)
|
|
2451
2437
|
|
|
2452
2438
|
If *value* is specified, sets the config method for each shape and returns the current class instance.
|
|
2453
2439
|
|
|
@@ -2455,7 +2441,7 @@ If *value* is specified, sets the config method for each shape and returns the c
|
|
|
2455
2441
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2456
2442
|
|
|
2457
2443
|
|
|
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#
|
|
2444
|
+
<a name="Viz.subtitle" href="#Viz.subtitle">#</a> Viz.**subtitle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1366)
|
|
2459
2445
|
|
|
2460
2446
|
If *value* is specified, sets the subtitle accessor to the specified function or string and returns the current class instance.
|
|
2461
2447
|
|
|
@@ -2463,7 +2449,7 @@ If *value* is specified, sets the subtitle accessor to the specified function or
|
|
|
2463
2449
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2464
2450
|
|
|
2465
2451
|
|
|
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#
|
|
2452
|
+
<a name="Viz.subtitleConfig" href="#Viz.subtitleConfig">#</a> Viz.**subtitleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1376)
|
|
2467
2453
|
|
|
2468
2454
|
If *value* is specified, sets the config method for the subtitle and returns the current class instance.
|
|
2469
2455
|
|
|
@@ -2471,7 +2457,7 @@ If *value* is specified, sets the config method for the subtitle and returns the
|
|
|
2471
2457
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2472
2458
|
|
|
2473
2459
|
|
|
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#
|
|
2460
|
+
<a name="Viz.subtitlePadding" href="#Viz.subtitlePadding">#</a> Viz.**subtitlePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1386)
|
|
2475
2461
|
|
|
2476
2462
|
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.
|
|
2477
2463
|
|
|
@@ -2479,7 +2465,7 @@ Tells the subtitle whether or not to use the internal padding defined by the vis
|
|
|
2479
2465
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2480
2466
|
|
|
2481
2467
|
|
|
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#
|
|
2468
|
+
<a name="Viz.svgDesc" href="#Viz.svgDesc">#</a> Viz.**svgDesc**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1396)
|
|
2483
2469
|
|
|
2484
2470
|
If *value* is specified, sets the description accessor to the specified string and returns the current class instance.
|
|
2485
2471
|
|
|
@@ -2487,7 +2473,7 @@ If *value* is specified, sets the description accessor to the specified string a
|
|
|
2487
2473
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2488
2474
|
|
|
2489
2475
|
|
|
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#
|
|
2476
|
+
<a name="Viz.svgTitle" href="#Viz.svgTitle">#</a> Viz.**svgTitle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1406)
|
|
2491
2477
|
|
|
2492
2478
|
If *value* is specified, sets the title accessor to the specified string and returns the current class instance.
|
|
2493
2479
|
|
|
@@ -2495,7 +2481,7 @@ If *value* is specified, sets the title accessor to the specified string and ret
|
|
|
2495
2481
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2496
2482
|
|
|
2497
2483
|
|
|
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#
|
|
2484
|
+
<a name="Viz.threshold" href="#Viz.threshold">#</a> Viz.**threshold**([value]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1416)
|
|
2499
2485
|
|
|
2500
2486
|
If *value* is specified, sets the threshold for buckets to the specified function or string, and returns the current class instance.
|
|
2501
2487
|
|
|
@@ -2503,7 +2489,7 @@ If *value* is specified, sets the threshold for buckets to the specified functio
|
|
|
2503
2489
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2504
2490
|
|
|
2505
2491
|
|
|
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#
|
|
2492
|
+
<a name="Viz.thresholdKey" href="#Viz.thresholdKey">#</a> Viz.**thresholdKey**([value]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1435)
|
|
2507
2493
|
|
|
2508
2494
|
If *value* is specified, sets the accesor for the value used in the threshold algorithm, and returns the current class instance.
|
|
2509
2495
|
|
|
@@ -2511,7 +2497,7 @@ If *value* is specified, sets the accesor for the value used in the threshold al
|
|
|
2511
2497
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2512
2498
|
|
|
2513
2499
|
|
|
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#
|
|
2500
|
+
<a name="Viz.thresholdName" href="#Viz.thresholdName">#</a> Viz.**thresholdName**([value]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1454)
|
|
2515
2501
|
|
|
2516
2502
|
If *value* is specified, sets the label for the bucket item, and returns the current class instance.
|
|
2517
2503
|
|
|
@@ -2519,7 +2505,7 @@ If *value* is specified, sets the label for the bucket item, and returns the cur
|
|
|
2519
2505
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2520
2506
|
|
|
2521
2507
|
|
|
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#
|
|
2508
|
+
<a name="Viz.time" href="#Viz.time">#</a> Viz.**time**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1464)
|
|
2523
2509
|
|
|
2524
2510
|
If *value* is specified, sets the time accessor to the specified function or string and returns the current class instance.
|
|
2525
2511
|
|
|
@@ -2527,7 +2513,7 @@ If *value* is specified, sets the time accessor to the specified function or str
|
|
|
2527
2513
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2528
2514
|
|
|
2529
2515
|
|
|
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#
|
|
2516
|
+
<a name="Viz.timeFilter" href="#Viz.timeFilter">#</a> Viz.**timeFilter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1500)
|
|
2531
2517
|
|
|
2532
2518
|
If *value* is specified, sets the time filter to the specified function and returns the current class instance.
|
|
2533
2519
|
|
|
@@ -2535,7 +2521,7 @@ If *value* is specified, sets the time filter to the specified function and retu
|
|
|
2535
2521
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2536
2522
|
|
|
2537
2523
|
|
|
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#
|
|
2524
|
+
<a name="Viz.timeline" href="#Viz.timeline">#</a> Viz.**timeline**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1510)
|
|
2539
2525
|
|
|
2540
2526
|
If *value* is specified, toggles the timeline based on the specified boolean and returns the current class instance.
|
|
2541
2527
|
|
|
@@ -2543,7 +2529,7 @@ If *value* is specified, toggles the timeline based on the specified boolean and
|
|
|
2543
2529
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2544
2530
|
|
|
2545
2531
|
|
|
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#
|
|
2532
|
+
<a name="Viz.timelineConfig" href="#Viz.timelineConfig">#</a> Viz.**timelineConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1520)
|
|
2547
2533
|
|
|
2548
2534
|
If *value* is specified, sets the config method for the timeline and returns the current class instance.
|
|
2549
2535
|
|
|
@@ -2551,7 +2537,7 @@ If *value* is specified, sets the config method for the timeline and returns the
|
|
|
2551
2537
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2552
2538
|
|
|
2553
2539
|
|
|
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#
|
|
2540
|
+
<a name="Viz.timelineDefault" href="#Viz.timelineDefault">#</a> Viz.**timelineDefault**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1530)
|
|
2555
2541
|
|
|
2556
2542
|
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.
|
|
2557
2543
|
|
|
@@ -2559,7 +2545,7 @@ Sets the starting time or range for the timeline. The value provided can either
|
|
|
2559
2545
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2560
2546
|
|
|
2561
2547
|
|
|
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#
|
|
2548
|
+
<a name="Viz.timelinePadding" href="#Viz.timelinePadding">#</a> Viz.**timelinePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1545)
|
|
2563
2549
|
|
|
2564
2550
|
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.
|
|
2565
2551
|
|
|
@@ -2567,7 +2553,7 @@ Tells the timeline whether or not to use the internal padding defined by the vis
|
|
|
2567
2553
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2568
2554
|
|
|
2569
2555
|
|
|
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#
|
|
2556
|
+
<a name="Viz.title" href="#Viz.title">#</a> Viz.**title**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1555)
|
|
2571
2557
|
|
|
2572
2558
|
If *value* is specified, sets the title accessor to the specified function or string and returns the current class instance.
|
|
2573
2559
|
|
|
@@ -2575,7 +2561,7 @@ If *value* is specified, sets the title accessor to the specified function or st
|
|
|
2575
2561
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2576
2562
|
|
|
2577
2563
|
|
|
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#
|
|
2564
|
+
<a name="Viz.titleConfig" href="#Viz.titleConfig">#</a> Viz.**titleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1565)
|
|
2579
2565
|
|
|
2580
2566
|
If *value* is specified, sets the config method for the title and returns the current class instance.
|
|
2581
2567
|
|
|
@@ -2583,7 +2569,7 @@ If *value* is specified, sets the config method for the title and returns the cu
|
|
|
2583
2569
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2584
2570
|
|
|
2585
2571
|
|
|
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#
|
|
2572
|
+
<a name="Viz.titlePadding" href="#Viz.titlePadding">#</a> Viz.**titlePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1575)
|
|
2587
2573
|
|
|
2588
2574
|
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.
|
|
2589
2575
|
|
|
@@ -2591,7 +2577,7 @@ Tells the title whether or not to use the internal padding defined by the visual
|
|
|
2591
2577
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2592
2578
|
|
|
2593
2579
|
|
|
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#
|
|
2580
|
+
<a name="Viz.tooltip" href="#Viz.tooltip">#</a> Viz.**tooltip**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1585)
|
|
2595
2581
|
|
|
2596
2582
|
If *value* is specified, toggles the tooltip based on the specified boolean and returns the current class instance.
|
|
2597
2583
|
|
|
@@ -2599,7 +2585,7 @@ If *value* is specified, toggles the tooltip based on the specified boolean and
|
|
|
2599
2585
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2600
2586
|
|
|
2601
2587
|
|
|
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#
|
|
2588
|
+
<a name="Viz.tooltipConfig" href="#Viz.tooltipConfig">#</a> Viz.**tooltipConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1595)
|
|
2603
2589
|
|
|
2604
2590
|
If *value* is specified, sets the config method for the tooltip and returns the current class instance.
|
|
2605
2591
|
|
|
@@ -2607,7 +2593,7 @@ If *value* is specified, sets the config method for the tooltip and returns the
|
|
|
2607
2593
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2608
2594
|
|
|
2609
2595
|
|
|
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#
|
|
2596
|
+
<a name="Viz.total" href="#Viz.total">#</a> Viz.**total**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1605)
|
|
2611
2597
|
|
|
2612
2598
|
If *value* is specified, sets the total accessor to the specified function or string and returns the current class instance.
|
|
2613
2599
|
|
|
@@ -2615,7 +2601,7 @@ If *value* is specified, sets the total accessor to the specified function or st
|
|
|
2615
2601
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2616
2602
|
|
|
2617
2603
|
|
|
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#
|
|
2604
|
+
<a name="Viz.totalConfig" href="#Viz.totalConfig">#</a> Viz.**totalConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1621)
|
|
2619
2605
|
|
|
2620
2606
|
If *value* is specified, sets the config method for the total and returns the current class instance.
|
|
2621
2607
|
|
|
@@ -2623,7 +2609,7 @@ If *value* is specified, sets the config method for the total and returns the cu
|
|
|
2623
2609
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2624
2610
|
|
|
2625
2611
|
|
|
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#
|
|
2612
|
+
<a name="Viz.totalFormat" href="#Viz.totalFormat">#</a> Viz.**totalFormat**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1631)
|
|
2627
2613
|
|
|
2628
2614
|
Formatter function for the value in the total bar.
|
|
2629
2615
|
|
|
@@ -2631,7 +2617,7 @@ Formatter function for the value in the total bar.
|
|
|
2631
2617
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2632
2618
|
|
|
2633
2619
|
|
|
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#
|
|
2620
|
+
<a name="Viz.totalPadding" href="#Viz.totalPadding">#</a> Viz.**totalPadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1641)
|
|
2635
2621
|
|
|
2636
2622
|
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.
|
|
2637
2623
|
|
|
@@ -2639,7 +2625,7 @@ Tells the total whether or not to use the internal padding defined by the visual
|
|
|
2639
2625
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2640
2626
|
|
|
2641
2627
|
|
|
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#
|
|
2628
|
+
<a name="Viz.width" href="#Viz.width">#</a> Viz.**width**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1651)
|
|
2643
2629
|
|
|
2644
2630
|
If *value* is specified, sets the overallwidth to the specified number and returns the current class instance.
|
|
2645
2631
|
|
|
@@ -2647,7 +2633,7 @@ If *value* is specified, sets the overallwidth to the specified number and retur
|
|
|
2647
2633
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2648
2634
|
|
|
2649
2635
|
|
|
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#
|
|
2636
|
+
<a name="Viz.zoom" href="#Viz.zoom">#</a> Viz.**zoom**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1661)
|
|
2651
2637
|
|
|
2652
2638
|
Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.
|
|
2653
2639
|
|
|
@@ -2655,7 +2641,7 @@ Toggles the ability to zoom/pan the visualization. Certain parameters for zoomin
|
|
|
2655
2641
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2656
2642
|
|
|
2657
2643
|
|
|
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#
|
|
2644
|
+
<a name="Viz.zoomBrushHandleSize" href="#Viz.zoomBrushHandleSize">#</a> Viz.**zoomBrushHandleSize**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1671)
|
|
2659
2645
|
|
|
2660
2646
|
The pixel stroke-width of the zoom brush area.
|
|
2661
2647
|
|
|
@@ -2663,7 +2649,7 @@ The pixel stroke-width of the zoom brush area.
|
|
|
2663
2649
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2664
2650
|
|
|
2665
2651
|
|
|
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#
|
|
2652
|
+
<a name="Viz.zoomBrushHandleStyle" href="#Viz.zoomBrushHandleStyle">#</a> Viz.**zoomBrushHandleStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1681)
|
|
2667
2653
|
|
|
2668
2654
|
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.
|
|
2669
2655
|
|
|
@@ -2671,7 +2657,7 @@ An object containing CSS key/value pairs that is used to style the outer handle
|
|
|
2671
2657
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2672
2658
|
|
|
2673
2659
|
|
|
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#
|
|
2660
|
+
<a name="Viz.zoomBrushSelectionStyle" href="#Viz.zoomBrushSelectionStyle">#</a> Viz.**zoomBrushSelectionStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1691)
|
|
2675
2661
|
|
|
2676
2662
|
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.
|
|
2677
2663
|
|
|
@@ -2679,7 +2665,7 @@ An object containing CSS key/value pairs that is used to style the inner selecti
|
|
|
2679
2665
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2680
2666
|
|
|
2681
2667
|
|
|
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#
|
|
2668
|
+
<a name="Viz.zoomControlStyle" href="#Viz.zoomControlStyle">#</a> Viz.**zoomControlStyle**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1701)
|
|
2683
2669
|
|
|
2684
2670
|
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.
|
|
2685
2671
|
|
|
@@ -2687,7 +2673,7 @@ An object containing CSS key/value pairs that is used to style each zoom control
|
|
|
2687
2673
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2688
2674
|
|
|
2689
2675
|
|
|
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#
|
|
2676
|
+
<a name="Viz.zoomControlStyleActive" href="#Viz.zoomControlStyleActive">#</a> Viz.**zoomControlStyleActive**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1711)
|
|
2691
2677
|
|
|
2692
2678
|
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.
|
|
2693
2679
|
|
|
@@ -2695,7 +2681,7 @@ An object containing CSS key/value pairs that is used to style each zoom control
|
|
|
2695
2681
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2696
2682
|
|
|
2697
2683
|
|
|
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#
|
|
2684
|
+
<a name="Viz.zoomControlStyleHover" href="#Viz.zoomControlStyleHover">#</a> Viz.**zoomControlStyleHover**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1721)
|
|
2699
2685
|
|
|
2700
2686
|
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.
|
|
2701
2687
|
|
|
@@ -2703,7 +2689,7 @@ An object containing CSS key/value pairs that is used to style each zoom control
|
|
|
2703
2689
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2704
2690
|
|
|
2705
2691
|
|
|
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#
|
|
2692
|
+
<a name="Viz.zoomFactor" href="#Viz.zoomFactor">#</a> Viz.**zoomFactor**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1731)
|
|
2707
2693
|
|
|
2708
2694
|
The multiplier that is used in with the control buttons when zooming in and out.
|
|
2709
2695
|
|
|
@@ -2711,7 +2697,7 @@ The multiplier that is used in with the control buttons when zooming in and out.
|
|
|
2711
2697
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2712
2698
|
|
|
2713
2699
|
|
|
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#
|
|
2700
|
+
<a name="Viz.zoomMax" href="#Viz.zoomMax">#</a> Viz.**zoomMax**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1741)
|
|
2715
2701
|
|
|
2716
2702
|
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.
|
|
2717
2703
|
|
|
@@ -2719,7 +2705,7 @@ If *value* is specified, sets the max zoom scale to the specified number and ret
|
|
|
2719
2705
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2720
2706
|
|
|
2721
2707
|
|
|
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#
|
|
2708
|
+
<a name="Viz.zoomPan" href="#Viz.zoomPan">#</a> Viz.**zoomPan**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1751)
|
|
2723
2709
|
|
|
2724
2710
|
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.
|
|
2725
2711
|
|
|
@@ -2727,7 +2713,7 @@ If *value* is specified, toggles panning to the specified boolean and returns th
|
|
|
2727
2713
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2728
2714
|
|
|
2729
2715
|
|
|
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#
|
|
2716
|
+
<a name="Viz.zoomPadding" href="#Viz.zoomPadding">#</a> Viz.**zoomPadding**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1761)
|
|
2731
2717
|
|
|
2732
2718
|
A pixel value to be used to pad all sides of a zoomed area.
|
|
2733
2719
|
|
|
@@ -2735,7 +2721,7 @@ A pixel value to be used to pad all sides of a zoomed area.
|
|
|
2735
2721
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2736
2722
|
|
|
2737
2723
|
|
|
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#
|
|
2724
|
+
<a name="Viz.zoomScroll" href="#Viz.zoomScroll">#</a> Viz.**zoomScroll**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1771)
|
|
2739
2725
|
|
|
2740
2726
|
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.
|
|
2741
2727
|
|
|
@@ -2827,7 +2813,7 @@ Renders the current Axis to the page. If a *callback* is specified, it will be c
|
|
|
2827
2813
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2828
2814
|
|
|
2829
2815
|
|
|
2830
|
-
<a name="Axis.align" href="#Axis.align">#</a> Axis.**align**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2816
|
+
<a name="Axis.align" href="#Axis.align">#</a> Axis.**align**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1027)
|
|
2831
2817
|
|
|
2832
2818
|
If *value* is specified, sets the horizontal alignment to the specified value and returns the current class instance.
|
|
2833
2819
|
|
|
@@ -2835,7 +2821,7 @@ If *value* is specified, sets the horizontal alignment to the specified value an
|
|
|
2835
2821
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2836
2822
|
|
|
2837
2823
|
|
|
2838
|
-
<a name="Axis.barConfig" href="#Axis.barConfig">#</a> Axis.**barConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2824
|
+
<a name="Axis.barConfig" href="#Axis.barConfig">#</a> Axis.**barConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1037)
|
|
2839
2825
|
|
|
2840
2826
|
If *value* is specified, sets the axis line style and returns the current class instance.
|
|
2841
2827
|
|
|
@@ -2843,7 +2829,7 @@ If *value* is specified, sets the axis line style and returns the current class
|
|
|
2843
2829
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2844
2830
|
|
|
2845
2831
|
|
|
2846
|
-
<a name="Axis.data" href="#Axis.data">#</a> Axis.**data**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2832
|
+
<a name="Axis.data" href="#Axis.data">#</a> Axis.**data**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1047)
|
|
2847
2833
|
|
|
2848
2834
|
An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.
|
|
2849
2835
|
|
|
@@ -2851,7 +2837,7 @@ An array of data points, which helps determine which ticks should be shown and w
|
|
|
2851
2837
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2852
2838
|
|
|
2853
2839
|
|
|
2854
|
-
<a name="Axis.domain" href="#Axis.domain">#</a> Axis.**domain**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2840
|
+
<a name="Axis.domain" href="#Axis.domain">#</a> Axis.**domain**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1057)
|
|
2855
2841
|
|
|
2856
2842
|
If *value* is specified, sets the scale domain of the axis and returns the current class instance.
|
|
2857
2843
|
|
|
@@ -2859,7 +2845,7 @@ If *value* is specified, sets the scale domain of the axis and returns the curre
|
|
|
2859
2845
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2860
2846
|
|
|
2861
2847
|
|
|
2862
|
-
<a name="Axis.duration" href="#Axis.duration">#</a> Axis.**duration**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2848
|
+
<a name="Axis.duration" href="#Axis.duration">#</a> Axis.**duration**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1067)
|
|
2863
2849
|
|
|
2864
2850
|
If *value* is specified, sets the transition duration of the axis and returns the current class instance.
|
|
2865
2851
|
|
|
@@ -2867,7 +2853,7 @@ If *value* is specified, sets the transition duration of the axis and returns th
|
|
|
2867
2853
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2868
2854
|
|
|
2869
2855
|
|
|
2870
|
-
<a name="Axis.grid" href="#Axis.grid">#</a> Axis.**grid**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2856
|
+
<a name="Axis.grid" href="#Axis.grid">#</a> Axis.**grid**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1077)
|
|
2871
2857
|
|
|
2872
2858
|
If *value* is specified, sets the grid values of the axis and returns the current class instance.
|
|
2873
2859
|
|
|
@@ -2875,7 +2861,7 @@ If *value* is specified, sets the grid values of the axis and returns the curren
|
|
|
2875
2861
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2876
2862
|
|
|
2877
2863
|
|
|
2878
|
-
<a name="Axis.gridConfig" href="#Axis.gridConfig">#</a> Axis.**gridConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2864
|
+
<a name="Axis.gridConfig" href="#Axis.gridConfig">#</a> Axis.**gridConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1087)
|
|
2879
2865
|
|
|
2880
2866
|
If *value* is specified, sets the grid config of the axis and returns the current class instance.
|
|
2881
2867
|
|
|
@@ -2883,7 +2869,7 @@ If *value* is specified, sets the grid config of the axis and returns the curren
|
|
|
2883
2869
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2884
2870
|
|
|
2885
2871
|
|
|
2886
|
-
<a name="Axis.gridLog" href="#Axis.gridLog">#</a> Axis.**gridLog**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2872
|
+
<a name="Axis.gridLog" href="#Axis.gridLog">#</a> Axis.**gridLog**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1097)
|
|
2887
2873
|
|
|
2888
2874
|
If *value* is specified, sets the grid behavior of the axis when scale is logarithmic and returns the current class instance.
|
|
2889
2875
|
|
|
@@ -2891,7 +2877,7 @@ If *value* is specified, sets the grid behavior of the axis when scale is logari
|
|
|
2891
2877
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2892
2878
|
|
|
2893
2879
|
|
|
2894
|
-
<a name="Axis.gridSize" href="#Axis.gridSize">#</a> Axis.**gridSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2880
|
+
<a name="Axis.gridSize" href="#Axis.gridSize">#</a> Axis.**gridSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1107)
|
|
2895
2881
|
|
|
2896
2882
|
If *value* is specified, sets the grid size of the axis and returns the current class instance.
|
|
2897
2883
|
|
|
@@ -2899,7 +2885,7 @@ If *value* is specified, sets the grid size of the axis and returns the current
|
|
|
2899
2885
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2900
2886
|
|
|
2901
2887
|
|
|
2902
|
-
<a name="Axis.height" href="#Axis.height">#</a> Axis.**height**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2888
|
+
<a name="Axis.height" href="#Axis.height">#</a> Axis.**height**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1117)
|
|
2903
2889
|
|
|
2904
2890
|
If *value* is specified, sets the overall height of the axis and returns the current class instance.
|
|
2905
2891
|
|
|
@@ -2907,7 +2893,7 @@ If *value* is specified, sets the overall height of the axis and returns the cur
|
|
|
2907
2893
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2908
2894
|
|
|
2909
2895
|
|
|
2910
|
-
<a name="Axis.labels" href="#Axis.labels">#</a> Axis.**labels**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2896
|
+
<a name="Axis.labels" href="#Axis.labels">#</a> Axis.**labels**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1127)
|
|
2911
2897
|
|
|
2912
2898
|
If *value* is specified, sets the visible tick labels of the axis and returns the current class instance.
|
|
2913
2899
|
|
|
@@ -2915,7 +2901,7 @@ If *value* is specified, sets the visible tick labels of the axis and returns th
|
|
|
2915
2901
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2916
2902
|
|
|
2917
2903
|
|
|
2918
|
-
<a name="Axis.labelOffset" href="#Axis.labelOffset">#</a> Axis.**labelOffset**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2904
|
+
<a name="Axis.labelOffset" href="#Axis.labelOffset">#</a> Axis.**labelOffset**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1137)
|
|
2919
2905
|
|
|
2920
2906
|
If *value* is specified, sets whether offsets will be used to position some labels further away from the axis in order to allow space for the text.
|
|
2921
2907
|
|
|
@@ -2923,7 +2909,7 @@ If *value* is specified, sets whether offsets will be used to position some labe
|
|
|
2923
2909
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2924
2910
|
|
|
2925
2911
|
|
|
2926
|
-
<a name="Axis.labelRotation" href="#Axis.labelRotation">#</a> Axis.**labelRotation**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2912
|
+
<a name="Axis.labelRotation" href="#Axis.labelRotation">#</a> Axis.**labelRotation**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1147)
|
|
2927
2913
|
|
|
2928
2914
|
If *value* is specified, sets whether whether horizontal axis labels are rotated -90 degrees.
|
|
2929
2915
|
|
|
@@ -2931,7 +2917,7 @@ If *value* is specified, sets whether whether horizontal axis labels are rotated
|
|
|
2931
2917
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2932
2918
|
|
|
2933
2919
|
|
|
2934
|
-
<a name="Axis.maxSize" href="#Axis.maxSize">#</a> Axis.**maxSize**(_) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2920
|
+
<a name="Axis.maxSize" href="#Axis.maxSize">#</a> Axis.**maxSize**(_) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1157)
|
|
2935
2921
|
|
|
2936
2922
|
If *value* is specified, sets the maximum size allowed for the space that contains the axis tick labels and title.
|
|
2937
2923
|
|
|
@@ -2939,7 +2925,7 @@ If *value* is specified, sets the maximum size allowed for the space that contai
|
|
|
2939
2925
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2940
2926
|
|
|
2941
2927
|
|
|
2942
|
-
<a name="Axis.minSize" href="#Axis.minSize">#</a> Axis.**minSize**(_) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2928
|
+
<a name="Axis.minSize" href="#Axis.minSize">#</a> Axis.**minSize**(_) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1167)
|
|
2943
2929
|
|
|
2944
2930
|
If *value* is specified, sets the minimum size alloted for the space that contains the axis tick labels and title.
|
|
2945
2931
|
|
|
@@ -2947,7 +2933,7 @@ If *value* is specified, sets the minimum size alloted for the space that contai
|
|
|
2947
2933
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2948
2934
|
|
|
2949
2935
|
|
|
2950
|
-
<a name="Axis.orient" href="#Axis.orient">#</a> Axis.**orient**([*orient*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2936
|
+
<a name="Axis.orient" href="#Axis.orient">#</a> Axis.**orient**([*orient*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1177)
|
|
2951
2937
|
|
|
2952
2938
|
If *orient* is specified, sets the orientation of the shape and returns the current class instance. If *orient* is not specified, returns the current orientation.
|
|
2953
2939
|
|
|
@@ -2955,7 +2941,7 @@ If *orient* is specified, sets the orientation of the shape and returns the curr
|
|
|
2955
2941
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2956
2942
|
|
|
2957
2943
|
|
|
2958
|
-
<a name="Axis.outerBounds" href="#Axis.outerBounds">#</a> Axis.**outerBounds**() [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2944
|
+
<a name="Axis.outerBounds" href="#Axis.outerBounds">#</a> Axis.**outerBounds**() [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1204)
|
|
2959
2945
|
|
|
2960
2946
|
If called after the elements have been drawn to DOM, will returns the outer bounds of the axis content.
|
|
2961
2947
|
|
|
@@ -2968,7 +2954,7 @@ This is a static method of [<code>Axis</code>](#Axis)
|
|
|
2968
2954
|
```
|
|
2969
2955
|
|
|
2970
2956
|
|
|
2971
|
-
<a name="Axis.padding" href="#Axis.padding">#</a> Axis.**padding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2957
|
+
<a name="Axis.padding" href="#Axis.padding">#</a> Axis.**padding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1214)
|
|
2972
2958
|
|
|
2973
2959
|
If *value* is specified, sets the padding between each tick label to the specified number and returns the current class instance.
|
|
2974
2960
|
|
|
@@ -2976,7 +2962,7 @@ If *value* is specified, sets the padding between each tick label to the specifi
|
|
|
2976
2962
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2977
2963
|
|
|
2978
2964
|
|
|
2979
|
-
<a name="Axis.paddingInner" href="#Axis.paddingInner">#</a> Axis.**paddingInner**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2965
|
+
<a name="Axis.paddingInner" href="#Axis.paddingInner">#</a> Axis.**paddingInner**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1224)
|
|
2980
2966
|
|
|
2981
2967
|
If *value* is specified, sets the inner padding of band scale to the specified number and returns the current class instance.
|
|
2982
2968
|
|
|
@@ -2984,7 +2970,7 @@ If *value* is specified, sets the inner padding of band scale to the specified n
|
|
|
2984
2970
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2985
2971
|
|
|
2986
2972
|
|
|
2987
|
-
<a name="Axis.paddingOuter" href="#Axis.paddingOuter">#</a> Axis.**paddingOuter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2973
|
+
<a name="Axis.paddingOuter" href="#Axis.paddingOuter">#</a> Axis.**paddingOuter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1234)
|
|
2988
2974
|
|
|
2989
2975
|
If *value* is specified, sets the outer padding of band scales to the specified number and returns the current class instance.
|
|
2990
2976
|
|
|
@@ -2992,7 +2978,7 @@ If *value* is specified, sets the outer padding of band scales to the specified
|
|
|
2992
2978
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
2993
2979
|
|
|
2994
2980
|
|
|
2995
|
-
<a name="Axis.range" href="#Axis.range">#</a> Axis.**range**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2981
|
+
<a name="Axis.range" href="#Axis.range">#</a> Axis.**range**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1244)
|
|
2996
2982
|
|
|
2997
2983
|
If *value* is specified, sets the scale range (in pixels) of the axis and returns the current class instance. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.
|
|
2998
2984
|
|
|
@@ -3000,7 +2986,7 @@ If *value* is specified, sets the scale range (in pixels) of the axis and return
|
|
|
3000
2986
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3001
2987
|
|
|
3002
2988
|
|
|
3003
|
-
<a name="Axis.rounding" href="#Axis.rounding">#</a> Axis.**rounding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2989
|
+
<a name="Axis.rounding" href="#Axis.rounding">#</a> Axis.**rounding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1254)
|
|
3004
2990
|
|
|
3005
2991
|
Sets the rounding method, so that more evenly spaced ticks appear at the extents of the scale. Can be set to "none" (default), "outside", or "inside".
|
|
3006
2992
|
|
|
@@ -3008,7 +2994,7 @@ Sets the rounding method, so that more evenly spaced ticks appear at the extents
|
|
|
3008
2994
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3009
2995
|
|
|
3010
2996
|
|
|
3011
|
-
<a name="Axis.roundingInsideMinPrefix" href="#Axis.roundingInsideMinPrefix">#</a> Axis.**roundingInsideMinPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
2997
|
+
<a name="Axis.roundingInsideMinPrefix" href="#Axis.roundingInsideMinPrefix">#</a> Axis.**roundingInsideMinPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1264)
|
|
3012
2998
|
|
|
3013
2999
|
Sets the prefix used for the minimum value of "inside" rounding scales.
|
|
3014
3000
|
|
|
@@ -3016,7 +3002,7 @@ Sets the prefix used for the minimum value of "inside" rounding scales.
|
|
|
3016
3002
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3017
3003
|
|
|
3018
3004
|
|
|
3019
|
-
<a name="Axis.roundingInsideMinSuffix" href="#Axis.roundingInsideMinSuffix">#</a> Axis.**roundingInsideMinSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3005
|
+
<a name="Axis.roundingInsideMinSuffix" href="#Axis.roundingInsideMinSuffix">#</a> Axis.**roundingInsideMinSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1274)
|
|
3020
3006
|
|
|
3021
3007
|
Sets the suffix used for the minimum value of "inside" rounding scales.
|
|
3022
3008
|
|
|
@@ -3024,7 +3010,7 @@ Sets the suffix used for the minimum value of "inside" rounding scales.
|
|
|
3024
3010
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3025
3011
|
|
|
3026
3012
|
|
|
3027
|
-
<a name="Axis.roundingInsideMaxPrefix" href="#Axis.roundingInsideMaxPrefix">#</a> Axis.**roundingInsideMaxPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3013
|
+
<a name="Axis.roundingInsideMaxPrefix" href="#Axis.roundingInsideMaxPrefix">#</a> Axis.**roundingInsideMaxPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1284)
|
|
3028
3014
|
|
|
3029
3015
|
Sets the prefix used for the maximum value of "inside" rounding scales.
|
|
3030
3016
|
|
|
@@ -3032,7 +3018,7 @@ Sets the prefix used for the maximum value of "inside" rounding scales.
|
|
|
3032
3018
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3033
3019
|
|
|
3034
3020
|
|
|
3035
|
-
<a name="Axis.roundingInsideMaxSuffix" href="#Axis.roundingInsideMaxSuffix">#</a> Axis.**roundingInsideMaxSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3021
|
+
<a name="Axis.roundingInsideMaxSuffix" href="#Axis.roundingInsideMaxSuffix">#</a> Axis.**roundingInsideMaxSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1294)
|
|
3036
3022
|
|
|
3037
3023
|
Sets the suffix used for the maximum value of "inside" rounding scales.
|
|
3038
3024
|
|
|
@@ -3040,7 +3026,7 @@ Sets the suffix used for the maximum value of "inside" rounding scales.
|
|
|
3040
3026
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3041
3027
|
|
|
3042
3028
|
|
|
3043
|
-
<a name="Axis.scale" href="#Axis.scale">#</a> Axis.**scale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3029
|
+
<a name="Axis.scale" href="#Axis.scale">#</a> Axis.**scale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1304)
|
|
3044
3030
|
|
|
3045
3031
|
If *value* is specified, sets the scale of the axis and returns the current class instance.
|
|
3046
3032
|
|
|
@@ -3048,7 +3034,7 @@ If *value* is specified, sets the scale of the axis and returns the current clas
|
|
|
3048
3034
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3049
3035
|
|
|
3050
3036
|
|
|
3051
|
-
<a name="Axis.scalePadding" href="#Axis.scalePadding">#</a> Axis.**scalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3037
|
+
<a name="Axis.scalePadding" href="#Axis.scalePadding">#</a> Axis.**scalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1314)
|
|
3052
3038
|
|
|
3053
3039
|
Sets the "padding" property of the scale, often used in point scales.
|
|
3054
3040
|
|
|
@@ -3056,7 +3042,7 @@ Sets the "padding" property of the scale, often used in point scales.
|
|
|
3056
3042
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3057
3043
|
|
|
3058
3044
|
|
|
3059
|
-
<a name="Axis.select" href="#Axis.select">#</a> Axis.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3045
|
+
<a name="Axis.select" href="#Axis.select">#</a> Axis.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1324)
|
|
3060
3046
|
|
|
3061
3047
|
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.
|
|
3062
3048
|
|
|
@@ -3064,7 +3050,7 @@ If *selector* is specified, sets the SVG container element to the specified d3 s
|
|
|
3064
3050
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3065
3051
|
|
|
3066
3052
|
|
|
3067
|
-
<a name="Axis.shape" href="#Axis.shape">#</a> Axis.**shape**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3053
|
+
<a name="Axis.shape" href="#Axis.shape">#</a> Axis.**shape**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1334)
|
|
3068
3054
|
|
|
3069
3055
|
If *value* is specified, sets the tick shape constructor and returns the current class instance.
|
|
3070
3056
|
|
|
@@ -3072,7 +3058,7 @@ If *value* is specified, sets the tick shape constructor and returns the current
|
|
|
3072
3058
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3073
3059
|
|
|
3074
3060
|
|
|
3075
|
-
<a name="Axis.shapeConfig" href="#Axis.shapeConfig">#</a> Axis.**shapeConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3061
|
+
<a name="Axis.shapeConfig" href="#Axis.shapeConfig">#</a> Axis.**shapeConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1344)
|
|
3076
3062
|
|
|
3077
3063
|
If *value* is specified, sets the tick style of the axis and returns the current class instance.
|
|
3078
3064
|
|
|
@@ -3080,7 +3066,7 @@ If *value* is specified, sets the tick style of the axis and returns the current
|
|
|
3080
3066
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3081
3067
|
|
|
3082
3068
|
|
|
3083
|
-
<a name="Axis.tickFormat" href="#Axis.tickFormat">#</a> Axis.**tickFormat**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3069
|
+
<a name="Axis.tickFormat" href="#Axis.tickFormat">#</a> Axis.**tickFormat**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1354)
|
|
3084
3070
|
|
|
3085
3071
|
If *value* is specified, sets the tick formatter and returns the current class instance.
|
|
3086
3072
|
|
|
@@ -3088,7 +3074,7 @@ If *value* is specified, sets the tick formatter and returns the current class i
|
|
|
3088
3074
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3089
3075
|
|
|
3090
3076
|
|
|
3091
|
-
<a name="Axis.ticks" href="#Axis.ticks">#</a> Axis.**ticks**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3077
|
+
<a name="Axis.ticks" href="#Axis.ticks">#</a> Axis.**ticks**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1364)
|
|
3092
3078
|
|
|
3093
3079
|
If *value* is specified, sets the tick values of the axis and returns the current class instance.
|
|
3094
3080
|
|
|
@@ -3096,7 +3082,7 @@ If *value* is specified, sets the tick values of the axis and returns the curren
|
|
|
3096
3082
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3097
3083
|
|
|
3098
3084
|
|
|
3099
|
-
<a name="Axis.tickSize" href="#Axis.tickSize">#</a> Axis.**tickSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3085
|
+
<a name="Axis.tickSize" href="#Axis.tickSize">#</a> Axis.**tickSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1374)
|
|
3100
3086
|
|
|
3101
3087
|
If *value* is specified, sets the tick size of the axis and returns the current class instance.
|
|
3102
3088
|
|
|
@@ -3104,7 +3090,7 @@ If *value* is specified, sets the tick size of the axis and returns the current
|
|
|
3104
3090
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3105
3091
|
|
|
3106
3092
|
|
|
3107
|
-
<a name="Axis.tickSuffix" href="#Axis.tickSuffix">#</a> Axis.**tickSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3093
|
+
<a name="Axis.tickSuffix" href="#Axis.tickSuffix">#</a> Axis.**tickSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1384)
|
|
3108
3094
|
|
|
3109
3095
|
Sets the behavior of the abbreviations when you are using linear scale. This method accepts two options: "normal" (uses formatAbbreviate to determinate the abbreviation) and "smallest" (uses suffix from the smallest tick as reference in every tick).
|
|
3110
3096
|
|
|
@@ -3112,7 +3098,7 @@ Sets the behavior of the abbreviations when you are using linear scale. This met
|
|
|
3112
3098
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3113
3099
|
|
|
3114
3100
|
|
|
3115
|
-
<a name="Axis.timeLocale" href="#Axis.timeLocale">#</a> Axis.**timeLocale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3101
|
+
<a name="Axis.timeLocale" href="#Axis.timeLocale">#</a> Axis.**timeLocale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1394)
|
|
3116
3102
|
|
|
3117
3103
|
Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).
|
|
3118
3104
|
|
|
@@ -3120,7 +3106,7 @@ Defines a custom locale object to be used in time scale. This object must includ
|
|
|
3120
3106
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3121
3107
|
|
|
3122
3108
|
|
|
3123
|
-
<a name="Axis.title" href="#Axis.title">#</a> Axis.**title**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3109
|
+
<a name="Axis.title" href="#Axis.title">#</a> Axis.**title**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1404)
|
|
3124
3110
|
|
|
3125
3111
|
If *value* is specified, sets the title of the axis and returns the current class instance.
|
|
3126
3112
|
|
|
@@ -3128,7 +3114,7 @@ If *value* is specified, sets the title of the axis and returns the current clas
|
|
|
3128
3114
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3129
3115
|
|
|
3130
3116
|
|
|
3131
|
-
<a name="Axis.titleConfig" href="#Axis.titleConfig">#</a> Axis.**titleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3117
|
+
<a name="Axis.titleConfig" href="#Axis.titleConfig">#</a> Axis.**titleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1414)
|
|
3132
3118
|
|
|
3133
3119
|
If *value* is specified, sets the title configuration of the axis and returns the current class instance.
|
|
3134
3120
|
|
|
@@ -3136,7 +3122,7 @@ If *value* is specified, sets the title configuration of the axis and returns th
|
|
|
3136
3122
|
This is a static method of [<code>Axis</code>](#Axis), and is chainable with other methods of this Class.
|
|
3137
3123
|
|
|
3138
3124
|
|
|
3139
|
-
<a name="Axis.width" href="#Axis.width">#</a> Axis.**width**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#
|
|
3125
|
+
<a name="Axis.width" href="#Axis.width">#</a> Axis.**width**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Axis.js#L1424)
|
|
3140
3126
|
|
|
3141
3127
|
If *value* is specified, sets the overall width of the axis and returns the current class instance.
|
|
3142
3128
|
|