Skip to content
This repository has been archived by the owner on Jan 25, 2023. It is now read-only.

Commit

Permalink
updates documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@davelandry
davelandry committed Aug 30, 2017
1 parent 091d848 commit e9adfd0
Showing 1 changed file with 61 additions and 30 deletions.
91 changes: 61 additions & 30 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,42 +37,48 @@ This is a global class, and extends all of the methods and functionality of [<co
* [.text([*value*])](#Button.text) ↩︎
* [.value([*value*])](#Button.value) ↩︎

<a name="new_Button_new" href="new_Button_new">#</a> new **Button**()

<a name="new_Button_new" href="#new_Button_new">#</a> new **Button**()

Creates a set of HTML radio input elements.




<a name="Button.render" href="Button.render">#</a> Button.**render**() [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L38)

<a name="Button.render" href="#Button.render">#</a> Button.**render**() [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L40)

Renders the element to the page.


This is a static method of [<code>Button</code>](#Button), and is chainable with other methods of this Class.

<a name="Button.buttonStyle" href="Button.buttonStyle">#</a> Button.**buttonStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L76)

<a name="Button.buttonStyle" href="#Button.buttonStyle">#</a> Button.**buttonStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L78)

Sets the css styles for the <input type="radio"> elements.


This is a static method of [<code>Button</code>](#Button), and is chainable with other methods of this Class.

<a name="Button.container" href="Button.container">#</a> Button.**container**([*selector*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L86)

<a name="Button.container" href="#Button.container">#</a> Button.**container**([*selector*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L88)

If *selector* is specified, sets the SVG container element to the specified d3 selector or DOM element and returns the current class instance. If *selector* is not specified, returns the current SVG container element, which is `undefined` by default.


This is a static method of [<code>Button</code>](#Button), and is chainable with other methods of this Class.

<a name="Button.text" href="Button.text">#</a> Button.**text**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L106)

<a name="Button.text" href="#Button.text">#</a> Button.**text**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L108)

Sets the inner text for each <button> element.


This is a static method of [<code>Button</code>](#Button), and is chainable with other methods of this Class.

<a name="Button.value" href="Button.value">#</a> Button.**value**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L116)

<a name="Button.value" href="#Button.value">#</a> Button.**value**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L118)

Sets the value for each <button> element.

Expand Down Expand Up @@ -102,84 +108,96 @@ This is a global class, and extends all of the methods and functionality of [<co
* [.text([*value*])](#Radio.text) ↩︎
* [.value([*value*])](#Radio.value) ↩︎

<a name="new_Radio_new" href="new_Radio_new">#</a> new **Radio**()

<a name="new_Radio_new" href="#new_Radio_new">#</a> new **Radio**()

Creates a set of HTML radio input elements.




<a name="Radio.data" href="Radio.data">#</a> Radio.**data**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L96)

<a name="Radio.data" href="#Radio.data">#</a> Radio.**data**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Button.js#L98)

Defines the array of values to be created as <button> tags. If no value is passed, the current array is returned.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.render" href="Radio.render">#</a> Radio.**render**() [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L48)

<a name="Radio.render" href="#Radio.render">#</a> Radio.**render**() [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L48)

Renders the element to the page.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.checked" href="Radio.checked">#</a> Radio.**checked**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L128)

<a name="Radio.checked" href="#Radio.checked">#</a> Radio.**checked**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L128)

Defines the checked input.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.container" href="Radio.container">#</a> Radio.**container**([*selector*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L138)

<a name="Radio.container" href="#Radio.container">#</a> Radio.**container**([*selector*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L138)

If *selector* is specified, sets the SVG container element to the specified d3 selector or DOM element and returns the current class instance. If *selector* is not specified, returns the current SVG container element, which is `undefined` by default.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.labelStyle" href="Radio.labelStyle">#</a> Radio.**labelStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L148)

<a name="Radio.labelStyle" href="#Radio.labelStyle">#</a> Radio.**labelStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L148)

Sets the css styles for the <label> element.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.legend" href="Radio.legend">#</a> Radio.**legend**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L158)

<a name="Radio.legend" href="#Radio.legend">#</a> Radio.**legend**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L158)

Creates a <legend> tag for the <select> element.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.legendStyle" href="Radio.legendStyle">#</a> Radio.**legendStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L168)

<a name="Radio.legendStyle" href="#Radio.legendStyle">#</a> Radio.**legendStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L168)

Sets the css styles for the <legend> element.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.options" href="Radio.options">#</a> Radio.**options**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L178)

<a name="Radio.options" href="#Radio.options">#</a> Radio.**options**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L178)

Defines the array of values to be used as <option> tags inside of the <select> element. If no value is passed, the current array is returned.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.radioStyle" href="Radio.radioStyle">#</a> Radio.**radioStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L188)

<a name="Radio.radioStyle" href="#Radio.radioStyle">#</a> Radio.**radioStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L188)

Sets the css styles for the <input type="radio"> elements.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.text" href="Radio.text">#</a> Radio.**text**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L198)

<a name="Radio.text" href="#Radio.text">#</a> Radio.**text**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L198)

Sets the inner text for each <option> element.


This is a static method of [<code>Radio</code>](#Radio), and is chainable with other methods of this Class.

<a name="Radio.value" href="Radio.value">#</a> Radio.**value**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L208)

<a name="Radio.value" href="#Radio.value">#</a> Radio.**value**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Radio.js#L208)

Sets the value for each <option> element.

Expand Down Expand Up @@ -208,77 +226,88 @@ This is a global class, and extends all of the methods and functionality of [<co
* [.text([*value*])](#Select.text) ↩︎
* [.value([*value*])](#Select.value) ↩︎

<a name="new_Select_new" href="new_Select_new">#</a> new **Select**()

<a name="new_Select_new" href="#new_Select_new">#</a> new **Select**()

Creates an HTML select element.




<a name="Select.render" href="Select.render">#</a> Select.**render**() [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L53)

<a name="Select.render" href="#Select.render">#</a> Select.**render**() [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L53)

Renders the element to the page.


This is a static method of [<code>Select</code>](#Select), and is chainable with other methods of this Class.

<a name="Select.container" href="Select.container">#</a> Select.**container**([*selector*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L114)

<a name="Select.container" href="#Select.container">#</a> Select.**container**([*selector*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L114)

If *selector* is specified, sets the SVG container element to the specified d3 selector or DOM element and returns the current class instance. If *selector* is not specified, returns the current SVG container element, which is `undefined` by default.


This is a static method of [<code>Select</code>](#Select), and is chainable with other methods of this Class.

<a name="Select.label" href="Select.label">#</a> Select.**label**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L124)

<a name="Select.label" href="#Select.label">#</a> Select.**label**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L124)

Creates a <label> tag for the <select> element.


This is a static method of [<code>Select</code>](#Select), and is chainable with other methods of this Class.

<a name="Select.labelStyle" href="Select.labelStyle">#</a> Select.**labelStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L134)

<a name="Select.labelStyle" href="#Select.labelStyle">#</a> Select.**labelStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L134)

Sets the css styles for the <label> element.


This is a static method of [<code>Select</code>](#Select), and is chainable with other methods of this Class.

<a name="Select.options" href="Select.options">#</a> Select.**options**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L144)

<a name="Select.options" href="#Select.options">#</a> Select.**options**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L144)

Defines the array of values to be used as <option> tags inside of the <select> element. If no value is passed, the current array is returned.


This is a static method of [<code>Select</code>](#Select), and is chainable with other methods of this Class.

<a name="Select.optionStyle" href="Select.optionStyle">#</a> Select.**optionStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L154)

<a name="Select.optionStyle" href="#Select.optionStyle">#</a> Select.**optionStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L154)

Sets the css styles for the <option> elements.


This is a static method of [<code>Select</code>](#Select), and is chainable with other methods of this Class.

<a name="Select.selected" href="Select.selected">#</a> Select.**selected**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L164)

<a name="Select.selected" href="#Select.selected">#</a> Select.**selected**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L164)

Defines the selected option.


This is a static method of [<code>Select</code>](#Select), and is chainable with other methods of this Class.

<a name="Select.selectStyle" href="Select.selectStyle">#</a> Select.**selectStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L174)

<a name="Select.selectStyle" href="#Select.selectStyle">#</a> Select.**selectStyle**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L174)

Sets the css styles for the <select> element.


This is a static method of [<code>Select</code>](#Select), and is chainable with other methods of this Class.

<a name="Select.text" href="Select.text">#</a> Select.**text**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L184)

<a name="Select.text" href="#Select.text">#</a> Select.**text**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L184)

Sets the inner text for each <option> element.


This is a static method of [<code>Select</code>](#Select), and is chainable with other methods of this Class.

<a name="Select.value" href="Select.value">#</a> Select.**value**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L194)

<a name="Select.value" href="#Select.value">#</a> Select.**value**([*value*]) [<>](https://github.com/d3plus/d3plus-form/blob/master/src/Select.js#L194)

Sets the value for each <option> element.

Expand All @@ -287,4 +316,6 @@ This is a static method of [<code>Select</code>](#Select), and is chainable with

---

###### <sub>Documentation generated on Fri, 26 May 2017 19:54:40 GMT</sub>


###### <sub>Documentation generated on Wed, 30 Aug 2017 21:01:39 GMT</sub>

0 comments on commit e9adfd0

Please sign in to comment.