@d3plus/docs 3.0.0-alpha.3

package/packages/dom/htmlDecode.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/dom/htmlDecode.args";
+import {htmlDecode} from "@d3plus/dom";
+
+export default {
+  title: "Dom/htmlDecode",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Strips HTML and \"un-escapes\" escape characters.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/dom/isObject.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/dom/isObject.args";
+import {isObject} from "@d3plus/dom";
+
+export default {
+  title: "Dom/isObject",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Detects if a variable is a javascript Object.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/dom/parseSides.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/dom/parseSides.args";
+import {parseSides} from "@d3plus/dom";
+
+export default {
+  title: "Dom/parseSides",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Converts a string of directional CSS shorthand values into an object with the values expanded.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/dom/prefix.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/dom/prefix.args";
+import {prefix} from "@d3plus/dom";
+
+export default {
+  title: "Dom/prefix",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Returns the appropriate CSS vendor prefix, given the current browser.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/dom/rtl.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/dom/rtl.args";
+import {rtl} from "@d3plus/dom";
+
+export default {
+  title: "Dom/rtl",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Returns true if the HTML or body element has either the \"dir\" HTML attribute or the \"direction\" CSS property set to \"rtl\".",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/dom/stylize.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/dom/stylize.args";
+import {stylize} from "@d3plus/dom";
+
+export default {
+  title: "Dom/stylize",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Applies each key/value in an object as a style.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/dom/textWidth.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/dom/textWidth.args";
+import {textWidth} from "@d3plus/dom";
+
+export default {
+  title: "Dom/textWidth",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Given a text string, returns the predicted pixel width of the string when placed into DOM.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/export/saveElement.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/export/saveElement.args";
+import {saveElement} from "@d3plus/export";
+
+export default {
+  title: "Export/saveElement",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Downloads an HTML Element as a bitmap PNG image.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/format/format.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/format/format.args";
+import {format} from "@d3plus/format";
+
+export default {
+  title: "Format/format",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "An extension to d3's [format](https://github.com/d3/d3-format#api-reference) function that adds more string formatting types and localizations.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/format/formatAbbreviate.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/format/formatAbbreviate.args";
+import {formatAbbreviate} from "@d3plus/format";
+
+export default {
+  title: "Format/formatAbbreviate",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Formats a number to an appropriate number of decimal places and rounding, adding suffixes if applicable (ie. 1200000 to \"1.2M\").",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/format/formatDate.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/format/formatDate.args";
+import {formatDate} from "@d3plus/format";
+
+export default {
+  title: "Format/formatDate",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "A default set of date formatters, which takes into account both the interval in between in each data point but also the start/end data points.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/format/formatDefaultLocale.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/format/formatDefaultLocale.args";
+import {formatDefaultLocale} from "@d3plus/format";
+
+export default {
+  title: "Format/formatDefaultLocale",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "An extension to d3's [formatDefaultLocale](https://github.com/d3/d3-format#api-reference) function that allows setting the locale globally for formatters.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/locales/dictionaries/formatLocale.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../../args/locales/dictionaries/formatLocale.args";
+import {formatLocale} from "@d3plus/locales";
+
+export default {
+  title: "Locales/Dictionaries/formatLocale",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "A set of default locale formatters used when assigning suffixes and currency in numbers.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/closest.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/closest.args";
+import {closest} from "@d3plus/math";
+
+export default {
+  title: "Math/closest",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Finds the closest numeric value in an array.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/largestRect.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/largestRect.args";
+import {largestRect} from "@d3plus/math";
+
+export default {
+  title: "Math/largestRect",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Simplifies the points of a polygon using both the Ramer-Douglas-Peucker algorithm and basic distance-based simplification. Adapted to an ES6 module from the excellent [Simplify.js](http://mourner.github.io/simplify-js/).",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/lineIntersection.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/lineIntersection.args";
+import {lineIntersection} from "@d3plus/math";
+
+export default {
+  title: "Math/lineIntersection",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Finds the intersection point (if there is one) of the lines p1q1 and p2q2.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/path2polygon.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/path2polygon.args";
+import {path2polygon} from "@d3plus/math";
+
+export default {
+  title: "Math/path2polygon",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Transforms a path string into an Array of points.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/pointDistance.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/pointDistance.args";
+import {pointDistance} from "@d3plus/math";
+
+export default {
+  title: "Math/pointDistance",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Calculates the pixel distance between two points.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/pointDistanceSquared.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/pointDistanceSquared.args";
+import {pointDistanceSquared} from "@d3plus/math";
+
+export default {
+  title: "Math/pointDistanceSquared",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Returns the squared euclidean distance between two points.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/pointRotate.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/pointRotate.args";
+import {pointRotate} from "@d3plus/math";
+
+export default {
+  title: "Math/pointRotate",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Rotates a point around a given origin.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/polygonInside.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/polygonInside.args";
+import {polygonInside} from "@d3plus/math";
+
+export default {
+  title: "Math/polygonInside",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Checks if one polygon is inside another polygon.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/polygonRayCast.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/polygonRayCast.args";
+import {polygonRayCast} from "@d3plus/math";
+
+export default {
+  title: "Math/polygonRayCast",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Gives the two closest intersection points between a ray cast from a point inside a polygon. The two points should lie on opposite sides of the origin.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/polygonRotate.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/polygonRotate.args";
+import {polygonRotate} from "@d3plus/math";
+
+export default {
+  title: "Math/polygonRotate",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Rotates a point around a given origin.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/segmentBoxContains.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/segmentBoxContains.args";
+import {segmentBoxContains} from "@d3plus/math";
+
+export default {
+  title: "Math/segmentBoxContains",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Checks whether a point is inside the bounding box of a line segment.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/segmentsIntersect.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/segmentsIntersect.args";
+import {segmentsIntersect} from "@d3plus/math";
+
+export default {
+  title: "Math/segmentsIntersect",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Checks whether the line segments p1q1 && p2q2 intersect.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/math/shapeEdgePoint.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/math/shapeEdgePoint.args";
+import {shapeEdgePoint} from "@d3plus/math";
+
+export default {
+  title: "Math/shapeEdgePoint",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "Calculates the x/y position of a point at the edge of a shape, from the center of the shape, given a specified pixel distance and radian angle.",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+

package/packages/react/D3plusContext.stories.jsx

@@ -0,0 +1,23 @@
+// WARNING: do not edit the top part of this file directly, it is generated
+// from the source code. Scroll down to the next WARNING and places stories below it.
+
+import React from "react";
+
+import {argTypes} from "../../args/react/D3plusContext.args";
+import {D3plusContext} from "@d3plus/react";
+
+export default {
+  title: "React/D3plusContext",
+  argTypes,
+  parameters: {
+    docs: {
+      description: {
+        component: "A React context instance used to provide global config options via a provider (D3plusContext.Provider).",
+      },
+    },
+  }
+};
+  
+// WARNING: do not edit above this line of code directly, it is generated
+// from the source code. Stories below this line can be modified.
+