Big-Data-HPC-Platform/docs/VisualizingECL/VizMods/TwoD.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="VizTwoD">
  <title><emphasis>Two-Dimensional Methods</emphasis></title>

  <para>This section covers methods that create two-dimensional visualizations
  contained in the TwoD module. These methods provide ways to depict data in a
  two-dimensional space.</para>

  <para></para>

  <sect1 id="VizBubble">
    <title>Bubble</title>

    <para><emphasis role="bold">Visualizer.TwoD.Bubble(<indexterm>
        <primary>Visualizer.TwoD.Bubble</primary>
      </indexterm><indexterm>
        <primary>TwoD.Bubble</primary>
      </indexterm><indexterm>
        <primary>Bubble</primary>
      </indexterm>(</emphasis> <emphasis>id</emphasis> , <emphasis
    role="bold">[</emphasis><emphasis>dataSource</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>outputName</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>filteredBy</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>mappings</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>properties</emphasis><emphasis
    role="bold">]);</emphasis></para>

    <para></para>

    <informaltable colsep="1" frame="all" rowsep="1">
      <tgroup cols="2">
        <colspec colwidth="80.50pt" />

        <colspec />

        <tbody>
          <row>
            <entry><emphasis>id</emphasis></entry>

            <entry>Unique identifier for the visualization</entry>
          </row>

          <row>
            <entry><emphasis>dataSource</emphasis></entry>

            <entry>Location of the result set (WUID, Logical File, Roxie
            query), defaults to the current WU</entry>
          </row>

          <row>
            <entry><emphasis>outputName</emphasis></entry>

            <entry>Result set name (ignored for Logical Files)</entry>
          </row>

          <row>
            <entry><emphasis>mappings</emphasis></entry>

            <entry>Maps human labels &lt;--&gt; field Ids</entry>
          </row>

          <row>
            <entry><emphasis>filteredBy</emphasis></entry>

            <entry>Filter condition (also useful for widget
            interactions)</entry>
          </row>

          <row>
            <entry><emphasis>properties</emphasis></entry>

            <entry>Dermatology properties. See <link
            linkend="VizDermProp">Dermatology Properties</link></entry>
          </row>

          <row>
            <entry>Return:<emphasis></emphasis></entry>

            <entry>A "meta" output describing the visualization.</entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>

    <para>The <emphasis role="bold">Bubble </emphasis>visualization method
    creates a bubble chart from two-dimensional data. A bubble chart is a
    variation of a pie chart where data points are shown as bubbles and the
    size of the bubble is represented by the second dimension of the
    data.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;
ds := DATASET([ {'English', 5},
                {'History', 17},
                {'Geography', 7},
                {'Chemistry', 16},
                {'Irish', 26},
                {'Spanish', 67},
                {'Bioligy', 66},
                {'Physics', 46},
                {'Math', 98}],
                {STRING subject, INTEGER4 year});
data_example := OUTPUT(ds, NAMED('Chart2D__test'));
data_example;
viz_bubble := Visualizer.TwoD.Bubble('bubble',, 'Chart2D__test');
viz_bubble;
</programlisting>
  </sect1>

  <sect1 id="VizPie">
    <title>Pie</title>

    <para><emphasis role="bold">Visualizer.TwoD.Pie(<indexterm>
        <primary>Visualizer.TwoD.Pie</primary>
      </indexterm><indexterm>
        <primary>TwoD.Pie</primary>
      </indexterm><indexterm>
        <primary>Pie</primary>
      </indexterm>(</emphasis> <emphasis>id</emphasis> , <emphasis
    role="bold">[</emphasis><emphasis>dataSource</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>outputName</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>filteredBy</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>mappings</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>properties</emphasis><emphasis
    role="bold">]);</emphasis></para>

    <para></para>

    <informaltable colsep="1" frame="all" rowsep="1">
      <tgroup cols="2">
        <colspec colwidth="80.50pt" />

        <colspec />

        <tbody>
          <row>
            <entry><emphasis>id</emphasis></entry>

            <entry>Unique identifier for the visualization</entry>
          </row>

          <row>
            <entry><emphasis>dataSource</emphasis></entry>

            <entry>Location of the result set (WUID, Logical File, Roxie
            query), defaults to the current WU</entry>
          </row>

          <row>
            <entry><emphasis>outputName</emphasis></entry>

            <entry>Result set name (ignored for Logical Files)</entry>
          </row>

          <row>
            <entry><emphasis>mappings</emphasis></entry>

            <entry>Maps human labels &lt;--&gt; field Ids</entry>
          </row>

          <row>
            <entry><emphasis>filteredBy</emphasis></entry>

            <entry>Filter condition (also useful for widget
            interactions)</entry>
          </row>

          <row>
            <entry><emphasis>properties</emphasis></entry>

            <entry>Dermatology properties. See <link
            linkend="VizDermProp">Dermatology Properties</link></entry>
          </row>

          <row>
            <entry>Return:<emphasis></emphasis></entry>

            <entry>A "meta" output describing the visualization.</entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>

    <para>The <emphasis role="bold">Pie </emphasis>visualization method
    creates a pie chart from two-dimensional data. A pie chart is a graph in
    which a circle is divided into secions representing a portion of the
    whole.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;
ds := DATASET([ {'English', 5},
                {'History', 17},
                {'Geography', 7},
                {'Chemistry', 16},
                {'Irish', 26},
                {'Spanish', 67},
                {'Bioligy', 66},
                {'Physics', 46},
                {'Math', 98}],
                {STRING subject, INTEGER4 year});
data_example := OUTPUT(ds, NAMED('Chart2D__test'));
data_example;
viz_pie := Visualizer.TwoD.Pie('pie',, 'Chart2D__test');
viz_pie;
</programlisting>
  </sect1>

  <sect1 id="VizSummary">
    <title>Summary</title>

    <para><emphasis role="bold">Visualizer.TwoD.Summary(<indexterm>
        <primary>Visualizer.TwoD.Summary</primary>
      </indexterm><indexterm>
        <primary>TwoD.Summary</primary>
      </indexterm><indexterm>
        <primary>Summary</primary>
      </indexterm>(</emphasis> <emphasis>id</emphasis> , <emphasis
    role="bold">[</emphasis><emphasis>dataSource</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>outputName</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>filteredBy</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>mappings</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>properties</emphasis><emphasis
    role="bold">]);</emphasis></para>

    <para></para>

    <informaltable colsep="1" frame="all" rowsep="1">
      <tgroup cols="2">
        <colspec colwidth="80.50pt" />

        <colspec />

        <tbody>
          <row>
            <entry><emphasis>id</emphasis></entry>

            <entry>Unique identifier for the visualization</entry>
          </row>

          <row>
            <entry><emphasis>dataSource</emphasis></entry>

            <entry>Location of the result set (WUID, Logical File, Roxie
            query), defaults to the current WU</entry>
          </row>

          <row>
            <entry><emphasis>outputName</emphasis></entry>

            <entry>Result set name (ignored for Logical Files)</entry>
          </row>

          <row>
            <entry><emphasis>mappings</emphasis></entry>

            <entry>Maps human labels &lt;--&gt; field Ids</entry>
          </row>

          <row>
            <entry><emphasis>filteredBy</emphasis></entry>

            <entry>Filter condition (also useful for widget
            interactions)</entry>
          </row>

          <row>
            <entry><emphasis>properties</emphasis></entry>

            <entry>Dermatology properties. See <link
            linkend="VizDermProp">Dermatology Properties</link></entry>
          </row>

          <row>
            <entry>Return:<emphasis></emphasis></entry>

            <entry>A "meta" output describing the visualization.</entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>

    <para>The <emphasis role="bold">Summary </emphasis>visualization method
    creates a summary chart from two-dimensional data. The summary graph
    defaults to graphic showing scrolling data values.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;
ds := DATASET([ {'English', 5},
                {'History', 17},
                {'Geography', 7},
                {'Chemistry', 16},
                {'Irish', 26},
                {'Spanish', 67},
                {'Bioligy', 66},
                {'Physics', 46},
                {'Math', 98}],
                {STRING subject, INTEGER4 year});
data_example := OUTPUT(ds, NAMED('Chart2D__test'));
data_example;
viz_Summary := Visualizer.TwoD.Summary('Summary',, 'Chart2D__test');
viz_Summary;
</programlisting>
  </sect1>

  <sect1 id="VizWordCloud">
    <title>WordCloud</title>

    <para><emphasis role="bold">Visualizer.TwoD.WordCloud(<indexterm>
        <primary>Visualizer.TwoD.WordCloud</primary>
      </indexterm><indexterm>
        <primary>TwoD.WordCloud</primary>
      </indexterm><indexterm>
        <primary>WordCloud</primary>
      </indexterm>(</emphasis> <emphasis>id</emphasis> , <emphasis
    role="bold">[</emphasis><emphasis>dataSource</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>outputName</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>filteredBy</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>mappings</emphasis><emphasis
    role="bold">], [</emphasis><emphasis>properties</emphasis><emphasis
    role="bold">]);</emphasis></para>

    <para></para>

    <informaltable colsep="1" frame="all" rowsep="1">
      <tgroup cols="2">
        <colspec colwidth="80.50pt" />

        <colspec />

        <tbody>
          <row>
            <entry><emphasis>id</emphasis></entry>

            <entry>Unique identifier for the visualization</entry>
          </row>

          <row>
            <entry><emphasis>dataSource</emphasis></entry>

            <entry>Location of the result set (WUID, Logical File, Roxie
            query), defaults to the current WU</entry>
          </row>

          <row>
            <entry><emphasis>outputName</emphasis></entry>

            <entry>Result set name (ignored for Logical Files)</entry>
          </row>

          <row>
            <entry><emphasis>mappings</emphasis></entry>

            <entry>Maps human labels &lt;--&gt; field Ids</entry>
          </row>

          <row>
            <entry><emphasis>filteredBy</emphasis></entry>

            <entry>Filter condition (also useful for widget
            interactions)</entry>
          </row>

          <row>
            <entry><emphasis>properties</emphasis></entry>

            <entry>Dermatology properties. See <link
            linkend="VizDermProp">Dermatology Properties</link></entry>
          </row>

          <row>
            <entry>Return:<emphasis></emphasis></entry>

            <entry>A "meta" output describing the visualization.</entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>

    <para>The <emphasis role="bold">WordCloud </emphasis>visualization method
    creates a word cloud chart from two-dimensional data. A WordCloud is
    weighted word list in visual design. It is a visual representation for
    text data, typically used to depict the weight or importance of words by
    the font size or color.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;
ds := DATASET([ {'English', 5},
                {'History', 17},
                {'Geography', 7},
                {'Chemistry', 16},
                {'Irish', 26},
                {'Spanish', 67},
                {'Bioligy', 66},
                {'Physics', 46},
                {'Math', 98}],
                {STRING subject, INTEGER4 year});
data_example := OUTPUT(ds, NAMED('Chart2D__test'));
data_example;
viz_WordCloud := Visualizer.TwoD.WordCloud('WordCloud',, 'Chart2D__test');
viz_WordCloud;
</programlisting>
  </sect1>
</chapter>