@d3plus/docs 3.0.0-alpha.3

package/args/dom/attrize.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 = {
+  attrs: {
+    control: {
+      type: "object"
+    },
+    description: "An object of key/value attr pairs.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "object"
+    }
+  },
+  elem: {
+    control: {
+      type: "d3selection"
+    },
+    description: "The D3 element to apply the styles to.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "d3selection"
+    }
+  }
+};

package/args/dom/date.args.jsx

@@ -0,0 +1,23 @@
+// 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 = {
+  date: {
+    control: {
+      type: "number"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "number | string"
+    }
+  }
+};

package/args/dom/elem.args.jsx

@@ -0,0 +1,135 @@
+// 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 = {
+  params: {
+    control: {
+      type: "object"
+    },
+    description: "Additional parameters.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "object"
+    }
+  },
+  "params.condition": {
+    control: {
+      type: "boolean"
+    },
+    defaultValue: true,
+    description: "Whether or not the element should be rendered (or removed).",
+    table: {
+      defaultValue: {
+        summary: true
+      }
+    },
+    type: {
+      required: false,
+      summary: "boolean"
+    }
+  },
+  "params.duration": {
+    control: {
+      type: "number"
+    },
+    defaultValue: 0,
+    description: "The duration for the d3 transition.",
+    table: {
+      defaultValue: {
+        summary: 0
+      }
+    },
+    type: {
+      required: false,
+      summary: "number"
+    }
+  },
+  "params.enter": {
+    control: {
+      type: "object"
+    },
+    defaultValue: "{}",
+    description: "A collection of key/value pairs that map to attributes to be given on enter.",
+    table: {
+      defaultValue: {
+        summary: "{}"
+      }
+    },
+    type: {
+      required: false,
+      summary: "object"
+    }
+  },
+  "params.exit": {
+    control: {
+      type: "object"
+    },
+    defaultValue: "{}",
+    description: "A collection of key/value pairs that map to attributes to be given on exit.",
+    table: {
+      defaultValue: {
+        summary: "{}"
+      }
+    },
+    type: {
+      required: false,
+      summary: "object"
+    }
+  },
+  "params.parent": {
+    control: {
+      type: "d3selection"
+    },
+    defaultValue: "d3.select(\"body\")",
+    description: "The parent element for this new element to be appended to.",
+    table: {
+      defaultValue: {
+        summary: "d3.select(\"body\")"
+      }
+    },
+    type: {
+      required: false,
+      summary: "d3selection"
+    }
+  },
+  "params.update": {
+    control: {
+      type: "object"
+    },
+    defaultValue: "{}",
+    description: "A collection of key/value pairs that map to attributes to be given on update.",
+    table: {
+      defaultValue: {
+        summary: "{}"
+      }
+    },
+    type: {
+      required: false,
+      summary: "object"
+    }
+  },
+  selector: {
+    control: {
+      type: "text"
+    },
+    description: "A D3 selector, which must include the tagname and a class and/or ID.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "string"
+    }
+  }
+};

package/args/dom/fontExists.args.jsx

@@ -0,0 +1,24 @@
+// 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 = {
+  font: {
+    control: {
+      type: "text"
+    },
+    description: "Can be either a valid CSS font-family string (single or comma-separated names) or an Array of string names.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "string | array"
+    }
+  }
+};

package/args/dom/htmlDecode.args.jsx

@@ -0,0 +1,23 @@
+// 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 = {
+  input: {
+    control: {
+      type: "text"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "string"
+    }
+  }
+};

package/args/dom/isObject.args.jsx

@@ -0,0 +1,23 @@
+// 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 = {
+  item: {
+    control: {
+      type: "*"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "*"
+    }
+  }
+};

package/args/dom/parseSides.args.jsx

@@ -0,0 +1,24 @@
+// 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 = {
+  sides: {
+    control: {
+      type: "text"
+    },
+    description: "The CSS shorthand string to expand.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "string | number"
+    }
+  }
+};

