From df8bb37e6057af90dc1404ab06e7f204b1532e9c Mon Sep 17 00:00:00 2001 From: Dave Landry Date: Fri, 9 Aug 2024 09:54:14 -0400 Subject: [PATCH] updates documentation --- README.md | 84 +++++++++++++++++++++++++++---------------------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index c38a389..8680d0c 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Live examples can be found on [d3plus.org](https://d3plus.org/), which includes --- -#### **Axis** [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L133) +#### **Axis** [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L138) This is a global class, and extends all of the methods and functionality of [BaseClass](https://github.com/d3plus/d3plus-common#BaseClass). @@ -96,7 +96,7 @@ Creates an SVG scale based on an array of data. -# Axis.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L361) +# Axis.**render**([*callback*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L366) Renders the current Axis to the page. If a *callback* is specified, it will be called once the legend is done drawing. @@ -104,7 +104,7 @@ Renders the current Axis to the page. If a *callback* is specified, it will be c This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**align**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1016) +# Axis.**align**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1020) If *value* is specified, sets the horizontal alignment to the specified value and returns the current class instance. @@ -112,7 +112,7 @@ If *value* is specified, sets the horizontal alignment to the specified value an This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**barConfig**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1026) +# Axis.**barConfig**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1030) If *value* is specified, sets the axis line style and returns the current class instance. @@ -120,7 +120,7 @@ If *value* is specified, sets the axis line style and returns the current class This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**data**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1036) +# Axis.**data**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1040) An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed. @@ -128,7 +128,7 @@ An array of data points, which helps determine which ticks should be shown and w This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**domain**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1046) +# Axis.**domain**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1050) If *value* is specified, sets the scale domain of the axis and returns the current class instance. @@ -136,7 +136,7 @@ If *value* is specified, sets the scale domain of the axis and returns the curre This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**duration**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1056) +# Axis.**duration**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1060) If *value* is specified, sets the transition duration of the axis and returns the current class instance. @@ -144,7 +144,7 @@ If *value* is specified, sets the transition duration of the axis and returns th This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**grid**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1066) +# Axis.**grid**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1070) If *value* is specified, sets the grid values of the axis and returns the current class instance. @@ -152,7 +152,7 @@ If *value* is specified, sets the grid values of the axis and returns the curren This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**gridConfig**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1076) +# Axis.**gridConfig**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1080) If *value* is specified, sets the grid config of the axis and returns the current class instance. @@ -160,7 +160,7 @@ If *value* is specified, sets the grid config of the axis and returns the curren This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**gridLog**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1086) +# Axis.**gridLog**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1090) If *value* is specified, sets the grid behavior of the axis when scale is logarithmic and returns the current class instance. @@ -168,7 +168,7 @@ If *value* is specified, sets the grid behavior of the axis when scale is logari This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**gridSize**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1096) +# Axis.**gridSize**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1100) If *value* is specified, sets the grid size of the axis and returns the current class instance. @@ -176,7 +176,7 @@ If *value* is specified, sets the grid size of the axis and returns the current This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**height**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1106) +# Axis.**height**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1110) If *value* is specified, sets the overall height of the axis and returns the current class instance. @@ -184,7 +184,7 @@ If *value* is specified, sets the overall height of the axis and returns the cur This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**labels**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1116) +# Axis.**labels**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1120) If *value* is specified, sets the visible tick labels of the axis and returns the current class instance. @@ -192,7 +192,7 @@ If *value* is specified, sets the visible tick labels of the axis and returns th This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**labelOffset**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1126) +# Axis.**labelOffset**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1130) If *value* is specified, sets whether offsets will be used to position some labels further away from the axis in order to allow space for the text. @@ -200,7 +200,7 @@ If *value* is specified, sets whether offsets will be used to position some labe This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**labelRotation**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1136) +# Axis.**labelRotation**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1140) If *value* is specified, sets whether whether horizontal axis labels are rotated -90 degrees. @@ -208,7 +208,7 @@ If *value* is specified, sets whether whether horizontal axis labels are rotated This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**maxSize**(_) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1146) +# Axis.**maxSize**(_) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1150) If *value* is specified, sets the maximum size allowed for the space that contains the axis tick labels and title. @@ -216,7 +216,7 @@ If *value* is specified, sets the maximum size allowed for the space that contai This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**minSize**(_) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1156) +# Axis.**minSize**(_) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1160) If *value* is specified, sets the minimum size alloted for the space that contains the axis tick labels and title. @@ -224,7 +224,7 @@ If *value* is specified, sets the minimum size alloted for the space that contai This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**orient**([*orient*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1166) +# Axis.**orient**([*orient*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1170) If *orient* is specified, sets the orientation of the shape and returns the current class instance. If *orient* is not specified, returns the current orientation. @@ -232,7 +232,7 @@ If *orient* is specified, sets the orientation of the shape and returns the curr This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**outerBounds**() [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1193) +# Axis.**outerBounds**() [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1197) If called after the elements have been drawn to DOM, will returns the outer bounds of the axis content. @@ -245,7 +245,7 @@ This is a static method of [Axis](#Axis). ``` -# Axis.**padding**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1203) +# Axis.**padding**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1207) If *value* is specified, sets the padding between each tick label to the specified number and returns the current class instance. @@ -253,7 +253,7 @@ If *value* is specified, sets the padding between each tick label to the specifi This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**paddingInner**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1213) +# Axis.**paddingInner**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1217) If *value* is specified, sets the inner padding of band scale to the specified number and returns the current class instance. @@ -261,7 +261,7 @@ If *value* is specified, sets the inner padding of band scale to the specified n This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**paddingOuter**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1223) +# Axis.**paddingOuter**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1227) If *value* is specified, sets the outer padding of band scales to the specified number and returns the current class instance. @@ -269,7 +269,7 @@ If *value* is specified, sets the outer padding of band scales to the specified This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**range**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1233) +# Axis.**range**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1237) If *value* is specified, sets the scale range (in pixels) of the axis and returns the current class instance. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value. @@ -277,7 +277,7 @@ If *value* is specified, sets the scale range (in pixels) of the axis and return This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**rounding**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1243) +# Axis.**rounding**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1247) Sets the rounding method, so that more evenly spaced ticks appear at the extents of the scale. Can be set to "none" (default), "outside", or "inside". @@ -285,7 +285,7 @@ Sets the rounding method, so that more evenly spaced ticks appear at the extents This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**roundingInsideMinPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1253) +# Axis.**roundingInsideMinPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1257) Sets the prefix used for the minimum value of "inside" rounding scales. @@ -293,7 +293,7 @@ Sets the prefix used for the minimum value of "inside" rounding scales. This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**roundingInsideMinSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1263) +# Axis.**roundingInsideMinSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1267) Sets the suffix used for the minimum value of "inside" rounding scales. @@ -301,7 +301,7 @@ Sets the suffix used for the minimum value of "inside" rounding scales. This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**roundingInsideMaxPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1273) +# Axis.**roundingInsideMaxPrefix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1277) Sets the prefix used for the maximum value of "inside" rounding scales. @@ -309,7 +309,7 @@ Sets the prefix used for the maximum value of "inside" rounding scales. This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**roundingInsideMaxSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1283) +# Axis.**roundingInsideMaxSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1287) Sets the suffix used for the maximum value of "inside" rounding scales. @@ -317,7 +317,7 @@ Sets the suffix used for the maximum value of "inside" rounding scales. This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**scale**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1293) +# Axis.**scale**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1297) If *value* is specified, sets the scale of the axis and returns the current class instance. @@ -325,7 +325,7 @@ If *value* is specified, sets the scale of the axis and returns the current clas This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**scalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1303) +# Axis.**scalePadding**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1307) Sets the "padding" property of the scale, often used in point scales. @@ -333,7 +333,7 @@ Sets the "padding" property of the scale, often used in point scales. This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1313) +# Axis.**select**([*selector*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1317) 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. @@ -341,7 +341,7 @@ If *selector* is specified, sets the SVG container element to the specified d3 s This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**shape**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1323) +# Axis.**shape**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1327) If *value* is specified, sets the tick shape constructor and returns the current class instance. @@ -349,7 +349,7 @@ If *value* is specified, sets the tick shape constructor and returns the current This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**shapeConfig**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1333) +# Axis.**shapeConfig**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1337) If *value* is specified, sets the tick style of the axis and returns the current class instance. @@ -357,7 +357,7 @@ If *value* is specified, sets the tick style of the axis and returns the current This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**tickFormat**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1343) +# Axis.**tickFormat**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1347) If *value* is specified, sets the tick formatter and returns the current class instance. @@ -365,7 +365,7 @@ If *value* is specified, sets the tick formatter and returns the current class i This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**ticks**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1353) +# Axis.**ticks**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1357) If *value* is specified, sets the tick values of the axis and returns the current class instance. @@ -373,7 +373,7 @@ If *value* is specified, sets the tick values of the axis and returns the curren This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**tickSize**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1363) +# Axis.**tickSize**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1367) If *value* is specified, sets the tick size of the axis and returns the current class instance. @@ -381,7 +381,7 @@ If *value* is specified, sets the tick size of the axis and returns the current This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**tickSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1373) +# Axis.**tickSuffix**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1377) Sets the behavior of the abbreviations when you are using linear scale. This method accepts two options: "normal" (uses formatAbbreviate to determinate the abbreviation) and "smallest" (uses suffix from the smallest tick as reference in every tick). @@ -389,7 +389,7 @@ Sets the behavior of the abbreviations when you are using linear scale. This met This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**timeLocale**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1383) +# Axis.**timeLocale**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1387) Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale). @@ -397,7 +397,7 @@ Defines a custom locale object to be used in time scale. This object must includ This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**title**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1393) +# Axis.**title**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1397) If *value* is specified, sets the title of the axis and returns the current class instance. @@ -405,7 +405,7 @@ If *value* is specified, sets the title of the axis and returns the current clas This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**titleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1403) +# Axis.**titleConfig**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1407) If *value* is specified, sets the title configuration of the axis and returns the current class instance. @@ -413,7 +413,7 @@ If *value* is specified, sets the title configuration of the axis and returns th This is a static method of [Axis](#Axis), and is chainable with other methods of this Class. -# Axis.**width**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1413) +# Axis.**width**([*value*]) [<>](https://github.com/d3plus/d3plus-axis/blob/master/src/Axis.js#L1417) If *value* is specified, sets the overall width of the axis and returns the current class instance. @@ -498,4 +498,4 @@ This is a global function. -###### Documentation generated on Thu, 08 Aug 2024 20:49:50 GMT +###### Documentation generated on Fri, 09 Aug 2024 13:54:14 GMT