@d3plus/docs 3.0.0-alpha.3

package/args/core/shapes/Line.args.jsx

@@ -0,0 +1,127 @@
+// 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";
+import {argTypes as shapeArgTypes} from "./Shape.args.jsx";
+import {assign} from "@d3plus/dom";
+
+import {Line as D3plusLine} from "@d3plus/react";
+export const Line = ({ config }) => <D3plusLine config={config} />;
+
+export const argTypes = assign(
+
+  /**
+   * Filters out unused argTypes from the Shape primitive and
+   * overrides any defaults that have been changed in Line
+   */
+  Object.keys(shapeArgTypes)
+    .reduce((obj, k) => (obj[k] = shapeArgTypes[k], obj), {}),
+
+  /**
+   * Line-specific methods
+   */
+  
+  {
+    curve: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "linear",
+      table: {
+        defaultValue: {
+          summary: "linear"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | string"
+      }
+    },
+    defined: {
+      control: {},
+      defaultValue: "(d) => d",
+      table: {
+        defaultValue: {
+          detail: "(d) => d",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    fill: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "none",
+      table: {
+        defaultValue: {
+          summary: "none"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | string"
+      }
+    },
+    hitArea: {
+      control: {},
+      defaultValue: "{d: (d) => this._path(d.values), fill: none, stroke-width: 10, transform: null}",
+      description: "The given function is passed the data point, index, and internally defined properties of the shape and should return an object containing the following values: `width`, `height`, `x`, `y`.",
+      table: {
+        defaultValue: {
+          detail: "{d: (d) => this._path(d.values), fill: none, stroke-width: 10, transform: null}",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    render: {
+      control: {},
+      table: {
+        defaultValue: {
+          summary: "undefined"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    stroke: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "black",
+      table: {
+        defaultValue: {
+          summary: "black"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | string"
+      }
+    },
+    strokeWidth: {
+      control: {
+        type: "number"
+      },
+      defaultValue: 1,
+      table: {
+        defaultValue: {
+          summary: 1
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    }
+  }
+);

package/args/core/shapes/Path.args.jsx

@@ -0,0 +1,84 @@
+// 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";
+import {argTypes as shapeArgTypes} from "./Shape.args.jsx";
+import {assign} from "@d3plus/dom";
+
+import {Path as D3plusPath} from "@d3plus/react";
+export const Path = ({ config }) => <D3plusPath config={config} />;
+
+export const argTypes = assign(
+
+  /**
+   * Filters out unused argTypes from the Shape primitive and
+   * overrides any defaults that have been changed in Path
+   */
+  Object.keys(shapeArgTypes)
+    .reduce((obj, k) => (obj[k] = shapeArgTypes[k], obj), {}),
+
+  /**
+   * Path-specific methods
+   */
+  
+  {
+    d: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "d => d[\"path\"]",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"path\"]",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | string"
+      }
+    },
+    labelBounds: {
+      control: {},
+      defaultValue: "(d, i, aes) => {\n  const r = largestRect(aes.points, {\n      angle: this._labelConfig.rotate ? this._labelConfig.rotate(d, i) : 0\n  });\n  return r ? {\n      angle: r.angle,\n      width: r.width,\n      height: r.height,\n      x: r.cx - r.width / 2,\n      y: r.cy - r.height / 2\n  } : false;\n}",
+      description: "The given function is passed the data point, index, and internally defined properties of the shape and should return an object containing the following values: `width`, `height`, `x`, `y`. If an array is returned from the function, each value will be used in conjunction with each label.",
+      table: {
+        defaultValue: {
+          detail: "(d, i, aes) => {\n  const r = largestRect(aes.points, {\n      angle: this._labelConfig.rotate ? this._labelConfig.rotate(d, i) : 0\n  });\n  return r ? {\n      angle: r.angle,\n      width: r.width,\n      height: r.height,\n      x: r.cx - r.width / 2,\n      y: r.cy - r.height / 2\n  } : false;\n}",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    labelConfig: {
+      control: {
+        type: "object"
+      },
+      defaultValue: "Object.assign(this._labelConfig, {textAnchor: middle, verticalAlign: middle})",
+      table: {
+        defaultValue: {
+          summary: "Object.assign(this._labelConfig, {textAnchor: middle, verticalAlign: middle})"
+        }
+      },
+      type: {
+        required: false,
+        summary: "object"
+      }
+    },
+    render: {
+      control: {},
+      table: {
+        defaultValue: {
+          summary: "undefined"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    }
+  }
+);

package/args/core/shapes/Rect.args.jsx

@@ -0,0 +1,85 @@
+// 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";
+import {argTypes as shapeArgTypes} from "./Shape.args.jsx";
+import {assign} from "@d3plus/dom";
+
+import {Rect as D3plusRect} from "@d3plus/react";
+export const Rect = ({ config }) => <D3plusRect config={config} />;
+
+export const argTypes = assign(
+
+  /**
+   * Filters out unused argTypes from the Shape primitive and
+   * overrides any defaults that have been changed in Rect
+   */
+  Object.keys(shapeArgTypes)
+    .reduce((obj, k) => (obj[k] = shapeArgTypes[k], obj), {}),
+
+  /**
+   * Rect-specific methods
+   */
+  
+  {
+    height: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"height\"]",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"height\"]",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    labelBounds: {
+      control: {},
+      defaultValue: "(d, i, s) => ({width: s.width, height: s.height, x: -s.width / 2, y: -s.height / 2})",
+      description: "The given function is passed the data point, index, and internally defined properties of the shape and should return an object containing the following values: `width`, `height`, `x`, `y`. If an array is returned from the function, each value will be used in conjunction with each label.",
+      table: {
+        defaultValue: {
+          detail: "(d, i, s) => ({width: s.width, height: s.height, x: -s.width / 2, y: -s.height / 2})",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    render: {
+      control: {},
+      table: {
+        defaultValue: {
+          summary: "undefined"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    width: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"width\"]",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"width\"]",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    }
+  }
+);