|
@@ -29,18 +29,16 @@
|
|
|
<sect1 id="VizInstall">
|
|
|
<title>Installation</title>
|
|
|
|
|
|
- <para>The Visualization bundle is an open-source add-on to the HPCC
|
|
|
- platform to allow you to create visualizations from the results from
|
|
|
- queries written in ECL.</para>
|
|
|
-
|
|
|
- <para>To install, use the ecl command line interface.</para>
|
|
|
+ <para>To install the Visualization bundle, use the ecl command line
|
|
|
+ interface.</para>
|
|
|
|
|
|
<para></para>
|
|
|
|
|
|
<para><programlisting>ecl bundle install https://github.com/hpcc-systems/Visualizer.git</programlisting></para>
|
|
|
|
|
|
- <para>To use the "ecl bundle install <git url>" command, git must be
|
|
|
- installed on your machine and accessible to the user (in the path).</para>
|
|
|
+ <para>To use the "ecl bundle install <git url>" command, you must
|
|
|
+ have git installed and configured on your system. Git must be accessible
|
|
|
+ to the user (in the path).</para>
|
|
|
|
|
|
<para></para>
|
|
|
</sect1>
|
|
@@ -51,6 +49,29 @@
|
|
|
<para>Once installed, you merely IMPORT the library, then call any method
|
|
|
that is appropriate for your data shape.</para>
|
|
|
|
|
|
+ <para>Creating a basic visualization typically requires the following
|
|
|
+ steps: </para>
|
|
|
+
|
|
|
+ <para><orderedlist>
|
|
|
+ <listitem>
|
|
|
+ <para>Creation of a suitable dataset.</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Output the dataset with a suitable name, so that visualization
|
|
|
+ can locate the data. </para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Create (and output) a the visualization, referencing the named
|
|
|
+ output from step 2. </para>
|
|
|
+ </listitem>
|
|
|
+ </orderedlist></para>
|
|
|
+
|
|
|
+ <para>To change the appearance of the visualization, dermatology
|
|
|
+ properties can be provided while creating the visualization or can be
|
|
|
+ applied at runtime via the live dermatology property editor.</para>
|
|
|
+
|
|
|
<para>For Example:</para>
|
|
|
|
|
|
<programlisting format="linespecific">IMPORT Visualizer;
|
|
@@ -74,42 +95,42 @@ viz_bubble;
|
|
|
|
|
|
<graphic fileref="../../images/viz10.jpg" />
|
|
|
|
|
|
- <para> </para>
|
|
|
+ <para></para>
|
|
|
|
|
|
<para>See <link linkend="VizMethods">Methods</link> for details about the
|
|
|
categories of visualization methods and all available methods.</para>
|
|
|
-
|
|
|
- <para></para>
|
|
|
-
|
|
|
- <para></para>
|
|
|
</sect1>
|
|
|
|
|
|
<sect1 id="VizViewing">
|
|
|
<title>Viewing the Visualization</title>
|
|
|
|
|
|
<para>After running a query with a visualization included, you can see the
|
|
|
- visualization in ECL Watch.</para>
|
|
|
+ visualization in ECL Watch. Visualizations are appended to the workunit as
|
|
|
+ additional <emphasis>resources</emphasis> and can be viewed from the
|
|
|
+ <emphasis role="bold">Resources</emphasis> tab on the Workunit Details
|
|
|
+ page.</para>
|
|
|
|
|
|
<para>Open the workunit, then select the <emphasis
|
|
|
role="bold">Resources</emphasis> tab.</para>
|
|
|
|
|
|
<para><graphic fileref="../../images/viz07.jpg" /></para>
|
|
|
-
|
|
|
- <para></para>
|
|
|
</sect1>
|
|
|
|
|
|
<sect1 id="VizDermProp">
|
|
|
<title>Dermatology Properties</title>
|
|
|
|
|
|
<para>The dermatology layer provides a means of setting properties for the
|
|
|
- manner in which a visualization appears. </para>
|
|
|
+ manner in which a visualization appears. For example, you can change the
|
|
|
+ palletteID to a new color scheme. After running a query with a
|
|
|
+ visualization included, it can be viewed within ECL Watch.</para>
|
|
|
|
|
|
- <para>For example, you can change the palletteID to a new color scheme.
|
|
|
- After running a query with a visualization included, you can see the
|
|
|
- visualization in ECL Watch.</para>
|
|
|
+ <para>The <emphasis role="bold">Dermatology Editor</emphasis> lets you
|
|
|
+ alter the appearance of the visualization after it has been executed. The
|
|
|
+ same properties can also be specified in the ECL when creating the
|
|
|
+ visualization.</para>
|
|
|
|
|
|
- <para>You can set properties in your ECL code or afterwards in ECL Watch:
|
|
|
- </para>
|
|
|
+ <para>You can set properties in your ECL code or afterwards in ECL
|
|
|
+ Watch:</para>
|
|
|
|
|
|
<orderedlist>
|
|
|
<listitem>
|
|
@@ -119,8 +140,7 @@ viz_bubble;
|
|
|
|
|
|
<listitem>
|
|
|
<para>Press the <emphasis role="bold">Properties</emphasis> button.
|
|
|
- Open the workunit, then select the <emphasis
|
|
|
- role="bold">Resources</emphasis> tab.</para>
|
|
|
+ <emphasis role="bold"></emphasis></para>
|
|
|
|
|
|
<graphic fileref="../../images/viz08.jpg" />
|
|
|
</listitem>
|
|
@@ -138,9 +158,5 @@ viz_bubble;
|
|
|
</orderedlist>
|
|
|
|
|
|
<para></para>
|
|
|
-
|
|
|
- <para></para>
|
|
|
-
|
|
|
- <para></para>
|
|
|
</sect1>
|
|
|
</chapter>
|