@d3plus/docs 3.0.0-alpha.3

package/args/core/shapes/Whisker.args.jsx

@@ -0,0 +1,204 @@
+// 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 {Whisker as D3plusWhisker} from "@d3plus/react";
+export const Whisker = ({ config }) => <D3plusWhisker config={config} />;
+
+export const argTypes = assign(
+
+  /**
+   * Filters out unused argTypes from the BaseClass primitive and
+   * overrides any defaults that have been changed in Whisker
+   */
+  Object.keys(baseClassArgTypes)
+    .reduce((obj, k) => (obj[k] = baseClassArgTypes[k], obj), {}),
+
+  /**
+   * Whisker-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"
+      }
+    },
+    endpoint: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "d => d[\"endpoint\"] || Rect",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"endpoint\"] || Rect",
+          summary: "function"
+        }
+      },
+      type: {
+        required: true,
+        summary: "function | string"
+      }
+    },
+    endpointConfig: {
+      control: {
+        type: "object"
+      },
+      defaultValue: "{Circle: {r: d => d[\"r\"] || 5}}",
+      table: {
+        defaultValue: {
+          detail: "{Circle: {r: d => d[\"r\"] || 5}}",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "object"
+      }
+    },
+    hover: {
+      control: {},
+      table: {
+        defaultValue: {
+          summary: "undefined"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function"
+      }
+    },
+    length: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"length\"] || 25",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"length\"] || 25",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    lineConfig: {
+      control: {
+        type: "object"
+      },
+      defaultValue: "{}",
+      table: {
+        defaultValue: {
+          summary: "{}"
+        }
+      },
+      type: {
+        required: false,
+        summary: "object"
+      }
+    },
+    orient: {
+      control: {
+        type: "text"
+      },
+      defaultValue: "d => d[\"orient\"] || top",
+      description: "Accepts \"top\", \"right\", \"bottom\" or \"left\"",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"orient\"] || top",
+          summary: "function"
+        }
+      },
+      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"
+      }
+    },
+    x: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"x\"]",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"x\"]",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    },
+    y: {
+      control: {
+        type: "number"
+      },
+      defaultValue: "d => d[\"y\"]",
+      table: {
+        defaultValue: {
+          detail: "d => d[\"y\"]",
+          summary: "function"
+        }
+      },
+      type: {
+        required: false,
+        summary: "function | number"
+      }
+    }
+  }
+);

package/args/core/utils/BaseClass.args.jsx

@@ -0,0 +1,65 @@
+// 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 {BaseClass as D3plusBaseClass} from "@d3plus/react";
+export const BaseClass = ({ config }) => <D3plusBaseClass config={config} />;
+
+export const argTypes = {
+  config: {
+    control: {
+      type: "object"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "object"
+    }
+  },
+  locale: {
+    control: {
+      type: "object"
+    },
+    defaultValue: "\"en-US\"",
+    table: {
+      defaultValue: {
+        summary: "\"en-US\""
+      }
+    },
+    type: {
+      required: false,
+      summary: "object | string"
+    }
+  },
+  on: {
+    control: {
+      type: "text"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  },
+  translate: {
+    control: {},
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  }
+};

package/args/core/utils/RESET.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/core/utils/accessor.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 = {
+  def: {
+    control: {
+      type: "*"
+    },
+    description: "A default value to be returned if the key is not present.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "*"
+    }
+  },
+  key: {
+    control: {
+      type: "text"
+    },
+    description: "The key to be returned from each Object passed to the function.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "string"
+    }
+  }
+};

package/args/core/utils/configPrep.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 = {
+  config: {
+    control: {
+      type: "object"
+    },
+    defaultValue: "this._shapeConfig",
+    description: "The configuration object to parse.",
+    table: {
+      defaultValue: {
+        summary: "this._shapeConfig"
+      }
+    },
+    type: {
+      required: false,
+      summary: "object"
+    }
+  },
+  nest: {
+    control: {
+      type: "text"
+    },
+    description: "An optional nested key to bubble up to the parent config level.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  },
+  type: {
+    control: {
+      type: "text"
+    },
+    defaultValue: "\"shape\"",
+    description: "The event classifier to user for \"on\" events. For example, the default event type of \"shape\" will apply all events in the \"on\" config object with that key, like \"click.shape\" and \"mouseleave.shape\", in addition to any gloval events like \"click\" and \"mouseleave\".",
+    table: {
+      defaultValue: {
+        summary: "\"shape\""
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  }
+};

package/args/core/utils/constant.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 = {
+  value: {
+    control: {
+      type: "array"
+    },
+    description: "The value to be returned from the function.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array | number | object | string"
+    }
+  }
+};

package/args/core/utils/uuid.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/data/dataConcat.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 = {
+  arrayOfArray: {
+    control: {
+      type: "array"
+    },
+    description: "Array of elements",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  },
+  data: {
+    control: {
+      type: "text"
+    },
+    defaultValue: "\"data\"",
+    description: "The key used for the flat data array if exists inside of the JSON object.",
+    table: {
+      defaultValue: {
+        summary: "\"data\""
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  }
+};

package/args/data/dataFold.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 = {
+  data: {
+    control: {
+      type: "text"
+    },
+    defaultValue: "\"data\"",
+    description: "The key used for the flat data array inside of the JSON object.",
+    table: {
+      defaultValue: {
+        summary: "\"data\""
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  },
+  headers: {
+    control: {
+      type: "text"
+    },
+    defaultValue: "\"headers\"",
+    description: "The key used for the flat headers array inside of the JSON object.",
+    table: {
+      defaultValue: {
+        summary: "\"headers\""
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  },
+  json: {
+    control: {
+      type: "object"
+    },
+    description: "A JSON data Object with `data` and `headers` keys.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "object"
+    }
+  }
+};

package/args/data/dataLoad.args.jsx

@@ -0,0 +1,65 @@
+// 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 that is called when the final data is loaded. It is passed 2 variables, any error present and the data loaded.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  },
+  formatter: {
+    control: {},
+    description: "An optional formatter function that is run on the loaded data.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  },
+  key: {
+    control: {
+      type: "text"
+    },
+    description: "The key in the `this` context to save the resulting data to.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "string"
+    }
+  },
+  path: {
+    control: {
+      type: "array"
+    },
+    description: "The path to the file or url to be loaded. Also support array of paths strings. If an Array of objects is passed, the xhr request logic is skipped.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array | string"
+    }
+  }
+};

package/args/data/isData.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 = {
+  dataItem: {
+    control: {
+      type: "*"
+    },
+    description: "The value to be tested",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "*"
+    }
+  }
+};

package/args/data/merge.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 = {
+  aggs: {
+    control: {
+      type: "object"
+    },
+    description: "An object containing specific aggregation methods (functions) for each key type. By default, numbers are summed and strings are returned as an array of unique values.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "object"
+    }
+  },
+  objects: {
+    control: {
+      type: "array"
+    },
+    description: "The Array of objects to be merged together.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/data/unique.args.jsx

@@ -0,0 +1,37 @@
+// 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 = {
+  accessor: {
+    control: {},
+    description: "An optional accessor function used to extract data points from an Array of Objects.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: false,
+      summary: "function"
+    }
+  },
+  arr: {
+    control: {
+      type: "array"
+    },
+    description: "The Array of objects to be filtered.",
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "array"
+    }
+  }
+};

package/args/dom/assign.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 = {
+  objects: {
+    control: {
+      type: "object"
+    },
+    table: {
+      defaultValue: {
+        summary: "undefined"
+      }
+    },
+    type: {
+      required: true,
+      summary: "object"
+    }
+  }
+};