Big-Data-HPC-Platform/docs/EN_US/VisualizingECL/VizMods/MultiD.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="VizBundleChart2dMethods">
  <title><emphasis>Multi-Dimensional Methods</emphasis></title>

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

  <para></para>

  <sect1 id="VizMultiDArea">
    <title>Area</title>

    <para><emphasis role="bold">Visualizer.MuiltD.Area(<indexterm>
        <primary>Visualizer.MultiD.Area</primary>
      </indexterm><indexterm>
        <primary>MultiD.Area</primary>
      </indexterm><indexterm>
        <primary>Area</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>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
            result), 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 Column Name &lt;--&gt; field ID</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">Area </emphasis>visualization method
    displays graphically quantitative data. The area between the axis and each
    line is shown and can be emphasized using shading or colors. This is
    commonly used to compare two or more quantities.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;                  
  ds := DATASET([ {'English', 5, 43, 41, 92},
                  {'History', 17, 43, 83, 93},
                  {'Geography', 7, 45, 52, 83},
                  {'Chemistry', 16, 73, 52, 83},
                  {'Spanish', 26, 83, 11, 72},
                  {'Bioligy', 66, 60, 85, 6},
                  {'Physics', 46, 20, 53, 7},
                  {'Math', 98, 30, 23, 13}],
                  {STRING subject, INTEGER4 year1, 
                   INTEGER4 year2, INTEGER4 year3, INTEGER4 year4});
  data_exams := OUTPUT(ds, NAMED('MultiD__test'));
  data_exams;
  
  viz_area := Visualizer.MultiD.Area('area',, 'MultiD__test');
  Viz_area;</programlisting>
  </sect1>

  <sect1 id="VizMultiDBar">
    <title>Bar</title>

    <para><emphasis role="bold">Visualizer.MuiltD.Bar(<indexterm>
        <primary>Visualizer.MultiD.Bar</primary>
      </indexterm><indexterm>
        <primary>MultiD.Bar</primary>
      </indexterm><indexterm>
        <primary>Bar</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>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
            result), 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 Column Name &lt;--&gt; field ID</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">Bar </emphasis>visualization method
    displays a graph consisting of horizontal rectangles (bars) where each
    length is proportional to data value.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;                  
  ds := DATASET([ {'English', 5, 43, 41, 92},
                  {'History', 17, 43, 83, 93},
                  {'Geography', 7, 45, 52, 83},
                  {'Chemistry', 16, 73, 52, 83},
                  {'Spanish', 26, 83, 11, 72},
                  {'Bioligy', 66, 60, 85, 6},
                  {'Physics', 46, 20, 53, 7},
                  {'Math', 98, 30, 23, 13}],
                  {STRING subject, INTEGER4 year1, 
                   INTEGER4 year2, INTEGER4 year3, INTEGER4 year4});
  data_exams := OUTPUT(ds, NAMED('MultiD__test'));
  data_exams;
  
  viz_bar := Visualizer.MultiD.Bar('bar',, 'MultiD__test');
  viz_bar;</programlisting>
  </sect1>

  <sect1 id="VizMultiDColumn">
    <title>Column</title>

    <para><emphasis role="bold">Visualizer.MuiltD.Column(<indexterm>
        <primary>Visualizer.MultiD.Column</primary>
      </indexterm><indexterm>
        <primary>MultiD.Column</primary>
      </indexterm><indexterm>
        <primary>Column</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>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
            result), 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 Column Name &lt;--&gt; field ID</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">Column </emphasis>visualization method
    displays a graph consisting of vertical rectangles (bars) where each
    length is proportional to data value.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;                  
  ds := DATASET([ {'English', 5, 43, 41, 92},
                  {'History', 17, 43, 83, 93},
                  {'Geography', 7, 45, 52, 83},
                  {'Chemistry', 16, 73, 52, 83},
                  {'Spanish', 26, 83, 11, 72},
                  {'Bioligy', 66, 60, 85, 6},
                  {'Physics', 46, 20, 53, 7},
                  {'Math', 98, 30, 23, 13}],
                  {STRING subject, INTEGER4 year1, 
                   INTEGER4 year2, INTEGER4 year3, INTEGER4 year4});
  data_exams := OUTPUT(ds, NAMED('MultiD__test'));
  data_exams;
  
  viz_Column := Visualizer.MultiD.Column('column',, 'MultiD__test');
  viz_Column;</programlisting>
  </sect1>

  <sect1 id="VizMultiDHexBin">
    <title>HexBin</title>

    <para><emphasis role="bold">Visualizer.MuiltD.HexBin(<indexterm>
        <primary>Visualizer.MultiD.HexBin</primary>
      </indexterm><indexterm>
        <primary>MultiD.HexBin</primary>
      </indexterm><indexterm>
        <primary>HexBin</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>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
            result), 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 Column Name &lt;--&gt; field ID</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">HexBin </emphasis>visualization method
    displays a Hexagonal Bin plot which plots two or more continuous variables
    against each other. Hexagonal binning is useful for aggregating data
    values into a coarser display. For example, rather than showing thousands
    of points on a scatter plot, you can combine points into a few hexagons to
    show the distribution.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;                  
  ds := DATASET([ {'English', 5, 43, 41, 92},
                  {'History', 17, 43, 83, 93},
                  {'Geography', 7, 45, 52, 83},
                  {'Chemistry', 16, 73, 52, 83},
                  {'Spanish', 26, 83, 11, 72},
                  {'Bioligy', 66, 60, 85, 6},
                  {'Physics', 46, 20, 53, 7},
                  {'Math', 98, 30, 23, 13}],
                  {STRING subject, INTEGER4 year1, 
                   INTEGER4 year2, INTEGER4 year3, INTEGER4 year4});
  data_exams := OUTPUT(ds, NAMED('MultiD__test'));
  data_exams;
  
  viz_hexBin := Visualizer.MultiD.HexBin('hexBin',, 'MultiD__test');
  viz_hexBin;</programlisting>
  </sect1>

  <sect1 id="VizMultiDLine">
    <title>Line</title>

    <para><emphasis role="bold">Visualizer.MuiltD.Line(<indexterm>
        <primary>Visualizer.MultiD.Line</primary>
      </indexterm><indexterm>
        <primary>MultiD.Line</primary>
      </indexterm><indexterm>
        <primary>Line</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>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
            result), 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 Column Name &lt;--&gt; field ID</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">Line </emphasis>visualization method
    displays a line graph which uses points connected by lines to show how
    values change.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;                  
  ds := DATASET([ {'English', 5, 43, 41, 92},
                  {'History', 17, 43, 83, 93},
                  {'Geography', 7, 45, 52, 83},
                  {'Chemistry', 16, 73, 52, 83},
                  {'Spanish', 26, 83, 11, 72},
                  {'Bioligy', 66, 60, 85, 6},
                  {'Physics', 46, 20, 53, 7},
                  {'Math', 98, 30, 23, 13}],
                  {STRING subject, INTEGER4 year1, 
                   INTEGER4 year2, INTEGER4 year3, INTEGER4 year4});
  data_exams := OUTPUT(ds, NAMED('MultiD__test'));
  data_exams;
  
  viz_line := Visualizer.MultiD.Line('line',, 'MultiD__test');
  viz_line;</programlisting>
  </sect1>

  <sect1 id="VizMultiDScatter">
    <title>Scatter</title>

    <para><emphasis role="bold">Visualizer.MuiltD.Scatter(<indexterm>
        <primary>Visualizer.MultiD.Scatter</primary>
      </indexterm><indexterm>
        <primary>MultiD.Scatter</primary>
      </indexterm><indexterm>
        <primary>Scatter</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>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
            result), 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 Column Name &lt;--&gt; field ID</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">Scatter </emphasis>visualization method
    displays a scatter plot using horizontal and vertical axes to plot data
    points.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;                  
  ds := DATASET([ {'English', 5, 43, 41, 92},
                  {'History', 17, 43, 83, 93},
                  {'Geography', 7, 45, 52, 83},
                  {'Chemistry', 16, 73, 52, 83},
                  {'Spanish', 26, 83, 11, 72},
                  {'Bioligy', 66, 60, 85, 6},
                  {'Physics', 46, 20, 53, 7},
                  {'Math', 98, 30, 23, 13}],
                  {STRING subject, INTEGER4 year1, 
                   INTEGER4 year2, INTEGER4 year3, INTEGER4 year4});
  data_exams := OUTPUT(ds, NAMED('MultiD__test'));
  data_exams;
  viz_scatter := Visualizer.MultiD.Scatter('scatter',, 'MultiD__test');
  viz_scatter;

  </programlisting>
  </sect1>

  <sect1 id="VizMultiDStep">
    <title>Step</title>

    <para><emphasis role="bold">Visualizer.MuiltD.Step(<indexterm>
        <primary>Visualizer.MultiD.Step</primary>
      </indexterm><indexterm>
        <primary>MultiD.Step</primary>
      </indexterm><indexterm>
        <primary>Step</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>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
            result), 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 Column Name &lt;--&gt; field ID</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">Step </emphasis>visualization method
    creates a step graph made of lines in horizontal intervals or
    'steps'.</para>

    <para>Example:</para>

    <programlisting format="linespecific">IMPORT Visualizer;                  
  ds := DATASET([ {'English', 5, 43, 41, 92},
                  {'History', 17, 43, 83, 93},
                  {'Geography', 7, 45, 52, 83},
                  {'Chemistry', 16, 73, 52, 83},
                  {'Spanish', 26, 83, 11, 72},
                  {'Bioligy', 66, 60, 85, 6},
                  {'Physics', 46, 20, 53, 7},
                  {'Math', 98, 30, 23, 13}],
                  {STRING subject, INTEGER4 year1, 
                   INTEGER4 year2, INTEGER4 year3, INTEGER4 year4});
  data_exams := OUTPUT(ds, NAMED('MultiD__test'));
  data_exams;
  viz_step := Visualizer.MultiD.Step('step',, 'MultiD__test');
  viz_step;

  </programlisting>
  </sect1>
</chapter>