@d3plus/docs 3.0.0-alpha.3

package/args/core/shapes/Bar.args.jsx

@@ -0,0 +1,176 @@
+// 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 {Bar as D3plusBar} from "@d3plus/react";
+export const Bar = ({ config }) => <D3plusBar config={config} />;
+
+export const argTypes = assign(
+
+  /**
+   * Filters out unused argTypes from the Shape primitive and
+   * overrides any defaults that have been changed in Bar
+   */
+  Object.keys(shapeArgTypes)
+    .reduce((obj, k) => (obj[k] = shapeArgTypes[k], obj), {}),
+
+  /**
+   * Bar-specific methods
+   */
+  
+  {
+    height: {
+      control: {
+        type: "number"
+      },
+      defaultValue: 10,
+      table: {
+        defaultValue: {
+          summary: 10
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    labelBounds: {
+      control: {},
+      defaultValue: "(d, i, s) => ({width: s.width, height: s.height, x: this._x1 !== null ? this._getX(d, i) : -s.width / 2, y: this._x1 === null ? this._getY(d, i) : -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: this._x1 !== null ? this._getX(d, i) : -s.width / 2, y: this._x1 === null ? this._getY(d, i) : -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: 10,
+      table: {
+        defaultValue: {
+          summary: 10
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    x: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"x\"]",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"x\"]",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    x0: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"x\"]",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"x\"]",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    x1: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "null",
+      table: {
+        defaultValue: {
+          summary: "null"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number | null"
+      }
+    },
+    y: {
+      control: {
+        type: "number"
+      },
+      defaultValue: 0,
+      table: {
+        defaultValue: {
+          summary: 0
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    y0: {
+      control: {
+        type: "number"
+      },
+      defaultValue: 0,
+      table: {
+        defaultValue: {
+          summary: 0
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    y1: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"y\"]",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"y\"]",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number | null"
+      }
+    }
+  }
+);

package/args/core/shapes/Box.args.jsx

@@ -0,0 +1,248 @@
+// 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 baseClassArgTypes} from "../utils/BaseClass.args.jsx";
+import {assign} from "@d3plus/dom";
+
+import {Box as D3plusBox} from "@d3plus/react";
+export const Box = ({ config }) => <D3plusBox config={config} />;
+
+export const argTypes = assign(
+
+  /**
+   * Filters out unused argTypes from the BaseClass primitive and
+   * overrides any defaults that have been changed in Box
+   */
+  Object.keys(baseClassArgTypes)
+    .reduce((obj, k) => (obj[k] = baseClassArgTypes[k], obj), {}),
+
+  /**
+   * Box-specific methods
+   */
+  
+  {
+    active: {
+      control: {},
+      table: {
+        defaultValue: {
+          summary: "undefined"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    data: {
+      control: {
+        type: "array"
+      },
+      defaultValue: "[]",
+      table: {
+        defaultValue: {
+          summary: "[]"
+        }
+      },
+      type: {
+        required: false,
+        summary: "array"
+      }
+    },
+    hover: {
+      control: {},
+      table: {
+        defaultValue: {
+          summary: "undefined"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    medianConfig: {
+      control: {
+        type: "object"
+      },
+      defaultValue: "{fill: black}",
+      table: {
+        defaultValue: {
+          summary: "{fill: black}"
+        }
+      },
+      type: {
+        required: false,
+        summary: "object"
+      }
+    },
+    orient: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "d => d[\"orient\"] || vertical",
+      description: "Accepts \"vertical\" or \"horizontal\"",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"orient\"] || vertical",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | string"
+      }
+    },
+    outlier: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "d => d[\"outlier\"] || Circle",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"outlier\"] || Circle",
+          summary: "function"
+        }
+      },
+      type: {
+        required: true,
+        summary: "function | string"
+      }
+    },
+    outlierConfig: {
+      control: {
+        type: "object"
+      },
+      defaultValue: "{Circle: {r: d => d[\"r\"] || 5}, Rect: {height: (d, i) => this._orient(d, i) === vertical ? 5 : 20, width: (d, i) => this._orient(d, i) === vertical ? 20 : 5}}",
+      table: {
+        defaultValue: {
+          detail: "{Circle: {r: d => d[\"r\"] || 5}, Rect: {height: (d, i) => this._orient(d, i) === vertical ? 5 : 20, width: (d, i) => this._orient(d, i) === vertical ? 20 : 5}}",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "object"
+      }
+    },
+    rectConfig: {
+      control: {
+        type: "object"
+      },
+      defaultValue: "{fill: white, stroke: black, strokeWidth: 1}",
+      table: {
+        defaultValue: {
+          summary: "{fill: white, stroke: black, strokeWidth: 1}"
+        }
+      },
+      type: {
+        required: false,
+        summary: "object"
+      }
+    },
+    rectWidth: {
+      control: {
+        type: "number"
+      },
+      defaultValue: 50,
+      table: {
+        defaultValue: {
+          summary: 50
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    render: {
+      control: {},
+      table: {
+        defaultValue: {
+          summary: "undefined"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    select: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "d3.select(\"body\").append(\"svg\")",
+      table: {
+        defaultValue: {
+          summary: "d3.select(\"body\").append(\"svg\")"
+        }
+      },
+      type: {
+        required: false,
+        summary: "string | htmlelement"
+      }
+    },
+    whiskerConfig: {
+      control: {
+        type: "object"
+      },
+      defaultValue: "{}",
+      table: {
+        defaultValue: {
+          summary: "{}"
+        }
+      },
+      type: {
+        required: false,
+        summary: "object"
+      }
+    },
+    whiskerMode: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "[\ntukey,\ntukey\n]",
+      table: {
+        defaultValue: {
+          summary: "[\ntukey,\ntukey\n]"
+        }
+      },
+      type: {
+        required: false,
+        summary: "string | number | array.<string> | array.<number>"
+      }
+    },
+    x: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"x\"] || 250",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"x\"] || 250",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    y: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"y\"] || 250",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"y\"] || 250",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    }
+  }
+);

package/args/core/shapes/Circle.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 {Circle as D3plusCircle} from "@d3plus/react";
+export const Circle = ({ config }) => <D3plusCircle config={config} />;
+
+export const argTypes = assign(
+
+  /**
+   * Filters out unused argTypes from the Shape primitive and
+   * overrides any defaults that have been changed in Circle
+   */
+  Object.keys(shapeArgTypes)
+    .reduce((obj, k) => (obj[k] = shapeArgTypes[k], obj), {}),
+
+  /**
+   * Circle-specific methods
+   */
+  
+  {
+    labelBounds: {
+      control: {},
+      defaultValue: "(d, i, s) => ({width: s.r * 1.5, height: s.r * 1.5, x: -s.r * 0.75, y: -s.r * 0.75})",
+      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.r * 1.5, height: s.r * 1.5, x: -s.r * 0.75, y: -s.r * 0.75})",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    labelConfig: {
+      control: {
+        type: "object"
+      },
+      defaultValue: "assign(this._labelConfig, {textAnchor: middle, verticalAlign: middle})",
+      table: {
+        defaultValue: {
+          summary: "assign(this._labelConfig, {textAnchor: middle, verticalAlign: middle})"
+        }
+      },
+      type: {
+        required: false,
+        summary: "object"
+      }
+    },
+    r: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"r\"]",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"r\"]",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    render: {
+      control: {},
+      table: {
+        defaultValue: {
+          summary: "undefined"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    }
+  }
+);

package/args/core/shapes/Image.args.jsx

@@ -0,0 +1,177 @@
+// 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 {Image as D3plusImage} from "@d3plus/react";
+export const Image = ({ config }) => <D3plusImage config={config} />;
+
+export const argTypes = {
+  data: {
+    control: {
+      type: "array"
+    },
+    defaultValue: "[]",
+    table: {
+      defaultValue: {
+        summary: "[]"
+      }
+    },
+    type: {
+      required: false,
+      summary: "array"
+    }
+  },
+  duration: {
+    control: {
+      type: "number"
+    },
+    defaultValue: 600,
+    table: {
+      defaultValue: {
+        summary: 600
+      }
+    },
+    type: {
+      required: false,
+      summary: "number"
+    }
+  },
+  height: {
+    control: {
+      type: "number"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function | number"
+    }
+  },
+  id: {
+    control: {},
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  },
+  opacity: {
+    control: {
+      type: "number"
+    },
+    defaultValue: 1,
+    table: {
+      defaultValue: {
+        summary: 1
+      }
+    },
+    type: {
+      required: false,
+      summary: "number"
+    }
+  },
+  pointerEvents: {
+    control: {
+      type: "text"
+    },
+    defaultValue: "\"auto\"",
+    table: {
+      defaultValue: {
+        summary: "\"auto\""
+      }
+    },
+    type: {
+      required: false,
+      summary: "function | string"
+    }
+  },
+  render: {
+    control: {},
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  },
+  select: {
+    control: {
+      type: "text"
+    },
+    defaultValue: "d3.select(\"body\").append(\"svg\")",
+    table: {
+      defaultValue: {
+        summary: "d3.select(\"body\").append(\"svg\")"
+      }
+    },
+    type: {
+      required: false,
+      summary: "string | htmlelement"
+    }
+  },
+  url: {
+    control: {},
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  },
+  width: {
+    control: {
+      type: "number"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function | number"
+    }
+  },
+  x: {
+    control: {
+      type: "number"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function | number"
+    }
+  },
+  y: {
+    control: {
+      type: "number"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function | number"
+    }
+  }
+};