package/args/dom/prefix.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/dom/rtl.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/dom/stylize.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 = {
+  elem: {
+    control: {
+      type: "d3selection"
+    },
+    description: "The D3 element to apply the styles to.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "d3selection"
+    }
+  },
+  styles: {
+    control: {
+      type: "object"
+    },
+    description: "An object of key/value style pairs.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "object"
+    }
+  }
+};

package/args/dom/textWidth.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 = {
+  style: {
+    control: {
+      type: "object"
+    },
+    description: "An object of CSS font styles to apply. Accepts any of the valid [CSS font property](http://www.w3schools.com/cssref/pr_font_font.asp) values.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "object"
+    }
+  },
+  text: {
+    control: {
+      type: "text"
+    },
+    description: "Can be either a single string or an array of strings to analyze.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "string | array"
+    }
+  }
+};

package/args/export/saveElement.args.jsx

@@ -0,0 +1,99 @@
+// 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 = {
+  elem: {
+    control: {
+      type: "htmlelement"
+    },
+    description: "A single element to be saved to one file.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "htmlelement"
+    }
+  },
+  options: {
+    control: {
+      type: "object"
+    },
+    description: "Additional options to specify.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "object"
+    }
+  },
+  "options.callback": {
+    control: {},
+    description: "Function to be invoked after saving is complete.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  },
+  "options.filename": {
+    control: {
+      type: "text"
+    },
+    defaultValue: "\"download\"",
+    description: "Filename for the downloaded file, without the extension.",
+    table: {
+      defaultValue: {
+        summary: "\"download\""
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  },
+  "options.type": {
+    control: {
+      type: "text"
+    },
+    defaultValue: "\"png\"",
+    description: "File type of the saved document. Accepted values are `\"png\"` and `\"jpg\"`.",
+    table: {
+      defaultValue: {
+        summary: "\"png\""
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  },
+  renderOptions: {
+    control: {
+      type: "object"
+    },
+    description: "Custom options to be passed to the html-to-image function.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "object"
+    }
+  }
+};

package/args/format/format.args.jsx

@@ -0,0 +1,24 @@
+// 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 = {
+  specifier: {
+    control: {
+      type: "text"
+    },
+    description: "The string specifier used by the format function.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "string"
+    }
+  }
+};

package/args/format/formatAbbreviate.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 = {
+  locale: {
+    control: {
+      type: "object"
+    },
+    description: "The locale config to be used. If *value* is an object, the function will format the numbers according the object. The object must include `suffixes`, `delimiter` and `currency` properties.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "object | string"
+    }
+  },
+  n: {
+    control: {
+      type: "number"
+    },
+    description: "The number to be formatted.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "number | string"
+    }
+  }
+};

package/args/format/formatDate.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 = {
+  d: {
+    control: {
+      type: "date"
+    },
+    description: "The date string to be formatted.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "date"
+    }
+  },
+  dataArray: {
+    control: {
+      type: "array"
+    },
+    description: "The full array of ordered Date Objects.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  formatter: {
+    control: {},
+    defaultValue: "d3.timeFormat",
+    description: "An optional instance of d3.timeFormat to be used for localization.",
+    table: {
+      defaultValue: {
+        summary: "d3.timeFormat"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  }
+};

package/args/format/formatDefaultLocale.args.jsx

@@ -0,0 +1,24 @@
+// 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 = {
+  definition: {
+    control: {
+      type: "object"
+    },
+    description: "The localization definition.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "object"
+    }
+  }
+};

package/args/locales/dictionaries/formatLocale.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/math/closest.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 = {
+  arr: {
+    control: {
+      type: "array"
+    },
+    description: "The array of values to test against.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  n: {
+    control: {
+      type: "number"
+    },
+    description: "The number value to use when searching the array.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "number"
+    }
+  }
+};