@d3plus/docs 3.0.0-alpha.3

package/args/math/largestRect.args.jsx

@@ -0,0 +1,56 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  highestQuality: {
+    control: {
+      type: "boolean"
+    },
+    defaultValue: false,
+    description: "Excludes distance-based preprocessing step which leads to highest quality simplification but runs ~10-20 times slower.",
+    table: {
+      defaultValue: {
+        summary: false
+      }
+    },
+    type: {
+      required: false,
+      summary: "boolean"
+    }
+  },
+  poly: {
+    control: {
+      type: "array"
+    },
+    description: "An Array of points that represent a polygon.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  tolerance: {
+    control: {
+      type: "number"
+    },
+    defaultValue: 1,
+    description: "Affects the amount of simplification (in the same metric as the point coordinates).",
+    table: {
+      defaultValue: {
+        summary: 1
+      }
+    },
+    type: {
+      required: false,
+      summary: "number"
+    }
+  }
+};

package/args/math/lineIntersection.args.jsx

@@ -0,0 +1,69 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  p1: {
+    control: {
+      type: "array"
+    },
+    description: "The first point of the first line segment, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  p2: {
+    control: {
+      type: "array"
+    },
+    description: "The first point of the second line segment, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  q1: {
+    control: {
+      type: "array"
+    },
+    description: "The second point of the first line segment, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  q2: {
+    control: {
+      type: "array"
+    },
+    description: "The second point of the second line segment, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/math/path2polygon.args.jsx

@@ -0,0 +1,40 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  path: {
+    control: {
+      type: "text"
+    },
+    description: "An SVG string path, commonly the \"d\" property of a <path> element.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "string"
+    }
+  },
+  segmentLength: {
+    control: {
+      type: "number"
+    },
+    defaultValue: 50,
+    description: "The length of line segments when converting curves line segments. Higher values lower computation time, but will result in curves that are more rigid.",
+    table: {
+      defaultValue: {
+        summary: 50
+      }
+    },
+    type: {
+      required: false,
+      summary: "number"
+    }
+  }
+};

package/args/math/pointDistance.args.jsx

@@ -0,0 +1,39 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  p1: {
+    control: {
+      type: "array"
+    },
+    description: "The first point, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  p2: {
+    control: {
+      type: "array"
+    },
+    description: "The second point, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/math/pointDistanceSquared.args.jsx

@@ -0,0 +1,39 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  p1: {
+    control: {
+      type: "array"
+    },
+    description: "The first point, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  p2: {
+    control: {
+      type: "array"
+    },
+    description: "The second point, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/math/pointRotate.args.jsx

@@ -0,0 +1,55 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  alpha: {
+    control: {
+      type: "number"
+    },
+    description: "The angle in radians to rotate.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "number"
+    }
+  },
+  origin: {
+    control: {
+      type: "array"
+    },
+    defaultValue: "[0, 0]",
+    description: "The origin point of the rotation, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "[0, 0]"
+      }
+    },
+    type: {
+      required: false,
+      summary: "array"
+    }
+  },
+  p: {
+    control: {
+      type: "array"
+    },
+    description: "The point to be rotated, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/math/polygonInside.args.jsx

@@ -0,0 +1,39 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  polyA: {
+    control: {
+      type: "array"
+    },
+    description: "An Array of `[x, y]` points to be used as the inner polygon, checking if it is inside polyA.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  polyB: {
+    control: {
+      type: "array"
+    },
+    description: "An Array of `[x, y]` points to be used as the containing polygon.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/math/polygonRayCast.args.jsx

@@ -0,0 +1,55 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  alpha: {
+    control: {
+      type: "number"
+    },
+    defaultValue: 0,
+    description: "The angle in radians of the ray.",
+    table: {
+      defaultValue: {
+        summary: 0
+      }
+    },
+    type: {
+      required: false,
+      summary: "number"
+    }
+  },
+  origin: {
+    control: {
+      type: "array"
+    },
+    description: "The origin point of the ray to be cast, which should be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  poly: {
+    control: {
+      type: "array"
+    },
+    description: "The polygon to test against, which should be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/math/polygonRotate.args.jsx

@@ -0,0 +1,55 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  alpha: {
+    control: {
+      type: "number"
+    },
+    description: "The angle in radians to rotate.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "number"
+    }
+  },
+  origin: {
+    control: {
+      type: "array"
+    },
+    defaultValue: "[0, 0]",
+    description: "The origin point of the rotation, which should be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "[0, 0]"
+      }
+    },
+    type: {
+      required: false,
+      summary: "array"
+    }
+  },
+  poly: {
+    control: {
+      type: "array"
+    },
+    description: "The polygon to be rotated, which should be an Array of `[x, y]` values.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/math/segmentBoxContains.args.jsx

@@ -0,0 +1,54 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  p: {
+    control: {
+      type: "array"
+    },
+    description: "The point to be checked, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  s1: {
+    control: {
+      type: "array"
+    },
+    description: "The first point of the line segment to be used for the bounding box, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  s2: {
+    control: {
+      type: "array"
+    },
+    description: "The second point of the line segment to be used for the bounding box, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/math/segmentsIntersect.args.jsx

@@ -0,0 +1,69 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  p1: {
+    control: {
+      type: "array"
+    },
+    description: "The first point of the first line segment, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  p2: {
+    control: {
+      type: "array"
+    },
+    description: "The first point of the second line segment, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  q1: {
+    control: {
+      type: "array"
+    },
+    description: "The second point of the first line segment, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  q2: {
+    control: {
+      type: "array"
+    },
+    description: "The second point of the second line segment, which should always be an `[x, y]` formatted Array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/math/shapeEdgePoint.args.jsx

@@ -0,0 +1,39 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  angle: {
+    control: {
+      type: "number"
+    },
+    description: "The angle, in radians, of the offset point.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "number"
+    }
+  },
+  distance: {
+    control: {
+      type: "number"
+    },
+    description: "The pixel distance away from the origin.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "number"
+    }
+  }
+};

package/args/react/D3plusContext.args.jsx

@@ -0,0 +1,8 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {};

package/args/react/Renderer.args.jsx

@@ -0,0 +1,53 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {
+  callback: {
+    control: {},
+    description: "A function to be invoked at the end of each render cycle (passed directly to the render method).",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  },
+  className: {
+    control: {
+      type: "text"
+    },
+    defaultValue: "\"renderer\"",
+    description: "The class attribute value used for the root/wrapper <div> element.",
+    table: {
+      defaultValue: {
+        summary: "\"renderer\""
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  },
+  config: {
+    control: {
+      type: "object"
+    },
+    description: "An object containing method/value pairs to be passed to the visualization's .config( ) method.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "object"
+    }
+  }
+};

package/args/text/fontFamily.args.jsx

@@ -0,0 +1,8 @@
+// WARNING: do not edit this file directly, it is generated dynamically from
+// the source JSDOC comments using the npm run docs script.
+
+import React from "react";
+
+
+
+export const argTypes = {};