added docs for graph lib

Cloud-CV · Aug 20, 2016 · a4353d9 · a4353d9
1 parent c670e83
commit a4353d9
Showing 1 changed file with 172 additions and 0 deletions.
diff --git a/src/components/docs/libdocs/Output.js b/src/components/docs/libdocs/Output.js
@@ -57,6 +57,15 @@ function Output() {
         An example can bee seen at this <a href="https://gist.github.com/tocttou/da35d86376f134d232907d626bccee9e">gist</a>.
       </div>
 
+
+
+
+
+
+
+
+
+
       <br />
 
       <div className="ui orange compact message">
@@ -141,6 +150,169 @@ function Output() {
         </li>
       </ul>
 
+
+
+
+
+
+
+
+
+
+
+
+      <br />
+
+      <div className="ui orange compact message">
+        <div className="ui header">
+          sendGraphArray
+        </div>
+      </div>
+      <br />
+
+      <b>cvfy.sendGraphArray()</b> injects an array of plot data into graph in Output component.
+      <br />
+
+      <h4 className="ui header">
+        Arguments:
+      </h4>
+      <ul className="list">
+        <li>
+          Array/Tuple of "arrays of plot dictionaries". Each entry in these arrays of plot dictionaries
+          <br />
+          have two keys, 'x' and 'y' which take different values depending upon the type of graph.
+        </li>
+        <br />
+        <li>
+          Type of Graph
+          <br /><br />
+
+          <ul className="list">
+            <li>
+              <h4 className="ui header">
+                Bar Graph
+              </h4>
+              <ul className="list">
+                <li>
+                  x: INTEGER
+                  <br />
+                  y: INTEGER
+                  <br />
+                  <h4>'x' and 'y' correspond to X-Axis and Y-Axis on the graph.</h4>
+                </li>
+                <br />
+                <li>
+                  <div className="ui success compact message">
+                    An example can be seen at this <a href="https://gist.github.com/tocttou/f82f730be453f872395c5f30df89b763">gist</a>.
+                  </div>
+                </li>
+              </ul>
+            </li>
+          </ul>
+          <br />
+
+          <ul className="list">
+            <li>
+              <h4 className="ui header">
+                Scatter Graph
+              </h4>
+              <ul className="list">
+                <li>
+                  x: INTEGER
+                  <br />
+                  y: INTEGER
+                  <br />
+                  <h4>'x' and 'y' correspond to X-Axis and Y-Axis on the graph.</h4>
+                </li>
+                <br />
+                <li>
+                  <div className="ui success compact message">
+                    An example can be seen at this <a href="https://gist.github.com/tocttou/f82f730be453f872395c5f30df89b763">gist</a>.
+                  </div>
+                </li>
+              </ul>
+            </li>
+          </ul>
+          <br />
+
+          <ul className="list">
+            <li>
+              <h4 className="ui header">
+                Area Graph
+              </h4>
+              <ul className="list">
+                <li>
+                  x: INTEGER
+                  <br />
+                  y: INTEGER
+                  <br />
+                  <h4>'x' and 'y' correspond to X-Axis and Y-Axis on the graph.</h4>
+                </li>
+                <br />
+                <li>
+                  <div className="ui success compact message">
+                    An example can be seen at this <a href="https://gist.github.com/tocttou/f82f730be453f872395c5f30df89b763">gist</a>.
+                  </div>
+                </li>
+              </ul>
+            </li>
+          </ul>
+          <br />
+
+          <ul className="list">
+            <li>
+              <h4 className="ui header">
+                Pie Chart
+              </h4>
+              <ul className="list">
+                <li>
+                  x: STRING
+                  <br />
+                  y: INTEGER
+                  <br />
+                  <h4>'x' correponds to the sectio name, 'y' correponds to share of that section in the pie.</h4>
+                </li>
+                <br />
+                <li>
+                  <div className="ui success compact message">
+                    An example can be seen at this <a href="https://gist.github.com/tocttou/c0885ce4077d972765b00c56f79b5445">gist</a>.
+                  </div>
+                </li>
+              </ul>
+            </li>
+          </ul>
+          <br />
+
+        </li>
+      </ul>
+
+      <h4 className="ui header">
+        Returns:
+      </h4>
+      <ul className="list">
+        <li>
+          None
+        </li>
+      </ul>
+      <br />
+
+      This function works with:
+      <br />
+      <ul className="list">
+        <li>
+          Bar Graph Output Component
+        </li>
+        <li>
+           Scatter Graph Component
+        </li>
+        <li>
+          Area Graph Component
+        </li>
+        <li>
+          Pie Chart Component
+        </li>
+      </ul>
+
     </DocsContent>
   );
 }