@d3plus/core 3.0.8 → 3.0.10
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 +131 -131
- package/es/src/charts/Plot.js +1 -2
- package/es/src/charts/Viz.js +18 -19
- package/package.json +8 -8
- package/umd/d3plus-core.full.js +21 -21
- package/umd/d3plus-core.full.js.map +1 -1
- package/umd/d3plus-core.full.min.js +4 -4
- package/umd/d3plus-core.js +19 -21
- package/umd/d3plus-core.js.map +1 -1
- package/umd/d3plus-core.min.js +3 -3
package/README.md
CHANGED
|
@@ -870,7 +870,7 @@ This is a static method of [<code>Pie</code>](#Pie)
|
|
|
870
870
|
---
|
|
871
871
|
|
|
872
872
|
<a name="Plot"></a>
|
|
873
|
-
#### **Plot** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#
|
|
873
|
+
#### **Plot** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot.js#L147)
|
|
874
874
|
|
|
875
875
|
|
|
876
876
|
This is a global class, and extends all of the methods and functionality of [<code>Viz</code>](#Viz).
|
|
@@ -928,7 +928,7 @@ Creates an x/y plot based on an array of data.
|
|
|
928
928
|
|
|
929
929
|
|
|
930
930
|
|
|
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#
|
|
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#L1952)
|
|
932
932
|
|
|
933
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).
|
|
934
934
|
|
|
@@ -938,7 +938,7 @@ Additionally, each config object can also contain an optional "layer" key, which
|
|
|
938
938
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
939
939
|
|
|
940
940
|
|
|
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#
|
|
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#L1964)
|
|
942
942
|
|
|
943
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).
|
|
944
944
|
|
|
@@ -946,7 +946,7 @@ Determines whether the x and y axes should have their scales persist while users
|
|
|
946
946
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
947
947
|
|
|
948
948
|
|
|
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#
|
|
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#L1976)
|
|
950
950
|
|
|
951
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).
|
|
952
952
|
|
|
@@ -954,7 +954,7 @@ A d3plus-shape configuration Object used for styling the background rectangle of
|
|
|
954
954
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
955
955
|
|
|
956
956
|
|
|
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#
|
|
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#L1988)
|
|
958
958
|
|
|
959
959
|
Sets the pixel space between each bar in a group of bars.
|
|
960
960
|
|
|
@@ -962,7 +962,7 @@ Sets the pixel space between each bar in a group of bars.
|
|
|
962
962
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
963
963
|
|
|
964
964
|
|
|
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#
|
|
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#L1998)
|
|
966
966
|
|
|
967
967
|
Sets the baseline for the x/y plot. If *value* is not specified, returns the current baseline.
|
|
968
968
|
|
|
@@ -970,7 +970,7 @@ Sets the baseline for the x/y plot. If *value* is not specified, returns the cur
|
|
|
970
970
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
971
971
|
|
|
972
972
|
|
|
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#
|
|
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#L2008)
|
|
974
974
|
|
|
975
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}`).
|
|
976
976
|
|
|
@@ -978,7 +978,7 @@ Determines whether or not to add additional padding at the ends of x or y scales
|
|
|
978
978
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
979
979
|
|
|
980
980
|
|
|
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#
|
|
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#L2038)
|
|
982
982
|
|
|
983
983
|
Sets the confidence to the specified array of lower and upper bounds.
|
|
984
984
|
|
|
@@ -997,7 +997,7 @@ Can be called with accessor functions or static keys:
|
|
|
997
997
|
```
|
|
998
998
|
|
|
999
999
|
|
|
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#
|
|
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#L2058)
|
|
1001
1001
|
|
|
1002
1002
|
If *value* is specified, sets the config method for each shape rendered as a confidence interval and returns the current class instance.
|
|
1003
1003
|
|
|
@@ -1005,7 +1005,7 @@ If *value* is specified, sets the config method for each shape rendered as a con
|
|
|
1005
1005
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1006
1006
|
|
|
1007
1007
|
|
|
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#
|
|
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#L2070)
|
|
1009
1009
|
|
|
1010
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.
|
|
1011
1011
|
|
|
@@ -1013,7 +1013,7 @@ When the width or height of the chart is less than or equal to this pixel value,
|
|
|
1013
1013
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1014
1014
|
|
|
1015
1015
|
|
|
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#
|
|
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#L2082)
|
|
1017
1017
|
|
|
1018
1018
|
Sets the pixel space between groups of bars.
|
|
1019
1019
|
|
|
@@ -1021,7 +1021,7 @@ Sets the pixel space between groups of bars.
|
|
|
1021
1021
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1022
1022
|
|
|
1023
1023
|
|
|
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#
|
|
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#L2094)
|
|
1025
1025
|
|
|
1026
1026
|
The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.
|
|
1027
1027
|
|
|
@@ -1029,7 +1029,7 @@ The d3plus-shape config used on the Line shapes created to connect lineLabels to
|
|
|
1029
1029
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1030
1030
|
|
|
1031
1031
|
|
|
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#
|
|
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#L2120)
|
|
1033
1033
|
|
|
1034
1034
|
Draws labels on the right side of any Line shapes that are drawn on the plot.
|
|
1035
1035
|
|
|
@@ -1037,7 +1037,7 @@ Draws labels on the right side of any Line shapes that are drawn on the plot.
|
|
|
1037
1037
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1038
1038
|
|
|
1039
1039
|
|
|
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#
|
|
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#L2130)
|
|
1041
1041
|
|
|
1042
1042
|
Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
1043
1043
|
|
|
@@ -1045,7 +1045,7 @@ Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
|
1045
1045
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1046
1046
|
|
|
1047
1047
|
|
|
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#
|
|
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#L2142)
|
|
1049
1049
|
|
|
1050
1050
|
Draws circle markers on each vertex of a Line.
|
|
1051
1051
|
|
|
@@ -1053,7 +1053,7 @@ Draws circle markers on each vertex of a Line.
|
|
|
1053
1053
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1054
1054
|
|
|
1055
1055
|
|
|
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#
|
|
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#L2154)
|
|
1057
1057
|
|
|
1058
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.
|
|
1059
1059
|
|
|
@@ -1061,7 +1061,7 @@ A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs
|
|
|
1061
1061
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1062
1062
|
|
|
1063
1063
|
|
|
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#
|
|
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#L2164)
|
|
1065
1065
|
|
|
1066
1066
|
Sets the size of bubbles to the given Number, data key, or function.
|
|
1067
1067
|
|
|
@@ -1069,7 +1069,7 @@ Sets the size of bubbles to the given Number, data key, or function.
|
|
|
1069
1069
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1070
1070
|
|
|
1071
1071
|
|
|
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#
|
|
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#L2176)
|
|
1073
1073
|
|
|
1074
1074
|
Sets the size scale maximum to the specified number.
|
|
1075
1075
|
|
|
@@ -1077,7 +1077,7 @@ Sets the size scale maximum to the specified number.
|
|
|
1077
1077
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1078
1078
|
|
|
1079
1079
|
|
|
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#
|
|
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#L2186)
|
|
1081
1081
|
|
|
1082
1082
|
Sets the size scale minimum to the specified number.
|
|
1083
1083
|
|
|
@@ -1085,7 +1085,7 @@ Sets the size scale minimum to the specified number.
|
|
|
1085
1085
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1086
1086
|
|
|
1087
1087
|
|
|
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#
|
|
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#L2196)
|
|
1089
1089
|
|
|
1090
1090
|
Sets the size scale to the specified string.
|
|
1091
1091
|
|
|
@@ -1093,7 +1093,7 @@ Sets the size scale to the specified string.
|
|
|
1093
1093
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1094
1094
|
|
|
1095
1095
|
|
|
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#
|
|
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#L2206)
|
|
1097
1097
|
|
|
1098
1098
|
If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.
|
|
1099
1099
|
|
|
@@ -1101,7 +1101,7 @@ If *value* is specified, toggles shape stacking. If *value* is not specified, re
|
|
|
1101
1101
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1102
1102
|
|
|
1103
1103
|
|
|
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#
|
|
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#L2216)
|
|
1105
1105
|
|
|
1106
1106
|
Sets the stack offset. If *value* is not specified, returns the current stack offset function.
|
|
1107
1107
|
|
|
@@ -1109,7 +1109,7 @@ Sets the stack offset. If *value* is not specified, returns the current stack of
|
|
|
1109
1109
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1110
1110
|
|
|
1111
1111
|
|
|
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#
|
|
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#L2232)
|
|
1113
1113
|
|
|
1114
1114
|
Sets the stack order. If *value* is not specified, returns the current stack order function.
|
|
1115
1115
|
|
|
@@ -1117,7 +1117,7 @@ Sets the stack order. If *value* is not specified, returns the current stack ord
|
|
|
1117
1117
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1118
1118
|
|
|
1119
1119
|
|
|
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#
|
|
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#L2252)
|
|
1121
1121
|
|
|
1122
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.
|
|
1123
1123
|
|
|
@@ -1125,7 +1125,7 @@ Sets the x accessor to the specified accessor Function or String representing wh
|
|
|
1125
1125
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1126
1126
|
|
|
1127
1127
|
|
|
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#
|
|
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#L2269)
|
|
1129
1129
|
|
|
1130
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.
|
|
1131
1131
|
|
|
@@ -1133,7 +1133,7 @@ Sets the x2 accessor to the specified accessor Function or String representing w
|
|
|
1133
1133
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1134
1134
|
|
|
1135
1135
|
|
|
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#
|
|
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#L2286)
|
|
1137
1137
|
|
|
1138
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.
|
|
1139
1139
|
|
|
@@ -1141,7 +1141,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
1141
1141
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1142
1142
|
|
|
1143
1143
|
|
|
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#
|
|
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#L2298)
|
|
1145
1145
|
|
|
1146
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.
|
|
1147
1147
|
|
|
@@ -1149,7 +1149,7 @@ When the width of the chart is less than or equal to this pixel value, and the x
|
|
|
1149
1149
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1150
1150
|
|
|
1151
1151
|
|
|
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#
|
|
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#L2308)
|
|
1153
1153
|
|
|
1154
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.
|
|
1155
1155
|
|
|
@@ -1157,7 +1157,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
1157
1157
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1158
1158
|
|
|
1159
1159
|
|
|
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#
|
|
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#L2320)
|
|
1161
1161
|
|
|
1162
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.
|
|
1163
1163
|
|
|
@@ -1165,7 +1165,7 @@ Sets the x domain to the specified array. If *value* is not specified, returns t
|
|
|
1165
1165
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1166
1166
|
|
|
1167
1167
|
|
|
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#
|
|
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#L2330)
|
|
1169
1169
|
|
|
1170
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.
|
|
1171
1171
|
|
|
@@ -1173,7 +1173,7 @@ Sets the x2 domain to the specified array. If *value* is not specified, returns
|
|
|
1173
1173
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1174
1174
|
|
|
1175
1175
|
|
|
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#
|
|
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#L2340)
|
|
1177
1177
|
|
|
1178
1178
|
Defines a custom sorting comparitor function to be used for discrete x axes.
|
|
1179
1179
|
|
|
@@ -1181,7 +1181,7 @@ Defines a custom sorting comparitor function to be used for discrete x axes.
|
|
|
1181
1181
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1182
1182
|
|
|
1183
1183
|
|
|
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#
|
|
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#L2350)
|
|
1185
1185
|
|
|
1186
1186
|
Defines a custom sorting comparitor function to be used for discrete x2 axes.
|
|
1187
1187
|
|
|
@@ -1189,7 +1189,7 @@ Defines a custom sorting comparitor function to be used for discrete x2 axes.
|
|
|
1189
1189
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1190
1190
|
|
|
1191
1191
|
|
|
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#
|
|
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#L2360)
|
|
1193
1193
|
|
|
1194
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.
|
|
1195
1195
|
|
|
@@ -1197,7 +1197,7 @@ Sets the y accessor to the specified accessor Function or String representing wh
|
|
|
1197
1197
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1198
1198
|
|
|
1199
1199
|
|
|
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#
|
|
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#L2377)
|
|
1201
1201
|
|
|
1202
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.
|
|
1203
1203
|
|
|
@@ -1205,7 +1205,7 @@ Sets the y2 accessor to the specified accessor Function or String representing w
|
|
|
1205
1205
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1206
1206
|
|
|
1207
1207
|
|
|
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#
|
|
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#L2396)
|
|
1209
1209
|
|
|
1210
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.
|
|
1211
1211
|
Note:* If a "domain" array is passed to the y-axis config, it will be reversed.
|
|
@@ -1214,7 +1214,7 @@ Note:* If a "domain" array is passed to the y-axis config, it will be reversed.
|
|
|
1214
1214
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1215
1215
|
|
|
1216
1216
|
|
|
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#
|
|
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#L2411)
|
|
1218
1218
|
|
|
1219
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.
|
|
1220
1220
|
|
|
@@ -1222,7 +1222,7 @@ When the height of the chart is less than or equal to this pixel value, and the
|
|
|
1222
1222
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1223
1223
|
|
|
1224
1224
|
|
|
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#
|
|
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#L2421)
|
|
1226
1226
|
|
|
1227
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.
|
|
1228
1228
|
|
|
@@ -1230,7 +1230,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
1230
1230
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1231
1231
|
|
|
1232
1232
|
|
|
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#
|
|
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#L2436)
|
|
1234
1234
|
|
|
1235
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.
|
|
1236
1236
|
|
|
@@ -1238,7 +1238,7 @@ Sets the y domain to the specified array. If *value* is not specified, returns t
|
|
|
1238
1238
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1239
1239
|
|
|
1240
1240
|
|
|
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#
|
|
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#L2446)
|
|
1242
1242
|
|
|
1243
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.
|
|
1244
1244
|
|
|
@@ -1246,7 +1246,7 @@ Sets the y2 domain to the specified array. If *value* is not specified, returns
|
|
|
1246
1246
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1247
1247
|
|
|
1248
1248
|
|
|
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#
|
|
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#L2456)
|
|
1250
1250
|
|
|
1251
1251
|
Defines a custom sorting comparitor function to be used for discrete y axes.
|
|
1252
1252
|
|
|
@@ -1254,7 +1254,7 @@ Defines a custom sorting comparitor function to be used for discrete y axes.
|
|
|
1254
1254
|
This is a static method of [<code>Plot</code>](#Plot), and is chainable with other methods of this Class.
|
|
1255
1255
|
|
|
1256
1256
|
|
|
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#
|
|
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#L2466)
|
|
1258
1258
|
|
|
1259
1259
|
Defines a custom sorting comparitor function to be used for discrete y2 axes.
|
|
1260
1260
|
|
|
@@ -1900,7 +1900,7 @@ This is a static method of [<code>Treemap</code>](#Treemap)
|
|
|
1900
1900
|
---
|
|
1901
1901
|
|
|
1902
1902
|
<a name="Viz"></a>
|
|
1903
|
-
#### **Viz** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
1903
|
+
#### **Viz** [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L86)
|
|
1904
1904
|
|
|
1905
1905
|
|
|
1906
1906
|
This is a global class, and extends all of the methods and functionality of [<code>BaseClass</code>](#BaseClass).
|
|
@@ -2009,7 +2009,7 @@ Creates an x/y plot based on an array of data. If *data* is specified, immediate
|
|
|
2009
2009
|
|
|
2010
2010
|
|
|
2011
2011
|
|
|
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#
|
|
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#L2107)
|
|
2013
2013
|
|
|
2014
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.
|
|
2015
2015
|
|
|
@@ -2017,7 +2017,7 @@ The behavior to be used when calculating the position and size of each shape's l
|
|
|
2017
2017
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2018
2018
|
|
|
2019
2019
|
|
|
2020
|
-
<a name="Viz.render" href="#Viz.render">#</a> Viz.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2020
|
+
<a name="Viz.render" href="#Viz.render">#</a> Viz.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L615)
|
|
2021
2021
|
|
|
2022
2022
|
Draws the visualization given the specified configuration.
|
|
2023
2023
|
|
|
@@ -2025,7 +2025,7 @@ Draws the visualization given the specified configuration.
|
|
|
2025
2025
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2026
2026
|
|
|
2027
2027
|
|
|
2028
|
-
<a name="Viz.active" href="#Viz.active">#</a> Viz.**active**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2028
|
+
<a name="Viz.active" href="#Viz.active">#</a> Viz.**active**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L862)
|
|
2029
2029
|
|
|
2030
2030
|
If *value* is specified, sets the active method to the specified function and returns the current class instance.
|
|
2031
2031
|
|
|
@@ -2033,7 +2033,7 @@ If *value* is specified, sets the active method to the specified function and re
|
|
|
2033
2033
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2034
2034
|
|
|
2035
2035
|
|
|
2036
|
-
<a name="Viz.aggs" href="#Viz.aggs">#</a> Viz.**aggs**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2036
|
+
<a name="Viz.aggs" href="#Viz.aggs">#</a> Viz.**aggs**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L879)
|
|
2037
2037
|
|
|
2038
2038
|
If *value* is specified, sets the aggregation method for each key in the object and returns the current class instance.
|
|
2039
2039
|
|
|
@@ -2041,7 +2041,7 @@ If *value* is specified, sets the aggregation method for each key in the object
|
|
|
2041
2041
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2042
2042
|
|
|
2043
2043
|
|
|
2044
|
-
<a name="Viz.ariaHidden" href="#Viz.ariaHidden">#</a> Viz.**ariaHidden**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2044
|
+
<a name="Viz.ariaHidden" href="#Viz.ariaHidden">#</a> Viz.**ariaHidden**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L891)
|
|
2045
2045
|
|
|
2046
2046
|
Sets the "aria-hidden" attribute of the containing SVG element. The default value is "false", but it you need to hide the SVG from screen readers set this property to "true".
|
|
2047
2047
|
|
|
@@ -2049,7 +2049,7 @@ Sets the "aria-hidden" attribute of the containing SVG element. The default valu
|
|
|
2049
2049
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2050
2050
|
|
|
2051
2051
|
|
|
2052
|
-
<a name="Viz.attribution" href="#Viz.attribution">#</a> Viz.**attribution**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2052
|
+
<a name="Viz.attribution" href="#Viz.attribution">#</a> Viz.**attribution**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L901)
|
|
2053
2053
|
|
|
2054
2054
|
Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).
|
|
2055
2055
|
|
|
@@ -2057,7 +2057,7 @@ Sets text to be shown positioned absolute on top of the visualization in the bot
|
|
|
2057
2057
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2058
2058
|
|
|
2059
2059
|
|
|
2060
|
-
<a name="Viz.attributionStyle" href="#Viz.attributionStyle">#</a> Viz.**attributionStyle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2060
|
+
<a name="Viz.attributionStyle" href="#Viz.attributionStyle">#</a> Viz.**attributionStyle**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L913)
|
|
2061
2061
|
|
|
2062
2062
|
If *value* is specified, sets the config method for the back button and returns the current class instance.
|
|
2063
2063
|
|
|
@@ -2065,7 +2065,7 @@ If *value* is specified, sets the config method for the back button and returns
|
|
|
2065
2065
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2066
2066
|
|
|
2067
2067
|
|
|
2068
|
-
<a name="Viz.backConfig" href="#Viz.backConfig">#</a> Viz.**backConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2068
|
+
<a name="Viz.backConfig" href="#Viz.backConfig">#</a> Viz.**backConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L925)
|
|
2069
2069
|
|
|
2070
2070
|
If *value* is specified, sets the config method for the back button and returns the current class instance.
|
|
2071
2071
|
|
|
@@ -2073,7 +2073,7 @@ If *value* is specified, sets the config method for the back button and returns
|
|
|
2073
2073
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2074
2074
|
|
|
2075
2075
|
|
|
2076
|
-
<a name="Viz.cache" href="#Viz.cache">#</a> Viz.**cache**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2076
|
+
<a name="Viz.cache" href="#Viz.cache">#</a> Viz.**cache**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L937)
|
|
2077
2077
|
|
|
2078
2078
|
Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.
|
|
2079
2079
|
|
|
@@ -2081,7 +2081,7 @@ Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful wh
|
|
|
2081
2081
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2082
2082
|
|
|
2083
2083
|
|
|
2084
|
-
<a name="Viz.color" href="#Viz.color">#</a> Viz.**color**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2084
|
+
<a name="Viz.color" href="#Viz.color">#</a> Viz.**color**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L947)
|
|
2085
2085
|
|
|
2086
2086
|
Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.
|
|
2087
2087
|
|
|
@@ -2089,7 +2089,7 @@ Defines the main color to be used for each data point in a visualization. Can be
|
|
|
2089
2089
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2090
2090
|
|
|
2091
2091
|
|
|
2092
|
-
<a name="Viz.colorScale" href="#Viz.colorScale">#</a> Viz.**colorScale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2092
|
+
<a name="Viz.colorScale" href="#Viz.colorScale">#</a> Viz.**colorScale**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L959)
|
|
2093
2093
|
|
|
2094
2094
|
Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.
|
|
2095
2095
|
|
|
@@ -2097,7 +2097,7 @@ Defines the value to be used for a color scale. Can be either an accessor functi
|
|
|
2097
2097
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2098
2098
|
|
|
2099
2099
|
|
|
2100
|
-
<a name="Viz.colorScaleConfig" href="#Viz.colorScaleConfig">#</a> Viz.**colorScaleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2100
|
+
<a name="Viz.colorScaleConfig" href="#Viz.colorScaleConfig">#</a> Viz.**colorScaleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L972)
|
|
2101
2101
|
|
|
2102
2102
|
A pass-through to the config method of ColorScale.
|
|
2103
2103
|
|
|
@@ -2105,7 +2105,7 @@ A pass-through to the config method of ColorScale.
|
|
|
2105
2105
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2106
2106
|
|
|
2107
2107
|
|
|
2108
|
-
<a name="Viz.colorScalePadding" href="#Viz.colorScalePadding">#</a> Viz.**colorScalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2108
|
+
<a name="Viz.colorScalePadding" href="#Viz.colorScalePadding">#</a> Viz.**colorScalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L984)
|
|
2109
2109
|
|
|
2110
2110
|
Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
2111
2111
|
|
|
@@ -2113,7 +2113,7 @@ Tells the colorScale whether or not to use the internal padding defined by the v
|
|
|
2113
2113
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2114
2114
|
|
|
2115
2115
|
|
|
2116
|
-
<a name="Viz.colorScalePosition" href="#Viz.colorScalePosition">#</a> Viz.**colorScalePosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2116
|
+
<a name="Viz.colorScalePosition" href="#Viz.colorScalePosition">#</a> Viz.**colorScalePosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L997)
|
|
2117
2117
|
|
|
2118
2118
|
Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.
|
|
2119
2119
|
|
|
@@ -2121,7 +2121,7 @@ Defines which side of the visualization to anchor the color scale. Acceptable va
|
|
|
2121
2121
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2122
2122
|
|
|
2123
2123
|
|
|
2124
|
-
<a name="Viz.colorScaleMaxSize" href="#Viz.colorScaleMaxSize">#</a> Viz.**colorScaleMaxSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2124
|
+
<a name="Viz.colorScaleMaxSize" href="#Viz.colorScaleMaxSize">#</a> Viz.**colorScaleMaxSize**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1010)
|
|
2125
2125
|
|
|
2126
2126
|
Sets the maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.
|
|
2127
2127
|
|
|
@@ -2129,7 +2129,7 @@ Sets the maximum pixel size for drawing the color scale: width for horizontal sc
|
|
|
2129
2129
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2130
2130
|
|
|
2131
2131
|
|
|
2132
|
-
<a name="Viz.data" href="#Viz.data">#</a> Viz.**data**(*data*, [*formatter*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2132
|
+
<a name="Viz.data" href="#Viz.data">#</a> Viz.**data**(*data*, [*formatter*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1031)
|
|
2133
2133
|
|
|
2134
2134
|
Sets the primary data array to be used when drawing the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.
|
|
2135
2135
|
|
|
@@ -2145,7 +2145,7 @@ If *data* is not specified, this method returns the current primary data array,
|
|
|
2145
2145
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2146
2146
|
|
|
2147
2147
|
|
|
2148
|
-
<a name="Viz.dataCutoff" href="#Viz.dataCutoff">#</a> Viz.**dataCutoff**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2148
|
+
<a name="Viz.dataCutoff" href="#Viz.dataCutoff">#</a> Viz.**dataCutoff**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1055)
|
|
2149
2149
|
|
|
2150
2150
|
If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).
|
|
2151
2151
|
|
|
@@ -2153,7 +2153,7 @@ If the number of visible data points exceeds this number, the default hover beha
|
|
|
2153
2153
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2154
2154
|
|
|
2155
2155
|
|
|
2156
|
-
<a name="Viz.depth" href="#Viz.depth">#</a> Viz.**depth**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2156
|
+
<a name="Viz.depth" href="#Viz.depth">#</a> Viz.**depth**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1065)
|
|
2157
2157
|
|
|
2158
2158
|
If *value* is specified, sets the depth to the specified number and returns the current class instance. The *value* should correspond with an index in the [groupBy](#groupBy) array.
|
|
2159
2159
|
|
|
@@ -2161,7 +2161,7 @@ If *value* is specified, sets the depth to the specified number and returns the
|
|
|
2161
2161
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2162
2162
|
|
|
2163
2163
|
|
|
2164
|
-
<a name="Viz.detectResize" href="#Viz.detectResize">#</a> Viz.**detectResize**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2164
|
+
<a name="Viz.detectResize" href="#Viz.detectResize">#</a> Viz.**detectResize**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1075)
|
|
2165
2165
|
|
|
2166
2166
|
If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.
|
|
2167
2167
|
|
|
@@ -2169,7 +2169,7 @@ If the width and/or height of a Viz is not user-defined, it is determined by the
|
|
|
2169
2169
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2170
2170
|
|
|
2171
2171
|
|
|
2172
|
-
<a name="Viz.detectResizeDelay" href="#Viz.detectResizeDelay">#</a> Viz.**detectResizeDelay**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2172
|
+
<a name="Viz.detectResizeDelay" href="#Viz.detectResizeDelay">#</a> Viz.**detectResizeDelay**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1087)
|
|
2173
2173
|
|
|
2174
2174
|
When resizing the browser window, this is the millisecond delay to trigger the resize event.
|
|
2175
2175
|
|
|
@@ -2177,7 +2177,7 @@ When resizing the browser window, this is the millisecond delay to trigger the r
|
|
|
2177
2177
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2178
2178
|
|
|
2179
2179
|
|
|
2180
|
-
<a name="Viz.detectVisible" href="#Viz.detectVisible">#</a> Viz.**detectVisible**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2180
|
+
<a name="Viz.detectVisible" href="#Viz.detectVisible">#</a> Viz.**detectVisible**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1099)
|
|
2181
2181
|
|
|
2182
2182
|
Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.
|
|
2183
2183
|
|
|
@@ -2185,7 +2185,7 @@ Toggles whether or not the Viz should try to detect if it visible in the current
|
|
|
2185
2185
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2186
2186
|
|
|
2187
2187
|
|
|
2188
|
-
<a name="Viz.detectVisibleInterval" href="#Viz.detectVisibleInterval">#</a> Viz.**detectVisibleInterval**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2188
|
+
<a name="Viz.detectVisibleInterval" href="#Viz.detectVisibleInterval">#</a> Viz.**detectVisibleInterval**(*value*) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1111)
|
|
2189
2189
|
|
|
2190
2190
|
The interval, in milliseconds, for checking if the visualization is visible on the page.
|
|
2191
2191
|
|
|
@@ -2193,7 +2193,7 @@ The interval, in milliseconds, for checking if the visualization is visible on t
|
|
|
2193
2193
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2194
2194
|
|
|
2195
2195
|
|
|
2196
|
-
<a name="Viz.discrete" href="#Viz.discrete">#</a> Viz.**discrete**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2196
|
+
<a name="Viz.discrete" href="#Viz.discrete">#</a> Viz.**discrete**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1123)
|
|
2197
2197
|
|
|
2198
2198
|
If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.
|
|
2199
2199
|
|
|
@@ -2201,7 +2201,7 @@ If *value* is specified, sets the discrete accessor to the specified method name
|
|
|
2201
2201
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2202
2202
|
|
|
2203
2203
|
|
|
2204
|
-
<a name="Viz.downloadButton" href="#Viz.downloadButton">#</a> Viz.**downloadButton**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2204
|
+
<a name="Viz.downloadButton" href="#Viz.downloadButton">#</a> Viz.**downloadButton**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1133)
|
|
2205
2205
|
|
|
2206
2206
|
Shows a button that allows for downloading the current visualization.
|
|
2207
2207
|
|
|
@@ -2209,7 +2209,7 @@ Shows a button that allows for downloading the current visualization.
|
|
|
2209
2209
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2210
2210
|
|
|
2211
2211
|
|
|
2212
|
-
<a name="Viz.downloadConfig" href="#Viz.downloadConfig">#</a> Viz.**downloadConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2212
|
+
<a name="Viz.downloadConfig" href="#Viz.downloadConfig">#</a> Viz.**downloadConfig**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1145)
|
|
2213
2213
|
|
|
2214
2214
|
Sets specific options of the saveElement function used when downloading the visualization.
|
|
2215
2215
|
|
|
@@ -2217,7 +2217,7 @@ Sets specific options of the saveElement function used when downloading the visu
|
|
|
2217
2217
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2218
2218
|
|
|
2219
2219
|
|
|
2220
|
-
<a name="Viz.downloadPosition" href="#Viz.downloadPosition">#</a> Viz.**downloadPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2220
|
+
<a name="Viz.downloadPosition" href="#Viz.downloadPosition">#</a> Viz.**downloadPosition**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1157)
|
|
2221
2221
|
|
|
2222
2222
|
Defines which control group to add the download button into.
|
|
2223
2223
|
|
|
@@ -2225,7 +2225,7 @@ Defines which control group to add the download button into.
|
|
|
2225
2225
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2226
2226
|
|
|
2227
2227
|
|
|
2228
|
-
<a name="Viz.duration" href="#Viz.duration">#</a> Viz.**duration**([*ms*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2228
|
+
<a name="Viz.duration" href="#Viz.duration">#</a> Viz.**duration**([*ms*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1169)
|
|
2229
2229
|
|
|
2230
2230
|
If *ms* is specified, sets the animation duration to the specified number and returns the current class instance. If *ms* is not specified, returns the current animation duration.
|
|
2231
2231
|
|
|
@@ -2233,7 +2233,7 @@ If *ms* is specified, sets the animation duration to the specified number and re
|
|
|
2233
2233
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2234
2234
|
|
|
2235
2235
|
|
|
2236
|
-
<a name="Viz.filter" href="#Viz.filter">#</a> Viz.**filter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2236
|
+
<a name="Viz.filter" href="#Viz.filter">#</a> Viz.**filter**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1179)
|
|
2237
2237
|
|
|
2238
2238
|
If *value* is specified, sets the filter to the specified function and returns the current class instance.
|
|
2239
2239
|
|
|
@@ -2241,7 +2241,7 @@ If *value* is specified, sets the filter to the specified function and returns t
|
|
|
2241
2241
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2242
2242
|
|
|
2243
2243
|
|
|
2244
|
-
<a name="Viz.fontFamily" href="#Viz.fontFamily">#</a> Viz.**fontFamily**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#
|
|
2244
|
+
<a name="Viz.fontFamily" href="#Viz.fontFamily">#</a> Viz.**fontFamily**([*value*]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Viz.js#L1189)
|
|
2245
2245
|
|
|
2246
2246
|
If *value* is specified, sets the filter to the specified function and returns the current class instance.
|
|
2247
2247
|
|
|
@@ -2249,7 +2249,7 @@ If *value* is specified, sets the filter to the specified function and returns t
|
|
|
2249
2249
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2250
2250
|
|
|
2251
2251
|
|
|
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#
|
|
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#L1225)
|
|
2253
2253
|
|
|
2254
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.
|
|
2255
2255
|
|
|
@@ -2257,7 +2257,7 @@ Defines the mapping between data and shape. The value can be a String matching a
|
|
|
2257
2257
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2258
2258
|
|
|
2259
2259
|
|
|
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#
|
|
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#L1252)
|
|
2261
2261
|
|
|
2262
2262
|
If *value* is specified, sets the overall height to the specified number and returns the current class instance.
|
|
2263
2263
|
|
|
@@ -2265,7 +2265,7 @@ If *value* is specified, sets the overall height to the specified number and ret
|
|
|
2265
2265
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2266
2266
|
|
|
2267
2267
|
|
|
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#
|
|
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#L1262)
|
|
2269
2269
|
|
|
2270
2270
|
Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
2271
2271
|
|
|
@@ -2273,7 +2273,7 @@ Defines the color used for legend shapes when the corresponding grouping is hidd
|
|
|
2273
2273
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2274
2274
|
|
|
2275
2275
|
|
|
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#
|
|
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#L1274)
|
|
2277
2277
|
|
|
2278
2278
|
Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
2279
2279
|
|
|
@@ -2281,7 +2281,7 @@ Defines the opacity used for legend labels when the corresponding grouping is hi
|
|
|
2281
2281
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2282
2282
|
|
|
2283
2283
|
|
|
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#
|
|
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#L1287)
|
|
2285
2285
|
|
|
2286
2286
|
If *value* is specified, sets the hover method to the specified function and returns the current class instance.
|
|
2287
2287
|
|
|
@@ -2289,7 +2289,7 @@ If *value* is specified, sets the hover method to the specified function and ret
|
|
|
2289
2289
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2290
2290
|
|
|
2291
2291
|
|
|
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#
|
|
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#L1322)
|
|
2293
2293
|
|
|
2294
2294
|
If *value* is specified, sets the label accessor to the specified function or string and returns the current class instance.
|
|
2295
2295
|
|
|
@@ -2297,7 +2297,7 @@ If *value* is specified, sets the label accessor to the specified function or st
|
|
|
2297
2297
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2298
2298
|
|
|
2299
2299
|
|
|
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#
|
|
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#L1334)
|
|
2301
2301
|
|
|
2302
2302
|
If *value* is specified, toggles the legend based on the specified boolean and returns the current class instance.
|
|
2303
2303
|
|
|
@@ -2305,7 +2305,7 @@ If *value* is specified, toggles the legend based on the specified boolean and r
|
|
|
2305
2305
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2306
2306
|
|
|
2307
2307
|
|
|
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#
|
|
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#L1346)
|
|
2309
2309
|
|
|
2310
2310
|
If *value* is specified, the object is passed to the legend's config method.
|
|
2311
2311
|
|
|
@@ -2313,7 +2313,7 @@ If *value* is specified, the object is passed to the legend's config method.
|
|
|
2313
2313
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2314
2314
|
|
|
2315
2315
|
|
|
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#
|
|
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#L1358)
|
|
2317
2317
|
|
|
2318
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.
|
|
2319
2319
|
|
|
@@ -2321,7 +2321,7 @@ Defines the click functionality of categorical legend squares. When set to false
|
|
|
2321
2321
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2322
2322
|
|
|
2323
2323
|
|
|
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#
|
|
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#L1371)
|
|
2325
2325
|
|
|
2326
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.
|
|
2327
2327
|
|
|
@@ -2329,7 +2329,7 @@ Tells the legend whether or not to use the internal padding defined by the visua
|
|
|
2329
2329
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2330
2330
|
|
|
2331
2331
|
|
|
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#
|
|
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#L1384)
|
|
2333
2333
|
|
|
2334
2334
|
Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.
|
|
2335
2335
|
|
|
@@ -2337,7 +2337,7 @@ Defines which side of the visualization to anchor the legend. Expected values ar
|
|
|
2337
2337
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2338
2338
|
|
|
2339
2339
|
|
|
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#
|
|
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#L1397)
|
|
2341
2341
|
|
|
2342
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.
|
|
2343
2343
|
|
|
@@ -2345,7 +2345,7 @@ A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs
|
|
|
2345
2345
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2346
2346
|
|
|
2347
2347
|
|
|
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#
|
|
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#L1407)
|
|
2349
2349
|
|
|
2350
2350
|
If *value* is specified, sets the config method for the legend tooltip and returns the current class instance.
|
|
2351
2351
|
|
|
@@ -2353,7 +2353,7 @@ If *value* is specified, sets the config method for the legend tooltip and retur
|
|
|
2353
2353
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2354
2354
|
|
|
2355
2355
|
|
|
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#
|
|
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#L1419)
|
|
2357
2357
|
|
|
2358
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.
|
|
2359
2359
|
|
|
@@ -2361,7 +2361,7 @@ Sets the inner HTML of the status message that is displayed when loading AJAX re
|
|
|
2361
2361
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2362
2362
|
|
|
2363
2363
|
|
|
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#
|
|
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#L1431)
|
|
2365
2365
|
|
|
2366
2366
|
Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.
|
|
2367
2367
|
|
|
@@ -2369,7 +2369,7 @@ Toggles the visibility of the status message that is displayed when loading AJAX
|
|
|
2369
2369
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2370
2370
|
|
|
2371
2371
|
|
|
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#
|
|
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#L1443)
|
|
2373
2373
|
|
|
2374
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.
|
|
2375
2375
|
|
|
@@ -2377,7 +2377,7 @@ Sets the color of the mask used underneath the status message that is displayed
|
|
|
2377
2377
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2378
2378
|
|
|
2379
2379
|
|
|
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#
|
|
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#L1455)
|
|
2381
2381
|
|
|
2382
2382
|
Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.
|
|
2383
2383
|
|
|
@@ -2385,7 +2385,7 @@ Defines the CSS style properties for the status message that is displayed when l
|
|
|
2385
2385
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2386
2386
|
|
|
2387
2387
|
|
|
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#
|
|
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#L1467)
|
|
2389
2389
|
|
|
2390
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.
|
|
2391
2391
|
|
|
@@ -2393,7 +2393,7 @@ Sets the inner HTML of the status message that is displayed when no data is supp
|
|
|
2393
2393
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2394
2394
|
|
|
2395
2395
|
|
|
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#
|
|
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#L1479)
|
|
2397
2397
|
|
|
2398
2398
|
Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.
|
|
2399
2399
|
|
|
@@ -2401,7 +2401,7 @@ Toggles the visibility of the status message that is displayed when no data is s
|
|
|
2401
2401
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2402
2402
|
|
|
2403
2403
|
|
|
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#
|
|
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#L1491)
|
|
2405
2405
|
|
|
2406
2406
|
If using resize detection, this method allow a custom override of the element to which the resize detection function gets attached.
|
|
2407
2407
|
|
|
@@ -2409,7 +2409,7 @@ If using resize detection, this method allow a custom override of the element to
|
|
|
2409
2409
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2410
2410
|
|
|
2411
2411
|
|
|
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#
|
|
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#L1503)
|
|
2413
2413
|
|
|
2414
2414
|
If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.
|
|
2415
2415
|
|
|
@@ -2417,7 +2417,7 @@ If using scroll or visibility detection, this method allow a custom override of
|
|
|
2417
2417
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2418
2418
|
|
|
2419
2419
|
|
|
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#
|
|
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#L1515)
|
|
2421
2421
|
|
|
2422
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.
|
|
2423
2423
|
|
|
@@ -2425,7 +2425,7 @@ If *selector* is specified, sets the SVG container element to the specified d3 s
|
|
|
2425
2425
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2426
2426
|
|
|
2427
2427
|
|
|
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#
|
|
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#L1525)
|
|
2429
2429
|
|
|
2430
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.
|
|
2431
2431
|
|
|
@@ -2433,7 +2433,7 @@ Changes the primary shape used to represent each data point in a visualization.
|
|
|
2433
2433
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2434
2434
|
|
|
2435
2435
|
|
|
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#
|
|
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#L1537)
|
|
2437
2437
|
|
|
2438
2438
|
If *value* is specified, sets the config method for each shape and returns the current class instance.
|
|
2439
2439
|
|
|
@@ -2441,7 +2441,7 @@ If *value* is specified, sets the config method for each shape and returns the c
|
|
|
2441
2441
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2442
2442
|
|
|
2443
2443
|
|
|
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#
|
|
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#L1549)
|
|
2445
2445
|
|
|
2446
2446
|
If *value* is specified, sets the subtitle accessor to the specified function or string and returns the current class instance.
|
|
2447
2447
|
|
|
@@ -2449,7 +2449,7 @@ If *value* is specified, sets the subtitle accessor to the specified function or
|
|
|
2449
2449
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2450
2450
|
|
|
2451
2451
|
|
|
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#
|
|
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#L1561)
|
|
2453
2453
|
|
|
2454
2454
|
If *value* is specified, sets the config method for the subtitle and returns the current class instance.
|
|
2455
2455
|
|
|
@@ -2457,7 +2457,7 @@ If *value* is specified, sets the config method for the subtitle and returns the
|
|
|
2457
2457
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2458
2458
|
|
|
2459
2459
|
|
|
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#
|
|
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#L1573)
|
|
2461
2461
|
|
|
2462
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.
|
|
2463
2463
|
|
|
@@ -2465,7 +2465,7 @@ Tells the subtitle whether or not to use the internal padding defined by the vis
|
|
|
2465
2465
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2466
2466
|
|
|
2467
2467
|
|
|
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#
|
|
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#L1586)
|
|
2469
2469
|
|
|
2470
2470
|
If *value* is specified, sets the description accessor to the specified string and returns the current class instance.
|
|
2471
2471
|
|
|
@@ -2473,7 +2473,7 @@ If *value* is specified, sets the description accessor to the specified string a
|
|
|
2473
2473
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2474
2474
|
|
|
2475
2475
|
|
|
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#
|
|
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#L1596)
|
|
2477
2477
|
|
|
2478
2478
|
If *value* is specified, sets the title accessor to the specified string and returns the current class instance.
|
|
2479
2479
|
|
|
@@ -2481,7 +2481,7 @@ If *value* is specified, sets the title accessor to the specified string and ret
|
|
|
2481
2481
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2482
2482
|
|
|
2483
2483
|
|
|
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#
|
|
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#L1606)
|
|
2485
2485
|
|
|
2486
2486
|
If *value* is specified, sets the threshold for buckets to the specified function or string, and returns the current class instance.
|
|
2487
2487
|
|
|
@@ -2489,7 +2489,7 @@ If *value* is specified, sets the threshold for buckets to the specified functio
|
|
|
2489
2489
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2490
2490
|
|
|
2491
2491
|
|
|
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#
|
|
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#L1623)
|
|
2493
2493
|
|
|
2494
2494
|
If *value* is specified, sets the accesor for the value used in the threshold algorithm, and returns the current class instance.
|
|
2495
2495
|
|
|
@@ -2497,7 +2497,7 @@ If *value* is specified, sets the accesor for the value used in the threshold al
|
|
|
2497
2497
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2498
2498
|
|
|
2499
2499
|
|
|
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#
|
|
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#L1640)
|
|
2501
2501
|
|
|
2502
2502
|
If *value* is specified, sets the label for the bucket item, and returns the current class instance.
|
|
2503
2503
|
|
|
@@ -2505,7 +2505,7 @@ If *value* is specified, sets the label for the bucket item, and returns the cur
|
|
|
2505
2505
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2506
2506
|
|
|
2507
2507
|
|
|
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#
|
|
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#L1653)
|
|
2509
2509
|
|
|
2510
2510
|
If *value* is specified, sets the time accessor to the specified function or string and returns the current class instance.
|
|
2511
2511
|
|
|
@@ -2513,7 +2513,7 @@ If *value* is specified, sets the time accessor to the specified function or str
|
|
|
2513
2513
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2514
2514
|
|
|
2515
2515
|
|
|
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#
|
|
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#L1689)
|
|
2517
2517
|
|
|
2518
2518
|
If *value* is specified, sets the time filter to the specified function and returns the current class instance.
|
|
2519
2519
|
|
|
@@ -2521,7 +2521,7 @@ If *value* is specified, sets the time filter to the specified function and retu
|
|
|
2521
2521
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2522
2522
|
|
|
2523
2523
|
|
|
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#
|
|
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#L1699)
|
|
2525
2525
|
|
|
2526
2526
|
If *value* is specified, toggles the timeline based on the specified boolean and returns the current class instance.
|
|
2527
2527
|
|
|
@@ -2529,7 +2529,7 @@ If *value* is specified, toggles the timeline based on the specified boolean and
|
|
|
2529
2529
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2530
2530
|
|
|
2531
2531
|
|
|
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#
|
|
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#L1709)
|
|
2533
2533
|
|
|
2534
2534
|
If *value* is specified, sets the config method for the timeline and returns the current class instance.
|
|
2535
2535
|
|
|
@@ -2537,7 +2537,7 @@ If *value* is specified, sets the config method for the timeline and returns the
|
|
|
2537
2537
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2538
2538
|
|
|
2539
2539
|
|
|
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#
|
|
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#L1721)
|
|
2541
2541
|
|
|
2542
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.
|
|
2543
2543
|
|
|
@@ -2545,7 +2545,7 @@ Sets the starting time or range for the timeline. The value provided can either
|
|
|
2545
2545
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2546
2546
|
|
|
2547
2547
|
|
|
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#
|
|
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#L1735)
|
|
2549
2549
|
|
|
2550
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.
|
|
2551
2551
|
|
|
@@ -2553,7 +2553,7 @@ Tells the timeline whether or not to use the internal padding defined by the vis
|
|
|
2553
2553
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2554
2554
|
|
|
2555
2555
|
|
|
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#
|
|
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#L1748)
|
|
2557
2557
|
|
|
2558
2558
|
If *value* is specified, sets the title accessor to the specified function or string and returns the current class instance.
|
|
2559
2559
|
|
|
@@ -2561,7 +2561,7 @@ If *value* is specified, sets the title accessor to the specified function or st
|
|
|
2561
2561
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2562
2562
|
|
|
2563
2563
|
|
|
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#
|
|
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#L1760)
|
|
2565
2565
|
|
|
2566
2566
|
If *value* is specified, sets the config method for the title and returns the current class instance.
|
|
2567
2567
|
|
|
@@ -2569,7 +2569,7 @@ If *value* is specified, sets the config method for the title and returns the cu
|
|
|
2569
2569
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2570
2570
|
|
|
2571
2571
|
|
|
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#
|
|
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#L1772)
|
|
2573
2573
|
|
|
2574
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.
|
|
2575
2575
|
|
|
@@ -2577,7 +2577,7 @@ Tells the title whether or not to use the internal padding defined by the visual
|
|
|
2577
2577
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2578
2578
|
|
|
2579
2579
|
|
|
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#
|
|
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#L1784)
|
|
2581
2581
|
|
|
2582
2582
|
If *value* is specified, toggles the tooltip based on the specified boolean and returns the current class instance.
|
|
2583
2583
|
|
|
@@ -2585,7 +2585,7 @@ If *value* is specified, toggles the tooltip based on the specified boolean and
|
|
|
2585
2585
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2586
2586
|
|
|
2587
2587
|
|
|
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#
|
|
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#L1796)
|
|
2589
2589
|
|
|
2590
2590
|
If *value* is specified, sets the config method for the tooltip and returns the current class instance.
|
|
2591
2591
|
|
|
@@ -2593,7 +2593,7 @@ If *value* is specified, sets the config method for the tooltip and returns the
|
|
|
2593
2593
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2594
2594
|
|
|
2595
2595
|
|
|
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#
|
|
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#L1808)
|
|
2597
2597
|
|
|
2598
2598
|
If *value* is specified, sets the total accessor to the specified function or string and returns the current class instance.
|
|
2599
2599
|
|
|
@@ -2601,7 +2601,7 @@ If *value* is specified, sets the total accessor to the specified function or st
|
|
|
2601
2601
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2602
2602
|
|
|
2603
2603
|
|
|
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#
|
|
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#L1823)
|
|
2605
2605
|
|
|
2606
2606
|
If *value* is specified, sets the config method for the total and returns the current class instance.
|
|
2607
2607
|
|
|
@@ -2609,7 +2609,7 @@ If *value* is specified, sets the config method for the total and returns the cu
|
|
|
2609
2609
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2610
2610
|
|
|
2611
2611
|
|
|
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#
|
|
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#L1835)
|
|
2613
2613
|
|
|
2614
2614
|
Formatter function for the value in the total bar.
|
|
2615
2615
|
|
|
@@ -2617,7 +2617,7 @@ Formatter function for the value in the total bar.
|
|
|
2617
2617
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2618
2618
|
|
|
2619
2619
|
|
|
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#
|
|
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#L1847)
|
|
2621
2621
|
|
|
2622
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.
|
|
2623
2623
|
|
|
@@ -2625,7 +2625,7 @@ Tells the total whether or not to use the internal padding defined by the visual
|
|
|
2625
2625
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2626
2626
|
|
|
2627
2627
|
|
|
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#
|
|
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#L1859)
|
|
2629
2629
|
|
|
2630
2630
|
If *value* is specified, sets the overallwidth to the specified number and returns the current class instance.
|
|
2631
2631
|
|
|
@@ -2633,7 +2633,7 @@ If *value* is specified, sets the overallwidth to the specified number and retur
|
|
|
2633
2633
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2634
2634
|
|
|
2635
2635
|
|
|
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#
|
|
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#L1869)
|
|
2637
2637
|
|
|
2638
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.
|
|
2639
2639
|
|
|
@@ -2641,7 +2641,7 @@ Toggles the ability to zoom/pan the visualization. Certain parameters for zoomin
|
|
|
2641
2641
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2642
2642
|
|
|
2643
2643
|
|
|
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#
|
|
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#L1879)
|
|
2645
2645
|
|
|
2646
2646
|
The pixel stroke-width of the zoom brush area.
|
|
2647
2647
|
|
|
@@ -2649,7 +2649,7 @@ The pixel stroke-width of the zoom brush area.
|
|
|
2649
2649
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2650
2650
|
|
|
2651
2651
|
|
|
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#
|
|
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#L1891)
|
|
2653
2653
|
|
|
2654
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.
|
|
2655
2655
|
|
|
@@ -2657,7 +2657,7 @@ An object containing CSS key/value pairs that is used to style the outer handle
|
|
|
2657
2657
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2658
2658
|
|
|
2659
2659
|
|
|
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#
|
|
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#L1903)
|
|
2661
2661
|
|
|
2662
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.
|
|
2663
2663
|
|
|
@@ -2665,7 +2665,7 @@ An object containing CSS key/value pairs that is used to style the inner selecti
|
|
|
2665
2665
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2666
2666
|
|
|
2667
2667
|
|
|
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#
|
|
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#L1915)
|
|
2669
2669
|
|
|
2670
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.
|
|
2671
2671
|
|
|
@@ -2673,7 +2673,7 @@ An object containing CSS key/value pairs that is used to style each zoom control
|
|
|
2673
2673
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2674
2674
|
|
|
2675
2675
|
|
|
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#
|
|
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#L1927)
|
|
2677
2677
|
|
|
2678
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.
|
|
2679
2679
|
|
|
@@ -2681,7 +2681,7 @@ An object containing CSS key/value pairs that is used to style each zoom control
|
|
|
2681
2681
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2682
2682
|
|
|
2683
2683
|
|
|
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#
|
|
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#L1939)
|
|
2685
2685
|
|
|
2686
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.
|
|
2687
2687
|
|
|
@@ -2689,7 +2689,7 @@ An object containing CSS key/value pairs that is used to style each zoom control
|
|
|
2689
2689
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2690
2690
|
|
|
2691
2691
|
|
|
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#
|
|
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#L1951)
|
|
2693
2693
|
|
|
2694
2694
|
The multiplier that is used in with the control buttons when zooming in and out.
|
|
2695
2695
|
|
|
@@ -2697,7 +2697,7 @@ The multiplier that is used in with the control buttons when zooming in and out.
|
|
|
2697
2697
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2698
2698
|
|
|
2699
2699
|
|
|
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#
|
|
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#L1961)
|
|
2701
2701
|
|
|
2702
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.
|
|
2703
2703
|
|
|
@@ -2705,7 +2705,7 @@ If *value* is specified, sets the max zoom scale to the specified number and ret
|
|
|
2705
2705
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2706
2706
|
|
|
2707
2707
|
|
|
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#
|
|
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#L1971)
|
|
2709
2709
|
|
|
2710
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.
|
|
2711
2711
|
|
|
@@ -2713,7 +2713,7 @@ If *value* is specified, toggles panning to the specified boolean and returns th
|
|
|
2713
2713
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2714
2714
|
|
|
2715
2715
|
|
|
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#
|
|
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#L1981)
|
|
2717
2717
|
|
|
2718
2718
|
A pixel value to be used to pad all sides of a zoomed area.
|
|
2719
2719
|
|
|
@@ -2721,7 +2721,7 @@ A pixel value to be used to pad all sides of a zoomed area.
|
|
|
2721
2721
|
This is a static method of [<code>Viz</code>](#Viz), and is chainable with other methods of this Class.
|
|
2722
2722
|
|
|
2723
2723
|
|
|
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#
|
|
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#L1993)
|
|
2725
2725
|
|
|
2726
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.
|
|
2727
2727
|
|