<appendix id="script-chapter">
<title>Working with KstScript</title>
<sect1>
<title id="kstscript_classes">KstScript Classes:</title>
<informaltable frame="none">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1"/>
<colspec colname="c2"/>
<colspec colname="c3"/>
<tbody>
<row>
<entry>
<link linkend="class_Arrow">Arrow</link>
</entry>
<entry>
<link linkend="class_Axis">Axis</link>
</entry>
<entry>
<link linkend="class_AxisLabel">AxisLabel</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_AxisTickLabel">AxisTickLabel</link>
</entry>
<entry>
<link linkend="class_BinnedMap">BinnedMap</link>
</entry>
<entry>
<link linkend="class_BorderedViewObject">BorderedViewObject</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_Box">Box</link>
</entry>
<entry>
<link linkend="class_Collection">Collection</link>
</entry>
<entry>
<link linkend="class_ColorSequence">ColorSequence</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_CrossPowerSpectrum">CrossPowerSpectrum</link>
</entry>
<entry>
<link linkend="class_Curve">Curve</link>
</entry>
<entry>
<link linkend="class_CurveCollection">CurveCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_DataMatrix">DataMatrix</link>
</entry>
<entry>
<link linkend="class_DataObject">DataObject</link>
</entry>
<entry>
<link linkend="class_DataObjectCollection">DataObjectCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_DataSource">DataSource</link>
</entry>
<entry>
<link linkend="class_DataSourceCollection">DataSourceCollection</link>
</entry>
<entry>
<link linkend="class_DataVector">DataVector</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_Debug">Debug</link>
</entry>
<entry>
<link linkend="class_DebugLog">DebugLog</link>
</entry>
<entry>
<link linkend="class_DebugLogEntry">DebugLogEntry</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_Dir">Dir</link>
</entry>
<entry>
<link linkend="class_Document">Document</link>
</entry>
<entry>
<link linkend="class_Ellipse">Ellipse</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_ELOG">ELOG</link>
</entry>
<entry>
<link linkend="class_Equation">Equation</link>
</entry>
<entry>
<link linkend="class_EquationCollection">EquationCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_Extension">Extension</link>
</entry>
<entry>
<link linkend="class_ExtensionCollection">ExtensionCollection</link>
</entry>
<entry>
<link linkend="class_File">File</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_Group">Group</link>
</entry>
<entry>
<link linkend="class_Histogram">Histogram</link>
</entry>
<entry>
<link linkend="class_HistogramCollection">HistogramCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_Image">Image</link>
</entry>
<entry>
<link linkend="class_Kst">Kst</link>
</entry>
<entry>
<link linkend="class_Label">Label</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_Legend">Legend</link>
</entry>
<entry>
<link linkend="class_Line">Line</link>
</entry>
<entry>
<link linkend="class_Matrix">Matrix</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_MatrixCollection">MatrixCollection</link>
</entry>
<entry>
<link linkend="class_Object">Object</link>
</entry>
<entry>
<link linkend="class_ObjectCollection">ObjectCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_Picture">Picture</link>
</entry>
<entry>
<link linkend="class_Plot">Plot</link>
</entry>
<entry>
<link linkend="class_PlotCollection">PlotCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_PlotLabel">PlotLabel</link>
</entry>
<entry>
<link linkend="class_Plugin">Plugin</link>
</entry>
<entry>
<link linkend="class_PluginCollection">PluginCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_PluginIO">PluginIO</link>
</entry>
<entry>
<link linkend="class_PluginIOCollection">PluginIOCollection</link>
</entry>
<entry>
<link linkend="class_PluginManager">PluginManager</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_PluginModule">PluginModule</link>
</entry>
<entry>
<link linkend="class_PluginModuleCollection">PluginModuleCollection</link>
</entry>
<entry>
<link linkend="class_Point">Point</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_PowerSpectrum">PowerSpectrum</link>
</entry>
<entry>
<link linkend="class_PowerSpectrumCollection">PowerSpectrumCollection</link>
</entry>
<entry>
<link linkend="class_Scalar">Scalar</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_ScalarCollection">ScalarCollection</link>
</entry>
<entry>
<link linkend="class_Size">Size</link>
</entry>
<entry>
<link linkend="class_Spectrogram">Spectrogram</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_SpectrogramCollection">SpectrogramCollection</link>
</entry>
<entry>
<link linkend="class_String">String</link>
</entry>
<entry>
<link linkend="class_StringCollection">StringCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_TimeInterpretation">TimeInterpretation</link>
</entry>
<entry>
<link linkend="class_Vector">Vector</link>
</entry>
<entry>
<link linkend="class_VectorCollection">VectorCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_VectorView">VectorView</link>
</entry>
<entry>
<link linkend="class_ViewObject">ViewObject</link>
</entry>
<entry>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</entry>
</row>
<row>
<entry>
<link linkend="class_Window">Window</link>
</entry>
<entry>
<link linkend="class_WindowCollection">WindowCollection</link>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect1>
<sect1 id="class_Arrow">
<title>Class: Arrow</title>
<para>
A customizable arrow graphic.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Line">Line</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="constructors_Arrow">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Arrow_1">Arrow</link> ( parent )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Arrow_2">Arrow</link> ( window )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Arrow">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Arrow_1">fromArrow</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Arrow_2">toArrow</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Arrow_3">fromArrowScaling</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Arrow_4">toArrowScaling</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Arrow_1">
<title>Arrow ( <link linkend="class_ViewObject">ViewObject</link> parent )</title>
<para><itemizedlist><listitem><para><link linkend="class_ViewObject">ViewObject</link> parent -
The parent to place the new arrow in. May also
be a string containing the name of an existing
ViewObject.
</para></listitem></itemizedlist>
Creates a new arrow and places it in the ViewObject <emphasis>parent</emphasis>.
</para>
</sect3>
<sect3 id="constructor_Arrow_2">
<title>Arrow ( <link linkend="class_Window">Window</link> window )</title>
<para><itemizedlist><listitem><para><link linkend="class_Window">Window</link> window -
The window to place the new arrow in. May also be a
string containing the name of an existing Window.
</para></listitem></itemizedlist>
Creates a new arrow and places it in the Window <emphasis>window</emphasis>.
</para>
</sect3>
<sect3 id="property_Arrow_1">
<title>boolean fromArrow</title>
<para>
True if the arrow has an arrow at the start point.
</para>
</sect3>
<sect3 id="property_Arrow_2">
<title>boolean toArrow</title>
<para>
True if the arrow has an arrow at the end point.
</para>
</sect3>
<sect3 id="property_Arrow_3">
<title>number fromArrowScaling</title>
<para>
Scale size of the arrow at the start point.
</para>
</sect3>
<sect3 id="property_Arrow_4">
<title>number toArrowScaling</title>
<para>
Scale size of the arrow at the end point.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Axis">
<title>Class: Axis</title>
<para>
A class representing a plot axis.
</para>
<sect2 id="methods_Axis">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Axis_1">scaleAuto</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Axis_2">scaleAutoSpikeInsensitive</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Axis_3">scaleExpression</link> ( minExp, maxExp )</para>
</listitem>
<listitem>
<para><link linkend="method_Axis_4">scaleRange</link> ( min, max )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Axis">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Axis_1">log</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_2">suppressed</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_3">oppositeSuppressed</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_4">offsetMode</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_5">reversed</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_6">majorGridLines</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_7">minorGridLines</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_8">transformation</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_9">innerTicks</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_10">outerTicks</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_11">label</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_12">type</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_13">majorGridColor</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_14">minorGridColor</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_15">minorTickCount</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_16">majorTickDensity</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_17">scaleMode</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_18">interpretation</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_19">title</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Axis_20">tickLabel</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_Axis_1">
<title>void scaleAuto ( )</title>
<para>
Sets the scale mode to Auto.
</para>
</sect3>
<sect3 id="method_Axis_2">
<title>void scaleAutoSpikeInsensitive ( )</title>
<para>
Sets the scale mode to Auto Spike Insensitive.
</para>
</sect3>
<sect3 id="method_Axis_3">
<title>void scaleExpression ( string minExp, string maxExp )</title>
<para><itemizedlist><listitem><para>string minExp -
The expression for the minimum of the scale.
</para></listitem><listitem><para>string maxExp -
The expression for the maximum of the scale.
</para></listitem></itemizedlist>
Sets the scale mode to Expression.
</para>
</sect3>
<sect3 id="method_Axis_4">
<title>void scaleRange ( number min, number max )</title>
<para><itemizedlist><listitem><para>number min -
The value for the minimum of the scale.
</para></listitem><listitem><para>number max -
The value for the maximum of the scale.
</para></listitem></itemizedlist>
Sets the scale mode to Fixed and sets the range.
</para>
</sect3>
<sect3 id="property_Axis_1">
<title>boolean log</title>
<para>
True if the axis is in logarithm mode.
</para>
</sect3>
<sect3 id="property_Axis_2">
<title>boolean suppressed</title>
<para>
True if this axis is suppressed.
</para>
</sect3>
<sect3 id="property_Axis_3">
<title>boolean oppositeSuppressed</title>
<para>
True if the opposite axis is suppressed. (Right X or top Y)
</para>
</sect3>
<sect3 id="property_Axis_4">
<title>number offsetMode</title>
<para>
The base + offset mode. Value must be one of:
<itemizedlist>
<listitem><para>0 - Automatic</para></listitem>
<listitem><para>1 - On</para></listitem>
<listitem><para>2 - Off</para></listitem>
</itemizedlist>
For backwards compatibility the value can also be set as a boolean, in which
case true corresponds to On and false corresponds to Automatic.
</para>
</sect3>
<sect3 id="property_Axis_5">
<title>boolean reversed</title>
<para>
True if this axis is reversed.
</para>
</sect3>
<sect3 id="property_Axis_6">
<title>boolean majorGridLines</title>
<para>
True if this axis shows major grid lines.
</para>
</sect3>
<sect3 id="property_Axis_7">
<title>boolean minorGridLines</title>
<para>
True if this axis shows minor grid lines.
</para>
</sect3>
<sect3 id="property_Axis_8">
<title>string transformation</title>
<para>
The transformation expression for this axis.
</para>
</sect3>
<sect3 id="property_Axis_9">
<title>boolean innerTicks</title>
<para>
True if tick marks are displayed inside the plot.
</para>
</sect3>
<sect3 id="property_Axis_10">
<title>boolean outerTicks</title>
<para>
True if tick marks are displayed outside the plot.
</para>
</sect3>
<sect3 id="property_Axis_11">
<title>string label</title>
<para>
The label for this axis.
</para>
</sect3>
<sect3 id="property_Axis_12">
<title>string type [Read-Only]</title>
<para>
The type of axis - X or Y presently.
</para>
</sect3>
<sect3 id="property_Axis_13">
<title>string majorGridColor</title>
<para>
The color for the major grid lines.
</para>
</sect3>
<sect3 id="property_Axis_14">
<title>string minorGridColor</title>
<para>
The color for the minor grid lines.
</para>
</sect3>
<sect3 id="property_Axis_15">
<title>number minorTickCount</title>
<para>
The number of minor ticks between two major ticks. The
special value -1 forces Kst to determine this automatically.
</para>
</sect3>
<sect3 id="property_Axis_16">
<title>number majorTickDensity</title>
<para>
The density of major tick markers along this axis. Value
must be one of:
<itemizedlist>
<listitem><para>0 - Coarse</para></listitem>
<listitem><para>1 - Default</para></listitem>
<listitem><para>2 - Fine</para></listitem>
<listitem><para>3 - Very Fine</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Axis_17">
<title>number scaleMode [Read-Only]</title>
<para>
The type of scaling done on the axis.
Value is one of:
<itemizedlist>
<listitem><para>0 - Auto</para></listitem>
<listitem><para>1 - All Curves (By Midpoint)</para></listitem>
<listitem><para>2 - Fixed</para></listitem>
<listitem><para>3 - Auto Up (Only Scales Upward)</para></listitem>
<listitem><para>4 - Auto (Spike Insensitive)</para></listitem>
<listitem><para>5 - Auto (obsolete, same as 0)</para></listitem>
<listitem><para>6 - Expression Based</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Axis_18">
<title><link linkend="class_TimeInterpretation">TimeInterpretation</link> interpretation [Read-Only]</title>
<para>
The method with which the axis is interpreted and times are
displayed.
</para>
</sect3>
<sect3 id="property_Axis_19">
<title><link linkend="class_AxisLabel">AxisLabel</link> title</title>
<para>
The label for this axis.
</para>
</sect3>
<sect3 id="property_Axis_20">
<title><link linkend="class_AxisTickLabel">AxisTickLabel</link> tickLabel</title>
<para>
The tick label for this axis.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_AxisLabel">
<title>Class: AxisLabel</title>
<para>
A class representing a plot axis label.
</para>
<sect2 id="properties_AxisLabel">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_AxisLabel_1">text</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_AxisLabel_2">font</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_AxisLabel_3">fontSize</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_AxisLabel_4">type</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_AxisLabel_1">
<title>string text</title>
<para>
Contains the text contents of the label. This may include
scalar references of the form <emphasis>[scalar_name]</emphasis> and some basic LaTeX.
</para>
</sect3>
<sect3 id="property_AxisLabel_2">
<title>string font</title>
<para>
Used to set or get the current font used for the label.
</para>
</sect3>
<sect3 id="property_AxisLabel_3">
<title>number fontSize</title>
<para>
Contains the size of the font used to draw the label.
</para>
</sect3>
<sect3 id="property_AxisLabel_4">
<title>string type [Read-Only]</title>
<para>
The type of axis - X or Y presently.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_AxisTickLabel">
<title>Class: AxisTickLabel</title>
<para>
A class representing a plot axis tick label.
</para>
<sect2 id="properties_AxisTickLabel">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_AxisTickLabel_1">font</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_AxisTickLabel_2">fontSize</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_AxisTickLabel_3">rotation</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_AxisTickLabel_4">type</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_AxisTickLabel_1">
<title>string font</title>
<para>
Used to set or get the current font used for the label.
</para>
</sect3>
<sect3 id="property_AxisTickLabel_2">
<title>number fontSize</title>
<para>
Contains the size of the font used to draw the label.
</para>
</sect3>
<sect3 id="property_AxisTickLabel_3">
<title>number rotation</title>
<para>
Contains the rotation angle of the label. Rotation is
clockwise from <emphasis>normal</emphasis> and is stored in degrees.
</para>
</sect3>
<sect3 id="property_AxisTickLabel_4">
<title>string type [Read-Only]</title>
<para>
The type of axis - X or Y presently.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_BinnedMap">
<title>Class: BinnedMap</title>
<para>
This class represents a binned map object in Kst.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<sect2 id="constructors_BinnedMap">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_BinnedMap_1">BinnedMap</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_BinnedMap">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_BinnedMap_1">validate</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_BinnedMap">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_BinnedMap_1">x</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_2">y</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_3">z</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_4">binnedMap</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_5">hitsMap</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_6">xFrom</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_7">xTo</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_8">yFrom</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_9">yTo</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_10">nX</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_11">nY</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_12">autobin</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BinnedMap_13">valid</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_BinnedMap_1">
<title>BinnedMap ( )</title>
<para>
Main constructor for the BinnedMap class.
</para>
</sect3>
<sect3 id="method_BinnedMap_1">
<title>void validate ( )</title>
<para>
Validates the plugin.
</para>
</sect3>
<sect3 id="property_BinnedMap_1">
<title><link linkend="class_Vector">Vector</link> x</title>
<para>
Contains the x vector.
</para>
</sect3>
<sect3 id="property_BinnedMap_2">
<title><link linkend="class_Vector">Vector</link> y</title>
<para>
Contains the y vector.
</para>
</sect3>
<sect3 id="property_BinnedMap_3">
<title><link linkend="class_Vector">Vector</link> z</title>
<para>
Contains the z vector.
</para>
</sect3>
<sect3 id="property_BinnedMap_4">
<title>string binnedMap</title>
<para>
Contains the name of binned map matrix.
</para>
</sect3>
<sect3 id="property_BinnedMap_5">
<title>string hitsMap</title>
<para>
Contains the name of the hits map matrix.
</para>
</sect3>
<sect3 id="property_BinnedMap_6">
<title><link linkend="class_Scalar">Scalar</link> xFrom</title>
<para>
Contains the from value of the x vector.
</para>
</sect3>
<sect3 id="property_BinnedMap_7">
<title><link linkend="class_Scalar">Scalar</link> xTo</title>
<para>
Contains the to value of the x vector.
</para>
</sect3>
<sect3 id="property_BinnedMap_8">
<title><link linkend="class_Scalar">Scalar</link> yFrom</title>
<para>
Contains the from value of the y vector.
</para>
</sect3>
<sect3 id="property_BinnedMap_9">
<title><link linkend="class_Scalar">Scalar</link> yTo</title>
<para>
Contains the to value of the y vector.
</para>
</sect3>
<sect3 id="property_BinnedMap_10">
<title><link linkend="class_Scalar">Scalar</link> nX</title>
<para>
Contains the number of x bins.
</para>
</sect3>
<sect3 id="property_BinnedMap_11">
<title><link linkend="class_Scalar">Scalar</link> nY</title>
<para>
Contains the number of y bins.
</para>
</sect3>
<sect3 id="property_BinnedMap_12">
<title><link linkend="class_Scalar">Scalar</link> autobin</title>
<para>
Contains the autobin setting. Zero for no auto-binning and non-zero for auto-binning.
</para>
</sect3>
<sect3 id="property_BinnedMap_13">
<title>boolean valid [Read-Only]</title>
<para>
Returns true if all the inputs and outputs of the binned map have been set.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_BorderedViewObject">
<title>Class: BorderedViewObject</title>
<para>
Represents some objects in a Kst window. This is an abstract
object and may not be instantiated directly. It has several
properties not in regular ViewObjects including margins,
padding, and a border.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_ViewObject">ViewObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="properties_BorderedViewObject">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_BorderedViewObject_1">padding</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BorderedViewObject_2">margin</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BorderedViewObject_3">borderWidth</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_BorderedViewObject_4">borderColor</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_BorderedViewObject_1">
<title>number padding</title>
<para>
The number of pixels between the border and the contents.
</para>
</sect3>
<sect3 id="property_BorderedViewObject_2">
<title>number margin</title>
<para>
The number of pixels between the edge of the object and the
border.
</para>
</sect3>
<sect3 id="property_BorderedViewObject_3">
<title>number borderWidth</title>
<para>
The width in pixels of the border.
</para>
</sect3>
<sect3 id="property_BorderedViewObject_4">
<title>string borderColor</title>
<para>
The border color for this object.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Box">
<title>Class: Box</title>
<para>
A customizable box graphic.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_ViewObject">ViewObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="constructors_Box">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Box_1">Box</link> ( parent )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Box_2">Box</link> ( window )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Box">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Box_1">xRound</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Box_2">yRound</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Box_3">borderWidth</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Box_4">borderColor</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Box_1">
<title>Box ( <link linkend="class_ViewObject">ViewObject</link> parent )</title>
<para><itemizedlist><listitem><para><link linkend="class_ViewObject">ViewObject</link> parent -
The parent to place the new box in. May also
be a string containing the name of an existing
ViewObject.
</para></listitem></itemizedlist>
Creates a new box and places it in the ViewObject <emphasis>parent</emphasis>.
</para>
</sect3>
<sect3 id="constructor_Box_2">
<title>Box ( <link linkend="class_Window">Window</link> window )</title>
<para><itemizedlist><listitem><para><link linkend="class_Window">Window</link> window -
The window to place the new box in. May also be a
string containing the name of an existing Window.
</para></listitem></itemizedlist>
Creates a new box and places it in the Window <emphasis>window</emphasis>.
</para>
</sect3>
<sect3 id="property_Box_1">
<title>number xRound</title>
<para>
The roundness of the corners in the X dimension. Must be
an integer between 0 and 99.
</para>
</sect3>
<sect3 id="property_Box_2">
<title>number yRound</title>
<para>
The roundness of the corners in the Y dimension. Must be
an integer between 0 and 99.
</para>
</sect3>
<sect3 id="property_Box_3">
<title>number borderWidth</title>
<para>
The width in pixels of the border.
</para>
</sect3>
<sect3 id="property_Box_4">
<title>string borderColor</title>
<para>
The border color for this object.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Collection">
<title>Class: Collection</title>
<para>
This is the generic collection class used by Kst to store lists
of objects. It behaves mostly like an array in JavaScript. At
this time indices are read-only. In addition, if a collection
is read-only, mutator methods will throw exceptions.
Iteration looks something like this:
<programlisting><![CDATA[
for (i = 0; i < collection.length; ++i) {
// do something with collection[i]
}
]]></programlisting>
</para>
<sect2 id="methods_Collection">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Collection_1">append</link> ( newObj )</para>
</listitem>
<listitem>
<para><link linkend="method_Collection_2">prepend</link> ( newObj )</para>
</listitem>
<listitem>
<para><link linkend="method_Collection_3">remove</link> ( n )</para>
</listitem>
<listitem>
<para><link linkend="method_Collection_4">remove</link> ( obj )</para>
</listitem>
<listitem>
<para><link linkend="method_Collection_5">clear</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Collection">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Collection_1">length</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Collection_2">readOnly</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_Collection_1">
<title>void append ( <link linkend="class_Object">Object</link> newObj )</title>
<para><itemizedlist><listitem><para><link linkend="class_Object">Object</link> newObj -
The new object to append to the collection.
</para></listitem></itemizedlist>
Appends a new object to the end of the collection.
</para>
</sect3>
<sect3 id="method_Collection_2">
<title>void prepend ( <link linkend="class_Object">Object</link> newObj )</title>
<para><itemizedlist><listitem><para><link linkend="class_Object">Object</link> newObj -
The new object to prepend to the collection.
</para></listitem></itemizedlist>
Prepends a new object to the start of the collection.
</para>
</sect3>
<sect3 id="method_Collection_3">
<title>void remove ( number n )</title>
<para><itemizedlist><listitem><para>number n -
The index of the entry to remove.
</para></listitem></itemizedlist>
Removes an entry from the collection.
</para>
</sect3>
<sect3 id="method_Collection_4">
<title>void remove ( <link linkend="class_Object">Object</link> obj )</title>
<para><itemizedlist><listitem><para><link linkend="class_Object">Object</link> obj -
The object to remove.
</para></listitem></itemizedlist>
Removes an object from the collection.
</para>
</sect3>
<sect3 id="method_Collection_5">
<title>void clear ( )</title>
<para>
Clears the collection, removing all entries.
</para>
</sect3>
<sect3 id="property_Collection_1">
<title>number length [Read-Only]</title>
<para>
The number of items in the collection. Items are ordered
0..(length - 1) so it is easy to iterate.
</para>
</sect3>
<sect3 id="property_Collection_2">
<title>boolean readOnly [Read-Only]</title>
<para>
True if this is a read-only collection.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_ColorSequence">
<title>Class: ColorSequence</title>
<para>
Provides access to the Kst color sequence used for coloring
curves.
</para>
<sect2 id="methods_ColorSequence">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_ColorSequence_1">next</link> ( [previous] )</para>
</listitem>
<listitem>
<para><link linkend="method_ColorSequence_2">tooClose</link> ( firstColor, secondColor )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_ColorSequence_1">
<title>string next ( [string previous] )</title>
<para><itemizedlist><listitem><para>string previous -
The previous color in the color sequence you are
following. Not necessary.
[OPTIONAL]</para></listitem></itemizedlist>
Returns the next color in the color sequence.
</para>
</sect3>
<sect3 id="method_ColorSequence_2">
<title>boolean tooClose ( string firstColor, string secondColor )</title>
<para><itemizedlist><listitem><para>string firstColor -
The first of two colors to compare.
</para></listitem><listitem><para>string secondColor -
The second of two colors to compare.
</para></listitem></itemizedlist>
Returns true if colors are too close.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_CrossPowerSpectrum">
<title>Class: CrossPowerSpectrum</title>
<para>
This class represents a cross power spectrum object in Kst.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<sect2 id="methods_CrossPowerSpectrum">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_CrossPowerSpectrum_1">validate</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_CrossPowerSpectrum">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_CrossPowerSpectrum_1">v1</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_CrossPowerSpectrum_2">v2</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_CrossPowerSpectrum_3">length</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_CrossPowerSpectrum_4">sample</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_CrossPowerSpectrum_5">real</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_CrossPowerSpectrum_6">imaginary</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_CrossPowerSpectrum_7">frequency</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_CrossPowerSpectrum_8">valid</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_CrossPowerSpectrum_1">
<title>void validate ( )</title>
<para>
Validates the plugin.
</para>
</sect3>
<sect3 id="property_CrossPowerSpectrum_1">
<title><link linkend="class_Vector">Vector</link> v1</title>
<para>
Contains the first vector.
</para>
</sect3>
<sect3 id="property_CrossPowerSpectrum_2">
<title><link linkend="class_Vector">Vector</link> v2</title>
<para>
Contains the second vector.
</para>
</sect3>
<sect3 id="property_CrossPowerSpectrum_3">
<title><link linkend="class_Scalar">Scalar</link> length</title>
<para>
Contains the base 2 logarithm of the length of the cross power spectrum.
Should be an integer >= 2.
</para>
</sect3>
<sect3 id="property_CrossPowerSpectrum_4">
<title><link linkend="class_Scalar">Scalar</link> sample</title>
<para>
Contains the sample rate.
</para>
</sect3>
<sect3 id="property_CrossPowerSpectrum_5">
<title>string real</title>
<para>
Contains the name of the output vector holding the real part of the cross power spectrum.
</para>
</sect3>
<sect3 id="property_CrossPowerSpectrum_6">
<title>string imaginary</title>
<para>
Contains the name of the output vector holding the imaginary part of the cross power spectrum.
</para>
</sect3>
<sect3 id="property_CrossPowerSpectrum_7">
<title>string frequency</title>
<para>
Contains the name of the output vector holding the frequencies of the cross power spectrum.
</para>
</sect3>
<sect3 id="property_CrossPowerSpectrum_8">
<title>boolean valid [Read-Only]</title>
<para>
Returns true if all the inputs and outputs of the cross power spectrum have been set.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Curve">
<title>Class: Curve</title>
<para>
Represents a curve formed from an X and a Y vector.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_CurveCollection">CurveCollection</link>
</para>
<sect2 id="constructors_Curve">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Curve_1">Curve</link> ( x, y [, xError [, yError [, xMinusError [, yMinusError]]]] )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Curve_2">Curve</link> ( hs )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Curve">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Curve_1">point</link> ( index )</para>
</listitem>
<listitem>
<para><link linkend="method_Curve_2">xErrorPoint</link> ( index )</para>
</listitem>
<listitem>
<para><link linkend="method_Curve_3">yErrorPoint</link> ( index )</para>
</listitem>
<listitem>
<para><link linkend="method_Curve_4">xMinusErrorPoint</link> ( index )</para>
</listitem>
<listitem>
<para><link linkend="method_Curve_5">yMinusErrorPoint</link> ( index )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Curve">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Curve_1">color</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_2">xVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_3">yVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_4">xErrorVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_5">yErrorVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_6">xMinusErrorVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_7">xMinusErrorVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_8">yVectorOffset</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_9">samplesPerFrame</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_10">ignoreAutoScale</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_11">hasPoints</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_12">hasLines</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_13">hasBars</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_14">lineWidth</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_15">pointStyle</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_16">lineStyle</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_17">barStyle</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_18">pointDensity</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_19">topLabel</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_20">xLabel</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_21">yLabel</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Curve_22">legendText</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Curve_1">
<title>Curve ( <link linkend="class_Vector">Vector</link> x, <link linkend="class_Vector">Vector</link> y [, <link linkend="class_Vector">Vector</link> xError [, <link linkend="class_Vector">Vector</link> yError [, <link linkend="class_Vector">Vector</link> xMinusError [, <link linkend="class_Vector">Vector</link> yMinusError]]]] )</title>
<para><itemizedlist><listitem><para><link linkend="class_Vector">Vector</link> x -
The X vector for the curve. Can be specified as a string
containing the tag name of an existing vector, or as a
vector object.
</para></listitem><listitem><para><link linkend="class_Vector">Vector</link> y -
The Y vector for the curve. Can be specified as a string
containing the tag name of an existing vector, or as a
vector object.
</para></listitem><listitem><para><link linkend="class_Vector">Vector</link> xError -
The X error bar vector for the curve. Can be
specified as a string containing the tag name of
an existing vector, or as a vector object.
[OPTIONAL]</para></listitem><listitem><para><link linkend="class_Vector">Vector</link> yError -
The Y error bar vector for the curve. Can be
specified as a string containing the tag name of
an existing vector, or as a vector object.
[OPTIONAL]</para></listitem><listitem><para><link linkend="class_Vector">Vector</link> xMinusError -
The X minus error bar vector for the curve.
Can be specified as a string containing the
tag name of an existing vector, or as a
vector object.
[OPTIONAL]</para></listitem><listitem><para><link linkend="class_Vector">Vector</link> yMinusError -
The Y minus error bar vector for the curve.
Can be specified as a string containing the
tag name of an existing vector, or as a
vector object.
[OPTIONAL]</para></listitem></itemizedlist>
Main constructor for Curve class. Constructing a new
curve automatically adds it to the data collection of Kst.
</para>
</sect3>
<sect3 id="constructor_Curve_2">
<title>Curve ( <link linkend="class_Histogram">Histogram</link> hs )</title>
<para><itemizedlist><listitem><para><link linkend="class_Histogram">Histogram</link> hs -
Creates a curve from a histogram.
</para></listitem></itemizedlist>
Constructor for Curve class. Allows a curve to be simply created from a Histogram class.
</para>
</sect3>
<sect3 id="method_Curve_1">
<title><link linkend="class_Point">Point</link> point ( number index )</title>
<para><itemizedlist><listitem><para>number index -
The index of the point to retrieve the coordinates
for. Starts at 0.
</para></listitem></itemizedlist>
Retrieve the coordinates for a given point in the curve.
Returns an invalid point if that index does not exist.
</para>
</sect3>
<sect3 id="method_Curve_2">
<title>number xErrorPoint ( number index )</title>
<para><itemizedlist><listitem><para>number index -
The index of the point to retrieve the coordinates
for. Starts at 0.
</para></listitem></itemizedlist>
Retrieve the value for a given point in the X error
bars. Returns an invalid point if that index does not
exist.
</para>
</sect3>
<sect3 id="method_Curve_3">
<title>number yErrorPoint ( number index )</title>
<para><itemizedlist><listitem><para>number index -
The index of the point to retrieve the coordinates
for. Starts at 0.
</para></listitem></itemizedlist>
Retrieve the value for a given point in the Y error
bars. Returns an invalid point if that index does not
exist.
</para>
</sect3>
<sect3 id="method_Curve_4">
<title>number xMinusErrorPoint ( number index )</title>
<para><itemizedlist><listitem><para>number index -
The index of the point to retrieve the coordinates
for. Starts at 0.
</para></listitem></itemizedlist>
Retrieve the value for a given point in the X minus
error bars. Returns an invalid point if that index does
not exist.
</para>
</sect3>
<sect3 id="method_Curve_5">
<title>number yMinusErrorPoint ( number index )</title>
<para><itemizedlist><listitem><para>number index -
The index of the point to retrieve the coordinates
for. Starts at 0.
</para></listitem></itemizedlist>
Retrieve the value for a given point in the Y minus
error bars. Returns an invalid point if that index does
not exist.
</para>
</sect3>
<sect3 id="property_Curve_1">
<title>string color</title>
<para>
The color of the curve. Stored in the form "#RRGGBB" as
hex values. This property can also be set with English
strings such as "blue".
</para>
</sect3>
<sect3 id="property_Curve_2">
<title><link linkend="class_Vector">Vector</link> xVector</title>
<para>
The X axis vector for the curve.
</para>
</sect3>
<sect3 id="property_Curve_3">
<title><link linkend="class_Vector">Vector</link> yVector</title>
<para>
The Y axis vector for the curve.
</para>
</sect3>
<sect3 id="property_Curve_4">
<title><link linkend="class_Vector">Vector</link> xErrorVector</title>
<para>
The X axis error vector for the curve.
</para>
</sect3>
<sect3 id="property_Curve_5">
<title><link linkend="class_Vector">Vector</link> yErrorVector</title>
<para>
The Y axis error vector for the curve.
</para>
</sect3>
<sect3 id="property_Curve_6">
<title><link linkend="class_Vector">Vector</link> xMinusErrorVector</title>
<para>
The X axis negative error vector for the curve.
</para>
</sect3>
<sect3 id="property_Curve_7">
<title><link linkend="class_Vector">Vector</link> xMinusErrorVector</title>
<para>
The X axis negative error vector for the curve.
</para>
</sect3>
<sect3 id="property_Curve_8">
<title><link linkend="class_Scalar">Scalar</link> yVectorOffset</title>
<para>
The offset to be applied to the y-axis vector.
</para>
</sect3>
<sect3 id="property_Curve_9">
<title>number samplesPerFrame [Read-Only]</title>
<para>
The number of samples per frame for the curve.
</para>
</sect3>
<sect3 id="property_Curve_10">
<title>boolean ignoreAutoScale</title>
<para>
If true, this curve ignores auto scale.
</para>
</sect3>
<sect3 id="property_Curve_11">
<title>boolean hasPoints</title>
<para>
If true, points are plotted for this curve.
</para>
</sect3>
<sect3 id="property_Curve_12">
<title>boolean hasLines</title>
<para>
If true, lines are drawn for this curve.
</para>
</sect3>
<sect3 id="property_Curve_13">
<title>boolean hasBars</title>
<para>
If true, bars are drawn for this curve.
</para>
</sect3>
<sect3 id="property_Curve_14">
<title>number lineWidth</title>
<para>
Sets the line width for this curve when lines are drawn.
</para>
</sect3>
<sect3 id="property_Curve_15">
<title>number pointStyle</title>
<para>
Sets the point style for this curve when points are drawn.
<itemizedlist>
<listitem><para>0 - Cross</para></listitem>
<listitem><para>1 - Hollow box</para></listitem>
<listitem><para>2 - Hollow circle</para></listitem>
<listitem><para>3 - Filled circle</para></listitem>
<listitem><para>4 - Inverted hollow triangle</para></listitem>
<listitem><para>5 - Hollow triangle</para></listitem>
<listitem><para>6 - Filled box</para></listitem>
<listitem><para>7 - Plus</para></listitem>
<listitem><para>8 - Asterisk</para></listitem>
<listitem><para>9 - Inverted filled triangle</para></listitem>
<listitem><para>10 - Filled triangle</para></listitem>
<listitem><para>11 - Hollow diamond</para></listitem>
<listitem><para>12 - Filled diamond</para></listitem>
<listitem><para>13 - Point</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Curve_16">
<title>number lineStyle</title>
<para>
Sets the line style for this curve when lines are drawn.
<itemizedlist>
<listitem><para>0 - Solid</para></listitem>
<listitem><para>1 - Dash</para></listitem>
<listitem><para>2 - Dot</para></listitem>
<listitem><para>3 - Dash Dot</para></listitem>
<listitem><para>4 - Dash Dot Dot</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Curve_17">
<title>number barStyle</title>
<para>
Sets the bar style for this curve when bars are drawn.
<itemizedlist>
<listitem><para>0 - Lines</para></listitem>
<listitem><para>1 - Solid</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Curve_18">
<title>number pointDensity</title>
<para>
Sets the point density for this curve when points are plotted.
<itemizedlist>
<listitem><para>0 - Draw all points</para></listitem>
<listitem><para>1 - High density</para></listitem>
<listitem><para>2 - Medium density</para></listitem>
<listitem><para>3 - Low density</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Curve_19">
<title>string topLabel [Read-Only]</title>
<para>
The top label suggestion for this curve.
</para>
</sect3>
<sect3 id="property_Curve_20">
<title>string xLabel [Read-Only]</title>
<para>
The X-axis label suggestion for this curve.
</para>
</sect3>
<sect3 id="property_Curve_21">
<title>string yLabel [Read-Only]</title>
<para>
The Y-axis label suggestion for this curve.
</para>
</sect3>
<sect3 id="property_Curve_22">
<title>string legendText</title>
<para>
The legend text associated with a curve.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_CurveCollection">
<title>Class: CurveCollection</title>
<para>
An array of curves.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_DataMatrix">
<title>Class: DataMatrix</title>
<para>
A matrix object loaded from a data source.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Matrix">Matrix</link>
</para>
<sect2 id="constructors_DataMatrix">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_DataMatrix_1">DataMatrix</link> ( source, field [, xStart, yStart, xN, yN [, skip [, ave]]] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_DataMatrix">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_DataMatrix_1">reload</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_DataMatrix_2">changeFile</link> ( source )</para>
</listitem>
<listitem>
<para><link linkend="method_DataMatrix_3">change</link> ( xStart, yStart, xCount, yCount [, skip [, ave]] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_DataMatrix">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_DataMatrix_1">valid</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataMatrix_2">skip</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataMatrix_3">boxcar</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataMatrix_4">xReadToEnd</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataMatrix_5">yReadToEnd</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataMatrix_6">xCountFromEnd</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataMatrix_7">yCountFromEnd</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataMatrix_8">skipLength</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataMatrix_9">field</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataMatrix_10">dataSource</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_DataMatrix_1">
<title>DataMatrix ( <link linkend="class_DataSource">DataSource</link> source, string field [, number xStart, number yStart, number xN, number yN [, number skip [, boolean ave]]] )</title>
<para><itemizedlist><listitem><para><link linkend="class_DataSource">DataSource</link> source -
The DataSource to load data from. This may be
a string containing the url of the DataSource to
load. If so, it will attempt to reuse an
existing DataSource instance, or fall back to
a new DataSource object. It may also be
specified as a DataSource object.
</para></listitem><listitem><para>string field -
The field to load from the source.
</para></listitem><listitem><para>number xStart -
The x frame to start reading from.
[OPTIONAL]</para></listitem><listitem><para>number yStart -
The y frame to start reading from.
</para></listitem><listitem><para>number xN -
The number of x frames to read.
</para></listitem><listitem><para>number yN -
The number of y frames to read.
</para></listitem><listitem><para>number skip -
The number of samples to skip by.
[OPTIONAL]</para></listitem><listitem><para>boolean ave -
Set to true to do boxcar filtering.
[OPTIONAL]</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_DataMatrix_1">
<title>void reload ( )</title>
<para></para>
</sect3>
<sect3 id="method_DataMatrix_2">
<title>void changeFile ( <link linkend="class_DataSource">DataSource</link> source )</title>
<para><itemizedlist><listitem><para><link linkend="class_DataSource">DataSource</link> source -
The DataSource to switch to.
</para></listitem></itemizedlist>
Switches this DataMatrix to a different DataSource.
</para>
</sect3>
<sect3 id="method_DataMatrix_3">
<title>void change ( number xStart, number yStart, number xCount, number yCount [, number skip [, boolean ave]] )</title>
<para><itemizedlist><listitem><para>number xStart -
The x starting frame.
</para></listitem><listitem><para>number yStart -
The y starting frame.
</para></listitem><listitem><para>number xCount -
The number of x frames to read.
</para></listitem><listitem><para>number yCount -
The number of y frames to read.
</para></listitem><listitem><para>number skip -
The number of frames to skip by.
[OPTIONAL]</para></listitem><listitem><para>boolean ave -
True to boxcar filter.
[OPTIONAL]</para></listitem></itemizedlist>
Changes the sequence of data that is read in by this
matrix.
</para>
</sect3>
<sect3 id="property_DataMatrix_1">
<title>boolean valid [Read-Only]</title>
<para>
True if the data matrix is valid.
</para>
</sect3>
<sect3 id="property_DataMatrix_2">
<title>boolean skip [Read-Only]</title>
<para>
True if the matrix should skip by <emphasis>skipLength</emphasis> samples
while reading from the data source.
</para>
</sect3>
<sect3 id="property_DataMatrix_3">
<title>boolean boxcar [Read-Only]</title>
<para>
True if the matrix should be boxcar filtered.
</para>
</sect3>
<sect3 id="property_DataMatrix_4">
<title>boolean xReadToEnd [Read-Only]</title>
<para>
If true, the matrix is read to the end of the source in the
x dimension.
</para>
</sect3>
<sect3 id="property_DataMatrix_5">
<title>boolean yReadToEnd [Read-Only]</title>
<para>
If true, the matrix is read to the end of the source in the
y dimension.
</para>
</sect3>
<sect3 id="property_DataMatrix_6">
<title>boolean xCountFromEnd [Read-Only]</title>
<para>
If true, the matrix reads only a maximum number of samples
from the end of the source in the x dimension.
</para>
</sect3>
<sect3 id="property_DataMatrix_7">
<title>boolean yCountFromEnd [Read-Only]</title>
<para>
If true, the matrix reads only a maximum number of samples
from the end of the source in the y dimension.
</para>
</sect3>
<sect3 id="property_DataMatrix_8">
<title>number skipLength [Read-Only]</title>
<para>
The number of samples to skip by.
</para>
</sect3>
<sect3 id="property_DataMatrix_9">
<title>string field [Read-Only]</title>
<para>
The field being read from the data source to create this
matrix.
</para>
</sect3>
<sect3 id="property_DataMatrix_10">
<title><link linkend="class_DataSource">DataSource</link> dataSource [Read-Only]</title>
<para>
The data source object used by this DataMatrix.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_DataObject">
<title>Class: DataObject</title>
<para>
The abstract base class for all Kst data objects.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Object">Object</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_DataObjectCollection">DataObjectCollection</link>
</para>
<sect2 id="methods_DataObject">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_DataObject_1">convertTo</link> ( type )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_DataObject">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_DataObject_1">type</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_DataObject_1">
<title><link linkend="class_DataObject">DataObject</link> convertTo ( string type )</title>
<para><itemizedlist><listitem><para>string type -
The type to attempt to convert this object to.
</para></listitem></itemizedlist>
Attempts to convert this DataObject to a different type.
The object must be derived from this type at some level.
Null is returned if it is not possible to convert to the
requested type.
</para>
</sect3>
<sect3 id="property_DataObject_1">
<title>string type [Read-Only]</title>
<para>
The type of data object this is.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_DataObjectCollection">
<title>Class: DataObjectCollection</title>
<para>
An array of DataObjects.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_DataSource">
<title>Class: DataSource</title>
<para>
An object that represents a data file that is understood by
Kst.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Object">Object</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_DataSourceCollection">DataSourceCollection</link>
</para>
<sect2 id="constructors_DataSource">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_DataSource_1">DataSource</link> ( url [, type] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_DataSource">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_DataSource_1">isValidField</link> ( field )</para>
</listitem>
<listitem>
<para><link linkend="method_DataSource_2">fieldList</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_DataSource_3">reset</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_DataSource_4">matrixList</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_DataSource_5">samplesPerFrame</link> ( field )</para>
</listitem>
<listitem>
<para><link linkend="method_DataSource_6">frameCount</link> ( [field] )</para>
</listitem>
<listitem>
<para><link linkend="method_DataSource_7">setConfiguration</link> ( setting, setting )</para>
</listitem>
<listitem>
<para><link linkend="method_DataSource_8">configuration</link> ( setting )</para>
</listitem>
<listitem>
<para><link linkend="method_DataSource_9">units</link> ( field )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_DataSource">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_DataSource_1">valid</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataSource_2">empty</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataSource_3">completeFieldList</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataSource_4">fileName</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataSource_5">fileType</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataSource_6">source</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataSource_7">metaData</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_DataSource_1">
<title>DataSource ( string url [, string type] )</title>
<para><itemizedlist><listitem><para>string url -
The filename or URL to load.
</para></listitem><listitem><para>string type -
The name of the data source plugin to use.
[OPTIONAL]</para></listitem></itemizedlist>
Creates a new DataSource object. If the url cannot be
opened and read, <emphasis>isValid</emphasis> will be false.
</para>
</sect3>
<sect3 id="method_DataSource_1">
<title>boolean isValidField ( string field )</title>
<para><itemizedlist><listitem><para>string field -
A field name to check for.
</para></listitem></itemizedlist>
Returns if the field is valid or not.
</para>
</sect3>
<sect3 id="method_DataSource_2">
<title>StringArray fieldList ( )</title>
<para>
Generates a list of the fields available from this source.
</para>
</sect3>
<sect3 id="method_DataSource_3">
<title>void reset ( )</title>
<para>
Resets the data source.
</para>
</sect3>
<sect3 id="method_DataSource_4">
<title>StringArray matrixList ( )</title>
<para>
Generates a list of the matrices available from this source.
</para>
</sect3>
<sect3 id="method_DataSource_5">
<title>number samplesPerFrame ( string field )</title>
<para><itemizedlist><listitem><para>string field -
A field name to get the number of
samples per frame for. This is the same for every
field in some sources, but different in others.
</para></listitem></itemizedlist>
The number of samples per frame for this field or source.
</para>
</sect3>
<sect3 id="method_DataSource_6">
<title>number frameCount ( [string field] )</title>
<para><itemizedlist><listitem><para>string field -
An optional field name to get the number of
frames for. This is the same for every
field in some sources, but different in others.
[OPTIONAL]</para></listitem></itemizedlist>
Gets the number of frames for the source, or the given
field if it is specified.
</para>
</sect3>
<sect3 id="method_DataSource_7">
<title>boolean setConfiguration ( string setting, string setting )</title>
<para><itemizedlist><listitem><para>string setting -
Gives the setting name to set the value of.
</para></listitem><listitem><para>string setting -
Gives the value of the setting.
</para></listitem></itemizedlist>
Sets a configuration setting of the data source.
</para>
</sect3>
<sect3 id="method_DataSource_8">
<title>string configuration ( string setting )</title>
<para><itemizedlist><listitem><para>string setting -
Gives the setting name to retrive the value of.
</para></listitem></itemizedlist>
Gets a configuration setting of the data source.
</para>
</sect3>
<sect3 id="method_DataSource_9">
<title>string units ( string field )</title>
<para><itemizedlist><listitem><para>string field -
Gives the field name to retrieve the units of.
</para></listitem></itemizedlist>
Gets the units associated with a field of the data source.
</para>
</sect3>
<sect3 id="property_DataSource_1">
<title>boolean valid [Read-Only]</title>
<para>
True if the data source is valid.
</para>
</sect3>
<sect3 id="property_DataSource_2">
<title>boolean empty [Read-Only]</title>
<para>
True if the data source is empty.
</para>
</sect3>
<sect3 id="property_DataSource_3">
<title>boolean completeFieldList [Read-Only]</title>
<para>
True if the field list is complete.
</para>
</sect3>
<sect3 id="property_DataSource_4">
<title>string fileName [Read-Only]</title>
<para>
Name of the file.
</para>
</sect3>
<sect3 id="property_DataSource_5">
<title>string fileType [Read-Only]</title>
<para>
The type (format) of the file, such as ASCII.
</para>
</sect3>
<sect3 id="property_DataSource_6">
<title>string source [Read-Only]</title>
<para>
The name of the data source.
</para>
</sect3>
<sect3 id="property_DataSource_7">
<title>StringArray metaData [Read-Only]</title>
<para>
Any metadata associated with the data source. This is an
associative array of form metaData["key"] = "value".
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_DataSourceCollection">
<title>Class: DataSourceCollection</title>
<para>
An array of DataSources.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_DataVector">
<title>Class: DataVector</title>
<para>
A vector object loaded from a data source.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Vector">Vector</link>
</para>
<sect2 id="constructors_DataVector">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_DataVector_1">DataVector</link> ( source, field [, start [, n [, skip [, ave]]]] )</para>
</listitem>
<listitem>
<para><link linkend="constructor_DataVector_2">DataVector</link> ( source, field, typeStart, start, typeCount, count [, skip [, ave]] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_DataVector">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_DataVector_1">reload</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_DataVector_2">changeFile</link> ( source )</para>
</listitem>
<listitem>
<para><link linkend="method_DataVector_3">changeFrames</link> ( start, count [, skip [, ave]] )</para>
</listitem>
<listitem>
<para><link linkend="method_DataVector_4">changeFramesByTime</link> ( typeStart, start, typeCount, count [, skip [, ave]] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_DataVector">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_DataVector_1">valid</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_2">skip</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_3">boxcar</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_4">readToEnd</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_5">countFromEnd</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_6">skipLength</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_7">startFrame</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_8">startFrameRequested</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_9">frames</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_10">framesRequested</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_11">samplesPerFrame</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_12">field</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DataVector_13">dataSource</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_DataVector_1">
<title>DataVector ( <link linkend="class_DataSource">DataSource</link> source, string field [, number start [, number n [, number skip [, boolean ave]]]] )</title>
<para><itemizedlist><listitem><para><link linkend="class_DataSource">DataSource</link> source -
The DataSource to load data from. This may be
a string containing the url of the DataSource to
load. If so, it will attempt to reuse an
existing DataSource instance, or fall back to
a new DataSource object. It may also be
specified as a DataSource object.
</para></listitem><listitem><para>string field -
The field to load from the source.
</para></listitem><listitem><para>number start -
The frame to start reading from.
[OPTIONAL]</para></listitem><listitem><para>number n -
The number of frames to read.
[OPTIONAL]</para></listitem><listitem><para>number skip -
The number of samples to skip by.
[OPTIONAL]</para></listitem><listitem><para>boolean ave -
Set to true to do boxcar filtering.
[OPTIONAL]</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="constructor_DataVector_2">
<title>DataVector ( <link linkend="class_DataSource">DataSource</link> source, string field, string typeStart, number start, string typeCount, number count [, number skip [, boolean ave]] )</title>
<para><itemizedlist><listitem><para><link linkend="class_DataSource">DataSource</link> source -
The DataSource to load data from. This may be
a string containing the url of the DataSource to
load. If so, it will attempt to reuse an
existing DataSource instance, or fall back to
a new DataSource object. It may also be
specified as a DataSource object.
</para></listitem><listitem><para>string field -
The field to load from the source.
</para></listitem><listitem><para>string typeStart -
The type of the value specifying the start position.
The permissible values are as follows:
<itemizedlist>
<listitem><para>frames</para></listitem>
<listitem><para>date</para></listitem>
<listitem><para>ms (milliseconds)</para></listitem>
<listitem><para>s (seconds)</para></listitem>
<listitem><para>m (minutes)</para></listitem>
<listitem><para>h (hours)</para></listitem>
<listitem><para>days</para></listitem>
<listitem><para>weeks</para></listitem>
<listitem><para>months</para></listitem>
<listitem><para>years</para></listitem>
</itemizedlist>
The date entry uses the format yyyy:mm:dd:hh:mm.ss (e.g. 2009:2:13:13:10.12).
If any of the leading elements are omitted then the current year, month, day, etc. are assumed.
If the year is less than 0, then it is assumed to be given relative to 1970 (e.g. -10 becomes 1980), else if the year is less than 100 it is assumed to be relative to 2000 (e.g. 9 becomes 2009), else the year is taken as given.
</para></listitem><listitem><para>number start -
The starting frame, date (a string argument), or time offset.
</para></listitem><listitem><para>string typeCount -
The type of the value specifying the count
</para></listitem><listitem><para>number count -
The number of frames or time duration to read.
The permissible values are as follows:
<itemizedlist>
<listitem><para>frames</para></listitem>
<listitem><para>ms (milliseconds)</para></listitem>
<listitem><para>s (seconds)</para></listitem>
<listitem><para>m (minutes)</para></listitem>
<listitem><para>h (hours)</para></listitem>
<listitem><para>days</para></listitem>
<listitem><para>weeks</para></listitem>
<listitem><para>months</para></listitem>
<listitem><para>years</para></listitem>
</itemizedlist>
</para></listitem><listitem><para>number skip -
The number of samples to skip by.
[OPTIONAL]</para></listitem><listitem><para>boolean ave -
Set to true to do boxcar filtering.
[OPTIONAL]</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_DataVector_1">
<title>void reload ( )</title>
<para></para>
</sect3>
<sect3 id="method_DataVector_2">
<title>void changeFile ( <link linkend="class_DataSource">DataSource</link> source )</title>
<para><itemizedlist><listitem><para><link linkend="class_DataSource">DataSource</link> source -
The DataSource to switch to.
</para></listitem></itemizedlist>
Switches this DataVector to a different DataSource.
</para>
</sect3>
<sect3 id="method_DataVector_3">
<title>void changeFrames ( number start, number count [, number skip [, boolean ave]] )</title>
<para><itemizedlist><listitem><para>number start -
The starting frame.
</para></listitem><listitem><para>number count -
The number of frames to read.
</para></listitem><listitem><para>number skip -
The number of frames to skip by.
[OPTIONAL]</para></listitem><listitem><para>boolean ave -
True to boxcar filter.
[OPTIONAL]</para></listitem></itemizedlist>
Changes the sequence of data that is read in by this
vector.
</para>
</sect3>
<sect3 id="method_DataVector_4">
<title>void changeFramesByTime ( string typeStart, number start, string typeCount, number count [, number skip [, boolean ave]] )</title>
<para><itemizedlist><listitem><para>string typeStart -
The type of the value specifying the start position.
The permissible values are as follows:
<itemizedlist>
<listitem><para>frames</para></listitem>
<listitem><para>date</para></listitem>
<listitem><para>ms (milliseconds)</para></listitem>
<listitem><para>s (seconds)</para></listitem>
<listitem><para>m (minutes)</para></listitem>
<listitem><para>h (hours)</para></listitem>
<listitem><para>days</para></listitem>
<listitem><para>weeks</para></listitem>
<listitem><para>months</para></listitem>
<listitem><para>years</para></listitem>
</itemizedlist>
The date entry uses the format yyyy:mm:dd:hh:mm.ss (e.g. 2009:2:13:13:10.12).
If any of the leading elements are omitted then the current year, month, day, etc. are assumed.
If the year is less than 0, then it is assumed to be given relative to 1970 (e.g. -10 becomes 1980), else if the year is less than 100 it is assumed to be relative to 2000 (e.g. 9 becomes 2009), else the year is taken as given.
</para></listitem><listitem><para>number start -
The starting frame, date (a string argument), or time offset.
</para></listitem><listitem><para>string typeCount -
The type of the value specifying the count
</para></listitem><listitem><para>number count -
The number of frames or time duration to read.
The permissible values are as follows:
<itemizedlist>
<listitem><para>frames</para></listitem>
<listitem><para>ms (milliseconds)</para></listitem>
<listitem><para>s (seconds)</para></listitem>
<listitem><para>m (minutes)</para></listitem>
<listitem><para>h (hours)</para></listitem>
<listitem><para>days</para></listitem>
<listitem><para>weeks</para></listitem>
<listitem><para>months</para></listitem>
<listitem><para>years</para></listitem>
</itemizedlist>
</para></listitem><listitem><para>number skip -
The number of frames to skip by.
[OPTIONAL]</para></listitem><listitem><para>boolean ave -
True to boxcar filter.
[OPTIONAL]</para></listitem></itemizedlist>
Changes the sequence of data that is read in by this
vector.
</para>
</sect3>
<sect3 id="property_DataVector_1">
<title>boolean valid [Read-Only]</title>
<para>
True if the data vector is valid.
</para>
</sect3>
<sect3 id="property_DataVector_2">
<title>boolean skip [Read-Only]</title>
<para>
True if the vector should skip by <emphasis>skipLength</emphasis> samples
while reading from the data source.
</para>
</sect3>
<sect3 id="property_DataVector_3">
<title>boolean boxcar [Read-Only]</title>
<para>
True if the vector should be boxcar filtered.
</para>
</sect3>
<sect3 id="property_DataVector_4">
<title>boolean readToEnd [Read-Only]</title>
<para>
If true, the vector is read to the end of the source.
</para>
</sect3>
<sect3 id="property_DataVector_5">
<title>boolean countFromEnd [Read-Only]</title>
<para>
If true, the vector reads only a maximum number of samples
from the end of the source.
</para>
</sect3>
<sect3 id="property_DataVector_6">
<title>number skipLength [Read-Only]</title>
<para>
The number of samples to skip by.
</para>
</sect3>
<sect3 id="property_DataVector_7">
<title>number startFrame [Read-Only]</title>
<para>
The starting frame number.
</para>
</sect3>
<sect3 id="property_DataVector_8">
<title>number startFrameRequested [Read-Only]</title>
<para>
The requested starting frame number. May not be the
actual <emphasis>startFrame</emphasis>.
</para>
</sect3>
<sect3 id="property_DataVector_9">
<title>number frames [Read-Only]</title>
<para>
The number of frames read from the source.
</para>
</sect3>
<sect3 id="property_DataVector_10">
<title>number framesRequested [Read-Only]</title>
<para>
The number of frames requested to be read from the source.
May not be the actual <emphasis>frames</emphasis>.
</para>
</sect3>
<sect3 id="property_DataVector_11">
<title>number samplesPerFrame [Read-Only]</title>
<para>
The number of samples per frame for the associated data
source.
</para>
</sect3>
<sect3 id="property_DataVector_12">
<title>string field [Read-Only]</title>
<para>
The field being read from the data source to create this
vector.
</para>
</sect3>
<sect3 id="property_DataVector_13">
<title><link linkend="class_DataSource">DataSource</link> dataSource [Read-Only]</title>
<para>
The data source object used by this DataVector.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Debug">
<title>Class: Debug</title>
<para>
A reference to the debug and logging subsystem of Kst.
</para>
<sect2 id="methods_Debug">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Debug_1">warning</link> ( message )</para>
</listitem>
<listitem>
<para><link linkend="method_Debug_2">error</link> ( message )</para>
</listitem>
<listitem>
<para><link linkend="method_Debug_3">notice</link> ( message )</para>
</listitem>
<listitem>
<para><link linkend="method_Debug_4">debug</link> ( message )</para>
</listitem>
<listitem>
<para><link linkend="method_Debug_5">clear</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Debug_6">clearNewError</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Debug">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Debug_1">log</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Debug_2">newError</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Debug_3">version</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Debug_4">revision</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_Debug_1">
<title>void warning ( string message )</title>
<para><itemizedlist><listitem><para>string message -
</para></listitem></itemizedlist>
Logs a warning message to the Kst log.
</para>
</sect3>
<sect3 id="method_Debug_2">
<title>void error ( string message )</title>
<para><itemizedlist><listitem><para>string message -
</para></listitem></itemizedlist>
Logs an error message to the Kst log.
</para>
</sect3>
<sect3 id="method_Debug_3">
<title>void notice ( string message )</title>
<para><itemizedlist><listitem><para>string message -
</para></listitem></itemizedlist>
Logs a notice to the Kst log.
</para>
</sect3>
<sect3 id="method_Debug_4">
<title>void debug ( string message )</title>
<para><itemizedlist><listitem><para>string message -
</para></listitem></itemizedlist>
Logs a debug message to the Kst log.
</para>
</sect3>
<sect3 id="method_Debug_5">
<title>void clear ( )</title>
<para>
Clears the Kst log.
</para>
</sect3>
<sect3 id="method_Debug_6">
<title>void clearNewError ( )</title>
<para>
Clears the new error flag.
</para>
</sect3>
<sect3 id="property_Debug_1">
<title><link linkend="class_DebugLog">DebugLog</link> log [Read-Only]</title>
<para>
Provides access to the Kst log contents.
</para>
</sect3>
<sect3 id="property_Debug_2">
<title>boolean newError [Read-Only]</title>
<para>
Return the value of the new error flag.
</para>
</sect3>
<sect3 id="property_Debug_3">
<title>string version [Read-Only]</title>
<para>
Return the version of Kst.
</para>
</sect3>
<sect3 id="property_Debug_4">
<title>string revision [Read-Only]</title>
<para>
Return the revision of Kst.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_DebugLog">
<title>Class: DebugLog</title>
<para>
A reference to the Kst debug log. This object is an array of
the entries in the debug log. It cannot be modified. The
length of the array is the number of entries, and each entry
is a <emphasis>DebugLogEntry</emphasis> object.
</para>
<sect2 id="properties_DebugLog">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_DebugLog_1">length</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLog_2">text</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLog_3">lengthNotices</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLog_4">textNotices</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLog_5">lengthWarnings</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLog_6">textWarnings</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLog_7">lengthErrors</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLog_8">textErrors</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLog_9">lengthDebugs</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLog_10">textDebugs</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_DebugLog_1">
<title>number length [Read-Only]</title>
<para>
The number of entries in the log.
</para>
</sect3>
<sect3 id="property_DebugLog_2">
<title>string text [Read-Only]</title>
<para>
The text contents of the log as a single large string with
carriage returns between entries.
</para>
</sect3>
<sect3 id="property_DebugLog_3">
<title>number lengthNotices [Read-Only]</title>
<para>
The number of notices in the log.
</para>
</sect3>
<sect3 id="property_DebugLog_4">
<title>string textNotices [Read-Only]</title>
<para>
The text contents of the log notices as a single large string with
carriage returns between entries.
</para>
</sect3>
<sect3 id="property_DebugLog_5">
<title>number lengthWarnings [Read-Only]</title>
<para>
The number of warnings in the log.
</para>
</sect3>
<sect3 id="property_DebugLog_6">
<title>string textWarnings [Read-Only]</title>
<para>
The text contents of the log warnings as a single large string with
carriage returns between entries.
</para>
</sect3>
<sect3 id="property_DebugLog_7">
<title>number lengthErrors [Read-Only]</title>
<para>
The number of errors in the log.
</para>
</sect3>
<sect3 id="property_DebugLog_8">
<title>string textErrors [Read-Only]</title>
<para>
The text contents of the log errors as a single large string with
carriage returns between entries.
</para>
</sect3>
<sect3 id="property_DebugLog_9">
<title>number lengthDebugs [Read-Only]</title>
<para>
The number of debug messages in the log.
</para>
</sect3>
<sect3 id="property_DebugLog_10">
<title>string textDebugs [Read-Only]</title>
<para>
The text contents of the log debug messages as a single large string with
carriage returns between entries.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_DebugLogEntry">
<title>Class: DebugLogEntry</title>
<para>
An entry in the Kst debug log.
</para>
<sect2 id="properties_DebugLogEntry">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_DebugLogEntry_1">text</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLogEntry_2">date</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_DebugLogEntry_3">level</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_DebugLogEntry_1">
<title>string text [Read-Only]</title>
<para>
Contains the text of this entry.
</para>
</sect3>
<sect3 id="property_DebugLogEntry_2">
<title>date date [Read-Only]</title>
<para>
Contains the timestamp of this entry.
</para>
</sect3>
<sect3 id="property_DebugLogEntry_3">
<title>string level [Read-Only]</title>
<para>
Contains the log level for this entry.
<itemizedlist>
<listitem><para>N - Notice</para></listitem>
<listitem><para>D - Debug</para></listitem>
<listitem><para>W - Warning</para></listitem>
<listitem><para>E - Error</para></listitem>
<listitem><para>A single space ' ' indicates an unknown entry type.</para></listitem>
</itemizedlist>
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Dir">
<title>Class: Dir</title>
<para>
An object that represents a directory.
</para>
<sect2 id="constructors_Dir">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Dir_1">Dir</link> ( name )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Dir">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Dir_1">fileList</link> ( nameFilters )</para>
</listitem>
<listitem>
<para><link linkend="method_Dir_2">dirList</link> ( nameFilters )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Dir">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Dir_1">path</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Dir_1">
<title>Dir ( string name )</title>
<para><itemizedlist><listitem><para>string name -
Name of the directory.
</para></listitem></itemizedlist>
Constructs a dir in the given directory.
</para>
</sect3>
<sect3 id="method_Dir_1">
<title>StringArray fileList ( string nameFilters )</title>
<para><itemizedlist><listitem><para>string nameFilters -
Specifies the name filters.
</para></listitem></itemizedlist>
Returns a list of files in the directory that match the given name filters.
</para>
</sect3>
<sect3 id="method_Dir_2">
<title>StringArray dirList ( string nameFilters )</title>
<para><itemizedlist><listitem><para>string nameFilters -
Specifies the name filters.
</para></listitem></itemizedlist>
Returns a list of sub-directories in the directory that match the given name filters.
</para>
</sect3>
<sect3 id="property_Dir_1">
<title>string path</title>
<para>
The path of the folder.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Document">
<title>Class: Document</title>
<para>
A pointer to a Kst document. Typically accessed via the global
<emphasis>Kst</emphasis> object via <emphasis>Kst.document</emphasis>.
</para>
<sect2 id="methods_Document">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Document_1">save</link> ( [filename] )</para>
</listitem>
<listitem>
<para><link linkend="method_Document_2">clear</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Document_3">load</link> ( filename )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Document">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Document_1">text</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Document_2">name</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Document_3">modified</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_Document_1">
<title>void save ( [string filename] )</title>
<para><itemizedlist><listitem><para>string filename -
An optional filename to save to. If not
provided, it will be saved to the current
filename or the user will be prompted.
[OPTIONAL]</para></listitem></itemizedlist>
Saves the current Kst session to disk.
</para>
</sect3>
<sect3 id="method_Document_2">
<title>void clear ( )</title>
<para>
Clears the current Kst session and starts a new one.
</para>
</sect3>
<sect3 id="method_Document_3">
<title>boolean load ( string filename )</title>
<para><itemizedlist><listitem><para>string filename -
The filename for a Kst file to load.
</para></listitem></itemizedlist>
Loads a new Kst file into Kst.
</para>
</sect3>
<sect3 id="property_Document_1">
<title>string text [Read-Only]</title>
<para>
The XML text of the current session in Kst-file form.
</para>
</sect3>
<sect3 id="property_Document_2">
<title>string name</title>
<para>
The filename for the current Kst session.
</para>
</sect3>
<sect3 id="property_Document_3">
<title>boolean modified</title>
<para>
True if the document has been modified but not saved.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Ellipse">
<title>Class: Ellipse</title>
<para>
A customizable ellipse graphic.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_ViewObject">ViewObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="constructors_Ellipse">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Ellipse_1">Ellipse</link> ( parent )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Ellipse_2">Ellipse</link> ( window )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Ellipse">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Ellipse_1">borderWidth</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Ellipse_2">borderColor</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Ellipse_1">
<title>Ellipse ( <link linkend="class_ViewObject">ViewObject</link> parent )</title>
<para><itemizedlist><listitem><para><link linkend="class_ViewObject">ViewObject</link> parent -
The parent to place the new ellipse in. May also
be a string containing the name of an existing
ViewObject.
</para></listitem></itemizedlist>
Creates a new ellipse and places it in the ViewObject <emphasis>parent</emphasis>.
</para>
</sect3>
<sect3 id="constructor_Ellipse_2">
<title>Ellipse ( <link linkend="class_Window">Window</link> window )</title>
<para><itemizedlist><listitem><para><link linkend="class_Window">Window</link> window -
The window to place the new ellipse in. May also be a
string containing the name of an existing Window.
</para></listitem></itemizedlist>
Creates a new ellipse and places it in the Window <emphasis>window</emphasis>.
</para>
</sect3>
<sect3 id="property_Ellipse_1">
<title>number borderWidth</title>
<para>
The width of the border of the ellipse.
</para>
</sect3>
<sect3 id="property_Ellipse_2">
<title>string borderColor</title>
<para>
The color of the border of the ellipse.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_ELOG">
<title>Class: ELOG</title>
<para>
An object that represents the interface to an ELOG server.
</para>
<sect2 id="constructors_ELOG">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_ELOG_1">ELOG</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_ELOG">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_ELOG_1">submit</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_ELOG_2">addAttachment</link> ( attachment )</para>
</listitem>
<listitem>
<para><link linkend="method_ELOG_3">clearAttachments</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_ELOG_4">addAttribute</link> ( attribute, attributeValue )</para>
</listitem>
<listitem>
<para><link linkend="method_ELOG_5">removeAttribute</link> ( attribute )</para>
</listitem>
<listitem>
<para><link linkend="method_ELOG_6">clearAttributes</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_ELOG">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_ELOG_1">hostname</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_2">port</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_3">logbook</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_4">username</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_5">password</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_6">writePassword</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_7">text</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_8">encodedHTML</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_9">suppressEmailNotification</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_10">includeCapture</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_11">captureWidth</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_12">captureHeight</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_13">includeConfiguration</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ELOG_14">includeDebugInfo</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_ELOG_1">
<title>ELOG ( )</title>
<para>
Interface to an ELOG server.
</para>
</sect3>
<sect3 id="method_ELOG_1">
<title>void submit ( )</title>
<para>
Submits the ELOG entry.
</para>
</sect3>
<sect3 id="method_ELOG_2">
<title>void addAttachment ( string attachment )</title>
<para><itemizedlist><listitem><para>string attachment -
The name of the attachment.
</para></listitem></itemizedlist>
Adds an attachment to the ELOG entry.
</para>
</sect3>
<sect3 id="method_ELOG_3">
<title>void clearAttachments ( )</title>
<para>
Clears the list of attachments in the ELOG entry.
</para>
</sect3>
<sect3 id="method_ELOG_4">
<title>void addAttribute ( string attribute, string attributeValue )</title>
<para><itemizedlist><listitem><para>string attribute -
The name of the attribute to be added to the ELOG entry.
</para></listitem><listitem><para>string attributeValue -
The value of the attribute to be added to the ELOG entry.
</para></listitem></itemizedlist>
Adds an attribute to the ELOG entry.
</para>
</sect3>
<sect3 id="method_ELOG_5">
<title>void removeAttribute ( string attribute )</title>
<para><itemizedlist><listitem><para>string attribute -
The name of the attribute to be removed from the ELOG entry.
</para></listitem></itemizedlist>
Removes an attribute from the ELOG entry.
</para>
</sect3>
<sect3 id="method_ELOG_6">
<title>void clearAttributes ( )</title>
<para>
Clears the list of attributes in the ELOG entry.
</para>
</sect3>
<sect3 id="property_ELOG_1">
<title>string hostname</title>
<para>
The hostname of the ELOG server.
</para>
</sect3>
<sect3 id="property_ELOG_2">
<title>number port</title>
<para>
The port number of the ELOG server.
</para>
</sect3>
<sect3 id="property_ELOG_3">
<title>string logbook</title>
<para>
A weblog made available by the ELOG server.
</para>
</sect3>
<sect3 id="property_ELOG_4">
<title>string username</title>
<para>
Username.
</para>
</sect3>
<sect3 id="property_ELOG_5">
<title>string password</title>
<para>
Password.
</para>
</sect3>
<sect3 id="property_ELOG_6">
<title>string writePassword</title>
<para>
The write password.
</para>
</sect3>
<sect3 id="property_ELOG_7">
<title>string text</title>
<para>
Text.
</para>
</sect3>
<sect3 id="property_ELOG_8">
<title>boolean encodedHTML</title>
<para>
The message is HTML encoded.
</para>
</sect3>
<sect3 id="property_ELOG_9">
<title>boolean suppressEmailNotification</title>
<para>
If true email notification is suppressed.
</para>
</sect3>
<sect3 id="property_ELOG_10">
<title>boolean includeCapture</title>
<para>
If true an image capture of the Kst session is included in the ELOG entry.
</para>
</sect3>
<sect3 id="property_ELOG_11">
<title>number captureWidth</title>
<para>
The width of the image capture to be included in the ELOG entry.
</para>
</sect3>
<sect3 id="property_ELOG_12">
<title>number captureHeight</title>
<para>
The height of the image capture to be included in the ELOG entry.
</para>
</sect3>
<sect3 id="property_ELOG_13">
<title>boolean includeConfiguration</title>
<para>
If true a capture of the Kst session is included in the ELOG entry.
</para>
</sect3>
<sect3 id="property_ELOG_14">
<title>boolean includeDebugInfo</title>
<para>
If true a capture of the Kst debug information is included in the ELOG entry.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Equation">
<title>Class: Equation</title>
<para>
This object represents an equation object in Kst. It is
interpreted using Kst's internal equation interpreter, and
not the JavaScript interpreter. It should be considerably
faster than the JavaScript interpreter.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_EquationCollection">EquationCollection</link>
</para>
<sect2 id="constructors_Equation">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Equation_1">Equation</link> ( equation, xVector [, interpolate] )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Equation_2">Equation</link> ( equation, x0, x1, n )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Equation">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Equation_1">equation</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Equation_2">valid</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Equation_3">xVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Equation_4">yVector</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Equation_1">
<title>Equation ( string equation, <link linkend="class_Vector">Vector</link> xVector [, boolean interpolate] )</title>
<para><itemizedlist><listitem><para>string equation -
The text of the equation to interpret.
</para></listitem><listitem><para><link linkend="class_Vector">Vector</link> xVector -
The X axis (input) vector to use. The symbolic
variable <emphasis>x</emphasis>; represents the value at the
current index in this vector. A text string
representing the name of an existing vector may
also be used here.
</para></listitem><listitem><para>boolean interpolate -
If true, the equation interpreter will
interoplate to the highest resolution
vector. This is the default behavior.
[OPTIONAL]</para></listitem></itemizedlist>
The default constructor to create an equation object.
</para>
</sect3>
<sect3 id="constructor_Equation_2">
<title>Equation ( string equation, number x0, number x1, number n )</title>
<para><itemizedlist><listitem><para>string equation -
The text of the equation to interpret.
</para></listitem><listitem><para>number x0 -
The first value of the generated X (input) vector.
</para></listitem><listitem><para>number x1 -
The last value of the generate X (input) vector.
</para></listitem><listitem><para>number n -
The number of values in the generated input vector.
</para></listitem></itemizedlist>
A utility constructor which generates an X vector
implicitly.
</para>
</sect3>
<sect3 id="property_Equation_1">
<title>string equation</title>
<para>
The text of the equation. See the Kst documentation for
more information on what the internal equation interpreter
supports.
</para>
</sect3>
<sect3 id="property_Equation_2">
<title>boolean valid [Read-Only]</title>
<para>
True if the equation object is valid. If false, any
values obtained from the yVector should be considered
meaningless.
</para>
</sect3>
<sect3 id="property_Equation_3">
<title><link linkend="class_Vector">Vector</link> xVector [Read-Only]</title>
<para>
The X vector (input vector) for the equation.
</para>
</sect3>
<sect3 id="property_Equation_4">
<title><link linkend="class_Vector">Vector</link> yVector [Read-Only]</title>
<para>
The Y vector (output vector) for the equation.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_EquationCollection">
<title>Class: EquationCollection</title>
<para>
An array of Equations.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_Extension">
<title>Class: Extension</title>
<para>
A class representing an extension in Kst.
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ExtensionCollection">ExtensionCollection</link>
</para>
<sect2 id="methods_Extension">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Extension_1">load</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Extension_2">unload</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Extension">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Extension_1">name</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Extension_2">loaded</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_Extension_1">
<title>boolean load ( )</title>
<para>
Loads this extension into Kst.
</para>
</sect3>
<sect3 id="method_Extension_2">
<title>void unload ( )</title>
<para>
Unloads this extension if it is loaded.
</para>
</sect3>
<sect3 id="property_Extension_1">
<title>string name [Read-Only]</title>
<para>
The name of this extension.
</para>
</sect3>
<sect3 id="property_Extension_2">
<title>boolean loaded [Read-Only]</title>
<para>
True if this extension is presently loaded.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_ExtensionCollection">
<title>Class: ExtensionCollection</title>
<para>
An array of Kst Extension objects.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_File">
<title>Class: File</title>
<para>
An object that represents a file.
</para>
<sect2 id="constructors_File">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_File_1">File</link> ( name )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_File">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_File_1">open</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_File_2">close</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_File_3">readLine</link> ( [length] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_File">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_File_1">name</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_File_2">size</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_File_3">exists</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_File_1">
<title>File ( string name )</title>
<para><itemizedlist><listitem><para>string name -
Name of the file to be opened.
</para></listitem></itemizedlist>
Constructs a file with the given name.
</para>
</sect3>
<sect3 id="method_File_1">
<title>void open ( )</title>
<para>
Opens the file.
</para>
</sect3>
<sect3 id="method_File_2">
<title>void close ( )</title>
<para>
Closes the file.
</para>
</sect3>
<sect3 id="method_File_3">
<title>string readLine ( [number length] )</title>
<para><itemizedlist><listitem><para>number length -
Maximum length of string to return
[OPTIONAL]</para></listitem></itemizedlist>
Reads a line from the file.
</para>
</sect3>
<sect3 id="property_File_1">
<title>string name</title>
<para>
The name of the file.
</para>
</sect3>
<sect3 id="property_File_2">
<title>number size</title>
<para>
The size of the file.
</para>
</sect3>
<sect3 id="property_File_3">
<title>boolean exists</title>
<para>
True if the underlying file exists.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Group">
<title>Class: Group</title>
<para>
A customizable group object.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_ViewObject">ViewObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="constructors_Group">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Group_1">Group</link> ( parent )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Group_2">Group</link> ( window )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Group">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Group_1">append</link> ( newObj )</para>
</listitem>
<listitem>
<para><link linkend="method_Group_2">prepend</link> ( newObj )</para>
</listitem>
<listitem>
<para><link linkend="method_Group_3">ungroup</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Group_1">
<title>Group ( <link linkend="class_ViewObject">ViewObject</link> parent )</title>
<para><itemizedlist><listitem><para><link linkend="class_ViewObject">ViewObject</link> parent -
The parent to place the new arrow in. May also
be a string containing the name of an existing
ViewObject.
</para></listitem></itemizedlist>
Creates a new arrow and places it in the ViewObject <emphasis>parent</emphasis>.
</para>
</sect3>
<sect3 id="constructor_Group_2">
<title>Group ( <link linkend="class_Window">Window</link> window )</title>
<para><itemizedlist><listitem><para><link linkend="class_Window">Window</link> window -
The window to place the new arrow in. May also be a
string containing the name of an existing Window.
</para></listitem></itemizedlist>
Creates a new arrow and places it in the Window <emphasis>window</emphasis>.
</para>
</sect3>
<sect3 id="method_Group_1">
<title>void append ( <link linkend="class_Object">Object</link> newObj )</title>
<para><itemizedlist><listitem><para><link linkend="class_Object">Object</link> newObj -
The new object to append to the collection.
</para></listitem></itemizedlist>
Appends a new object to the end of the collection.
</para>
</sect3>
<sect3 id="method_Group_2">
<title>void prepend ( <link linkend="class_Object">Object</link> newObj )</title>
<para><itemizedlist><listitem><para><link linkend="class_Object">Object</link> newObj -
The new object to prepend to the collection.
</para></listitem></itemizedlist>
Prepends a new object to the start of the collection.
</para>
</sect3>
<sect3 id="method_Group_3">
<title>void ungroup ( )</title>
<para>
Removes all objects from the collection.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Histogram">
<title>Class: Histogram</title>
<para>
A class representing a histogram object in Kst.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_HistogramCollection">HistogramCollection</link>
</para>
<sect2 id="constructors_Histogram">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Histogram_1">Histogram</link> ( vector [, xMin [, xMax [, bins]]] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Histogram">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Histogram_1">setVector</link> ( vector )</para>
</listitem>
<listitem>
<para><link linkend="method_Histogram_2">setRange</link> ( from, to )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Histogram">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Histogram_1">realTimeAutoBin</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Histogram_2">normalization</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Histogram_3">bins</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Histogram_4">xMin</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Histogram_5">xMax</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Histogram_6">xVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Histogram_7">yVector</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Histogram_1">
<title>Histogram ( <link linkend="class_Vector">Vector</link> vector [, number xMin [, number xMax [, number bins]]] )</title>
<para><itemizedlist><listitem><para><link linkend="class_Vector">Vector</link> vector -
The input vector for the histogram. May also be
specified by the tagName for an existing vector.
</para></listitem><listitem><para>number xMin -
The minimum X value. Default is -10.
[OPTIONAL]</para></listitem><listitem><para>number xMax -
The maximum X value. Default is 10.
[OPTIONAL]</para></listitem><listitem><para>number bins -
The number of bins to use. Default is 60.
[OPTIONAL]</para></listitem></itemizedlist>
Creates a new histogram with the defined properties.
</para>
</sect3>
<sect3 id="method_Histogram_1">
<title>void setVector ( <link linkend="class_Vector">Vector</link> vector )</title>
<para><itemizedlist><listitem><para><link linkend="class_Vector">Vector</link> vector -
The vector for the histogram to operate on.
</para></listitem></itemizedlist>
Sets the input vector for the histogram.
</para>
</sect3>
<sect3 id="method_Histogram_2">
<title>void setRange ( number from, number to )</title>
<para><itemizedlist><listitem><para>number from -
The starting X value.
</para></listitem><listitem><para>number to -
The ending X value.
</para></listitem></itemizedlist>
Sets the X range for the histogram.
</para>
</sect3>
<sect3 id="property_Histogram_1">
<title>boolean realTimeAutoBin</title>
<para>
If true, the histogram automatically bins in real-time.
</para>
</sect3>
<sect3 id="property_Histogram_2">
<title>number normalization</title>
<para>
Set the y-axis normalization.
<itemizedlist>
<listitem><para>0 - Number in bin</para></listitem>
<listitem><para>1 - Percent in bin</para></listitem>
<listitem><para>2 - Fraction in bin</para></listitem>
<listitem><para>3 - Peak bin = 1.0</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Histogram_3">
<title>number bins</title>
<para>
The number of bins for the histogram.
</para>
</sect3>
<sect3 id="property_Histogram_4">
<title>number xMin [Read-Only]</title>
<para>
The minimum X value for the histogram.
</para>
</sect3>
<sect3 id="property_Histogram_5">
<title>number xMax [Read-Only]</title>
<para>
The maximum X value for the histogram.
</para>
</sect3>
<sect3 id="property_Histogram_6">
<title><link linkend="class_Vector">Vector</link> xVector [Read-Only]</title>
<para>
The X-axis vector generated by the histogram.
</para>
</sect3>
<sect3 id="property_Histogram_7">
<title><link linkend="class_Vector">Vector</link> yVector [Read-Only]</title>
<para>
The Y-axis vector generated by the histogram.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_HistogramCollection">
<title>Class: HistogramCollection</title>
<para>
An array of Histograms.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_Image">
<title>Class: Image</title>
<para>
An image object created from a matrix.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<sect2 id="constructors_Image">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Image_1">Image</link> ( matrix )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Image">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Image_1">minMaxThreshold</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Image_2">smartThreshold</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Image">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Image_1">matrix</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Image_2">map</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Image_3">palette</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Image_4">lowerThreshold</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Image_5">upperThreshold</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Image_6">autoThreshold</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Image_7">numContours</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Image_8">contourWeight</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Image_9">color</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Image_1">
<title>Image ( <link linkend="class_Matrix">Matrix</link> matrix )</title>
<para><itemizedlist><listitem><para><link linkend="class_Matrix">Matrix</link> matrix -
The matrix for the image. Can be specified as a string
containing the tag name of an existing matrix, or as a
matrix object.
</para></listitem></itemizedlist>
Main constructor for Image class. Constructing a new
image automatically adds it to the data collection of Kst.
</para>
</sect3>
<sect3 id="method_Image_1">
<title>void minMaxThreshold ( )</title>
<para>
Set the thresholding to the current minimum and maximum of the
associated matrix.
</para>
</sect3>
<sect3 id="method_Image_2">
<title>void smartThreshold ( )</title>
<para>
Set the thresholding to automatically calculated smart values based
on the current values of the the associated matrix.
</para>
</sect3>
<sect3 id="property_Image_1">
<title><link linkend="class_Matrix">Matrix</link> matrix</title>
<para>
The matrix associated with the image.
</para>
</sect3>
<sect3 id="property_Image_2">
<title>number map</title>
<para>
The map type of the image.
<itemizedlist>
<listitem><para>0 - Color map</para></listitem>
<listitem><para>1 - Contour map</para></listitem>
<listitem><para>2 - Color map and contour map</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Image_3">
<title>string palette</title>
<para>
The name of the palette associated with the image color map.
</para>
</sect3>
<sect3 id="property_Image_4">
<title>number lowerThreshold</title>
<para>
The lower threshold associated with the map.
</para>
</sect3>
<sect3 id="property_Image_5">
<title>number upperThreshold</title>
<para>
The upper threshold associated with the map.
</para>
</sect3>
<sect3 id="property_Image_6">
<title>boolean autoThreshold</title>
<para>
If true, automatic thresholding is enabled.
</para>
</sect3>
<sect3 id="property_Image_7">
<title>number numContours</title>
<para>
The number of contour levels if the contour map is enabled.
</para>
</sect3>
<sect3 id="property_Image_8">
<title>number contourWeight</title>
<para>
The weight of the lines used to draw the contour map,
if the contour map is enabled. A value of -1 can be
used for a variable contour weight.
</para>
</sect3>
<sect3 id="property_Image_9">
<title>string color</title>
<para>
The color of the contours. Stored in the form "#RRGGBB" as
hex values. This property can also be set with English
strings such as "blue".
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Kst">
<title>Class: Kst</title>
<para>
The global Kst object. Accessed as <emphasis>Kst</emphasis>, this cannot be
reinstantiated.
</para>
<sect2 id="methods_Kst">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Kst_1">loadScript</link> ( fileName )</para>
</listitem>
<listitem>
<para><link linkend="method_Kst_2">resetInterpreter</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Kst_3">waitForUpdate</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Kst_4">purge</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Kst_5">advance</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Kst_6">back</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Kst_7">writeHistory</link> ( filename )</para>
</listitem>
<listitem>
<para><link linkend="method_Kst_8">clearHistory</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Kst_9">addToOutput</link> ( output )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Kst">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Kst_1">dataSources</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_2">scalars</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_3">strings</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_4">vectors</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_5">matrices</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_6">windows</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_7">objects</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_8">colors</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_9">extensions</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_10">document</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_11">pluginManager</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Kst_12">gui</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_Kst_1">
<title>boolean loadScript ( string fileName )</title>
<para><itemizedlist><listitem><para>string fileName -
The file to load the script from.
</para></listitem></itemizedlist>
Loads a script file from disk and runs it.
</para>
</sect3>
<sect3 id="method_Kst_2">
<title>void resetInterpreter ( )</title>
<para>
Resets the KstScript interpreter. All variables will be
lost.
</para>
</sect3>
<sect3 id="method_Kst_3">
<title>void waitForUpdate ( )</title>
<para>
Waits for the next update loop to complete.
</para>
</sect3>
<sect3 id="method_Kst_4">
<title>void purge ( )</title>
<para>
Purges unused objects in Kst. The has the same behavior as
the purge button in the data manager.
</para>
</sect3>
<sect3 id="method_Kst_5">
<title>void advance ( )</title>
<para>
Advance one screen.
</para>
</sect3>
<sect3 id="method_Kst_6">
<title>void back ( )</title>
<para>
Back one screen.
</para>
</sect3>
<sect3 id="method_Kst_7">
<title>void writeHistory ( string filename )</title>
<para><itemizedlist><listitem><para>string filename -
The name of the file to save the command history to.
</para></listitem></itemizedlist>
Saves the command history to a file.
</para>
</sect3>
<sect3 id="method_Kst_8">
<title>void clearHistory ( )</title>
<para>
Clears the command history.
</para>
</sect3>
<sect3 id="method_Kst_9">
<title>void addToOutput ( string output )</title>
<para><itemizedlist><listitem><para>string output -
String to add to the output.
</para></listitem></itemizedlist>
Adds to the output generated from a function call.
</para>
</sect3>
<sect3 id="property_Kst_1">
<title><link linkend="class_DataSourceCollection">DataSourceCollection</link> dataSources [Read-Only]</title>
<para>
The list of all loaded data sources.
</para>
</sect3>
<sect3 id="property_Kst_2">
<title><link linkend="class_ScalarCollection">ScalarCollection</link> scalars [Read-Only]</title>
<para>
The list of all scalars in Kst.
</para>
</sect3>
<sect3 id="property_Kst_3">
<title><link linkend="class_StringCollection">StringCollection</link> strings [Read-Only]</title>
<para>
The list of all strings in Kst.
</para>
</sect3>
<sect3 id="property_Kst_4">
<title><link linkend="class_VectorCollection">VectorCollection</link> vectors [Read-Only]</title>
<para>
The list of all vectors in Kst.
</para>
</sect3>
<sect3 id="property_Kst_5">
<title><link linkend="class_MatrixCollection">MatrixCollection</link> matrices [Read-Only]</title>
<para>
The list of all matrices in Kst.
</para>
</sect3>
<sect3 id="property_Kst_6">
<title><link linkend="class_WindowCollection">WindowCollection</link> windows [Read-Only]</title>
<para>
The list of all Kst windows in this process.
</para>
</sect3>
<sect3 id="property_Kst_7">
<title><link linkend="class_DataObjectCollection">DataObjectCollection</link> objects [Read-Only]</title>
<para>
The list of all data objects in Kst.
</para>
</sect3>
<sect3 id="property_Kst_8">
<title><link linkend="class_ColorSequence">ColorSequence</link> colors [Read-Only]</title>
<para>
A reference to the Kst color sequence in its current state.
</para>
</sect3>
<sect3 id="property_Kst_9">
<title><link linkend="class_ExtensionCollection">ExtensionCollection</link> extensions [Read-Only]</title>
<para>
The list of all extensions Kst can find installed on the
system.
</para>
</sect3>
<sect3 id="property_Kst_10">
<title><link linkend="class_Document">Document</link> document [Read-Only]</title>
<para>
An object that provides access to the current Kst document
along with various utility functions.
</para>
</sect3>
<sect3 id="property_Kst_11">
<title><link linkend="class_PluginManager">PluginManager</link> pluginManager [Read-Only]</title>
<para>
A reference to the plugin management subsystem of Kst.
</para>
</sect3>
<sect3 id="property_Kst_12">
<title>QWidget gui [Read-Only]</title>
<para>
A reference to the Kst GUI. This is implemented using
KJSEmbed. The GUI is dynamic and may change between
releases or even while Kst is running.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Label">
<title>Class: Label</title>
<para>
A text label.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_BorderedViewObject">BorderedViewObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="constructors_Label">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Label_1">Label</link> ( parent )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Label_2">Label</link> ( window )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Label">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Label_1">adjustSizeForText</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Label">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Label_1">text</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Label_2">font</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Label_3">fontSize</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Label_4">rotation</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Label_5">dataPrecision</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Label_6">interpreted</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Label_7">scalarReplacement</link>
</para>
</listitem>
<listitem>
<para>autoResize [Obsolete]</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Label_1">
<title>Label ( <link linkend="class_ViewObject">ViewObject</link> parent )</title>
<para><itemizedlist><listitem><para><link linkend="class_ViewObject">ViewObject</link> parent -
The parent to place the new label in. May also
be a string containing the name of an existing
ViewObject.
</para></listitem></itemizedlist>
Creates a new label and places it in the ViewObject <emphasis>parent</emphasis>.
</para>
</sect3>
<sect3 id="constructor_Label_2">
<title>Label ( <link linkend="class_Window">Window</link> window )</title>
<para><itemizedlist><listitem><para><link linkend="class_Window">Window</link> window -
The window to place the new label in. May also be a
string containing the name of an existing Window.
</para></listitem></itemizedlist>
Creates a new label and places it in the Window <emphasis>window</emphasis>.
</para>
</sect3>
<sect3 id="method_Label_1">
<title>void adjustSizeForText ( )</title>
<para>
Adjusts the size of the label to fit the text.
</para>
</sect3>
<sect3 id="property_Label_1">
<title>string text</title>
<para>
Contains the text contents of the label. This may include
carriage returns (\n), scalar references of the form
<emphasis>[scalar_name]</emphasis>, and some basic LaTeX.
</para>
</sect3>
<sect3 id="property_Label_2">
<title>string font</title>
<para>
Used to set or get the current font used for the label.
</para>
</sect3>
<sect3 id="property_Label_3">
<title>number fontSize</title>
<para>
Contains the size of the font used to draw the label.
</para>
</sect3>
<sect3 id="property_Label_4">
<title>number rotation</title>
<para>
Contains the rotation angle of the label. Rotation is
clockwise from <emphasis>normal</emphasis> and is stored in degrees.
</para>
</sect3>
<sect3 id="property_Label_5">
<title>number dataPrecision</title>
<para>
Contains the number of digits of precision to display data
values in the label. Restricted to a value between 0 and
16 inclusive.
</para>
</sect3>
<sect3 id="property_Label_6">
<title>boolean interpreted</title>
<para>
Determines if the contents of the label should be
interpreted in order to substitute LaTeX-like
constructs. Default is true.
</para>
</sect3>
<sect3 id="property_Label_7">
<title>boolean scalarReplacement</title>
<para>
Determines if the contents of the label should be
interpreted in order to substitute variable reference
constructs. Default is true.
</para>
</sect3>
<sect3 id="property_Label_8">
<title>boolean autoResize [Obsolete]</title>
<para>
Automatically resizes the label to fit the text exactly.
May trigger a slight move of the label. It will not
automatically resize if the user resizes it manually via
the size property or layout mode.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Legend">
<title>Class: Legend</title>
<para>
A plot legend.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_BorderedViewObject">BorderedViewObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="constructors_Legend">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Legend_1">Legend</link> ( parent )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Legend_2">Legend</link> ( window )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Legend">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Legend_1">addCurve</link> ( curve )</para>
</listitem>
<listitem>
<para><link linkend="method_Legend_2">removeCurve</link> ( curve )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Legend">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Legend_1">font</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Legend_2">fontSize</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Legend_3">textColor</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Legend_4">vertical</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Legend_5">curves</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Legend_6">title</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Legend_1">
<title>Legend ( <link linkend="class_ViewObject">ViewObject</link> parent )</title>
<para><itemizedlist><listitem><para><link linkend="class_ViewObject">ViewObject</link> parent -
The parent to place the new legend in. May also
be a string containing the name of an existing
ViewObject.
</para></listitem></itemizedlist>
Creates a new legend and places it in the ViewObject <emphasis>parent</emphasis>.
</para>
</sect3>
<sect3 id="constructor_Legend_2">
<title>Legend ( <link linkend="class_Window">Window</link> window )</title>
<para><itemizedlist><listitem><para><link linkend="class_Window">Window</link> window -
The window to place the new legend in. May also be a
string containing the name of an existing Window.
</para></listitem></itemizedlist>
Creates a new legend and places it in the Window <emphasis>window</emphasis>.
</para>
</sect3>
<sect3 id="method_Legend_1">
<title>void addCurve ( string curve )</title>
<para><itemizedlist><listitem><para>string curve -
The curve to be added. This can be either the name of the curve or a reference to the curve.
</para></listitem></itemizedlist>
Adds the curve to the legend.
<itemizedlist><listitem><para>
Throws: TypeError -
Throws this exception if the curve could not be found.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_Legend_2">
<title>void removeCurve ( string curve )</title>
<para><itemizedlist><listitem><para>string curve -
The curve to be removed. This can be either the name of the curve or a reference to the curve.
</para></listitem></itemizedlist>
Removes the curve from the legend.
<itemizedlist><listitem><para>
Throws: TypeError -
Throws this exception if the curve could not be found.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="property_Legend_1">
<title>string font</title>
<para>
Used to set or get the current font used for the legend.
</para>
</sect3>
<sect3 id="property_Legend_2">
<title>number fontSize</title>
<para>
Contains the size of the font used to draw the legend.
</para>
</sect3>
<sect3 id="property_Legend_3">
<title>string textColor</title>
<para>
Contains the color of the text used to draw the legend.
</para>
</sect3>
<sect3 id="property_Legend_4">
<title>boolean vertical</title>
<para>
True if the legend entries are stacked vertically.
</para>
</sect3>
<sect3 id="property_Legend_5">
<title><link linkend="class_CurveCollection">CurveCollection</link> curves [Read-Only]</title>
<para>
The list of curves shown in the legend.
</para>
</sect3>
<sect3 id="property_Legend_6">
<title>string title</title>
<para>
The title of the legend.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Line">
<title>Class: Line</title>
<para>
A customizable line graphic.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_ViewObject">ViewObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="constructors_Line">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Line_1">Line</link> ( parent )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Line_2">Line</link> ( window )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Line">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Line_1">from</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Line_2">to</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Line_3">width</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Line_4">capStyle</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Line_5">lineStyle</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Line_1">
<title>Line ( <link linkend="class_ViewObject">ViewObject</link> parent )</title>
<para><itemizedlist><listitem><para><link linkend="class_ViewObject">ViewObject</link> parent -
The parent to place the new line in. May also
be a string containing the name of an existing
ViewObject.
</para></listitem></itemizedlist>
Creates a new line and places it in the ViewObject <emphasis>parent</emphasis>.
</para>
</sect3>
<sect3 id="constructor_Line_2">
<title>Line ( <link linkend="class_Window">Window</link> window )</title>
<para><itemizedlist><listitem><para><link linkend="class_Window">Window</link> window -
The window to place the new line in. May also be a
string containing the name of an existing Window.
</para></listitem></itemizedlist>
Creates a new line and places it in the Window <emphasis>window</emphasis>.
</para>
</sect3>
<sect3 id="property_Line_1">
<title><link linkend="class_Point">Point</link> from</title>
<para>
The starting point of the line.
</para>
</sect3>
<sect3 id="property_Line_2">
<title><link linkend="class_Point">Point</link> to</title>
<para>
The ending point of the line.
</para>
</sect3>
<sect3 id="property_Line_3">
<title>number width</title>
<para>
The width of the line.
</para>
</sect3>
<sect3 id="property_Line_4">
<title>number capStyle</title>
<para>
The cap style for the line.
<itemizedlist>
<listitem><para>0 - Flat - may not cover the line ends (default)</para></listitem>
<listitem><para>1 - Box - may extend past line ends</para></listitem>
<listitem><para>2 - Rounded</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Line_5">
<title>number lineStyle</title>
<para>
The style for the line.
<itemizedlist>
<listitem><para>0 - Solid line(default)</para></listitem>
<listitem><para>1 - Dashed line</para></listitem>
<listitem><para>2 - Dotted line</para></listitem>
<listitem><para>3 - Dash - dot line</para></listitem>
<listitem><para>4 - Dash - dot - dot line</para></listitem>
</itemizedlist>
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Matrix">
<title>Class: Matrix</title>
<para>
Represents a matrix of any type in Kst. Some matrices are
editable, while others are not.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Object">Object</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_MatrixCollection">MatrixCollection</link>
</para>
<sect2 id="constructors_Matrix">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Matrix_1">Matrix</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Matrix">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Matrix_1">resize</link> ( columns, rows )</para>
</listitem>
<listitem>
<para><link linkend="method_Matrix_2">zero</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Matrix_3">value</link> ( column, row )</para>
</listitem>
<listitem>
<para><link linkend="method_Matrix_4">setValue</link> ( column, row, value )</para>
</listitem>
<listitem>
<para><link linkend="method_Matrix_5">update</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Matrix">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Matrix_1">editable</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Matrix_2">min</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Matrix_3">max</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Matrix_4">mean</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Matrix_5">numNew</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Matrix_6">rows</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Matrix_7">columns</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Matrix_1">
<title>Matrix ( )</title>
<para>
Default constructor creates an empty matrix.
</para>
</sect3>
<sect3 id="method_Matrix_1">
<title>void resize ( number columns, number rows )</title>
<para><itemizedlist><listitem><para>number columns -
The new number of rows in the matrix. Should be >= 1.
</para></listitem><listitem><para>number rows -
The new number of columns in the matrix. Should be >= 1.
</para></listitem></itemizedlist>
Resizes the matrix.
<itemizedlist><listitem><para>
Throws: GeneralError -
Throws this exception if the matrix is not
editable.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_Matrix_2">
<title>void zero ( )</title>
<para>
Sets all values in the matrix to zero.
<itemizedlist><listitem><para>
Throws: GeneralError -
Throws this exception if the matrix is not editable.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_Matrix_3">
<title>number value ( number column, number row )</title>
<para><itemizedlist><listitem><para>number column -
The column index of the matrix position to be read.
</para></listitem><listitem><para>number row -
The row index of the matrix position to be read.
</para></listitem></itemizedlist>
Gets the value of a matrix at the given column and row indices.
<itemizedlist><listitem><para>
Throws: GeneralError -
Throws this exception if the indices are out of range.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_Matrix_4">
<title>void setValue ( number column, number row, number value )</title>
<para><itemizedlist><listitem><para>number column -
The column index of the matrix position to be set.
</para></listitem><listitem><para>number row -
The row index of the matrix position to be set.
</para></listitem><listitem><para>number value -
The value to set the specified matrix position to.
</para></listitem></itemizedlist>
Sets the value of a matrix at the given column and row indices.
<itemizedlist><listitem><para>
Throws: GeneralError -
Throws this exception if the matrix is not editable or the indices are out of range.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_Matrix_5">
<title>void update ( )</title>
<para>
Updates the statistical values associated with a matrix.
<itemizedlist><listitem><para>
Throws: GeneralError -
Throws this exception if the matrix is not editable.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="property_Matrix_1">
<title>number editable [Read-Only]</title>
<para>
True if the matrix is editable by the user. This should be
checked before attempting to modify a matrix in any way.
</para>
</sect3>
<sect3 id="property_Matrix_2">
<title>number min [Read-Only]</title>
<para>
The value of the smallest sample in the matrix.
</para>
</sect3>
<sect3 id="property_Matrix_3">
<title>number max [Read-Only]</title>
<para>
The value of the largest sample in the matrix.
</para>
</sect3>
<sect3 id="property_Matrix_4">
<title>number mean [Read-Only]</title>
<para>
The mean value of all samples in the matrix.
</para>
</sect3>
<sect3 id="property_Matrix_5">
<title>number numNew [Read-Only]</title>
<para>
The number of new samples.
</para>
</sect3>
<sect3 id="property_Matrix_6">
<title>number rows [Read-Only]</title>
<para>
The number of rows in the matrix.
</para>
</sect3>
<sect3 id="property_Matrix_7">
<title>number columns [Read-Only]</title>
<para>
The number of coluns in the matrix.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_MatrixCollection">
<title>Class: MatrixCollection</title>
<para>
An array of Matrices.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_Object">
<title>Class: Object</title>
<para>
Represents any object in Kst. This is an abstract
object and may not be instantiated directly.
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ObjectCollection">ObjectCollection</link>
</para>
<sect2 id="properties_Object">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Object_1">tagName</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Object_2">fullTagName</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_Object_1">
<title>string tagName</title>
<para>
A unique identifier for this data object.
</para>
</sect3>
<sect3 id="property_Object_2">
<title>string fullTagName [Read-Only]</title>
<para>
The unique contextual identifier for this data object, contained with [...].
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_ObjectCollection">
<title>Class: ObjectCollection</title>
<para>
An array of Objects. This could contain any objects that
inherit from Object, but they are only immediately accessible
in their pure base class form.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_Picture">
<title>Class: Picture</title>
<para>
A customizable picture object.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_BorderedViewObject">BorderedViewObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="constructors_Picture">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Picture_1">Picture</link> ( parent )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Picture_2">Picture</link> ( window )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Picture">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Picture_1">load</link> ( url )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Picture">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Picture_1">image</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Picture_2">url</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Picture_3">refreshTimer</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Picture_1">
<title>Picture ( <link linkend="class_ViewObject">ViewObject</link> parent )</title>
<para><itemizedlist><listitem><para><link linkend="class_ViewObject">ViewObject</link> parent -
The parent to place the new picture in. May also
be a string containing the name of an existing
ViewObject.
</para></listitem></itemizedlist>
Creates a new picture and places it in the ViewObject <emphasis>parent</emphasis>.
</para>
</sect3>
<sect3 id="constructor_Picture_2">
<title>Picture ( <link linkend="class_Window">Window</link> window )</title>
<para><itemizedlist><listitem><para><link linkend="class_Window">Window</link> window -
The window to place the new picture in. May also be a
string containing the name of an existing Window.
</para></listitem></itemizedlist>
Creates a new picture and places it in the Window <emphasis>window</emphasis>.
</para>
</sect3>
<sect3 id="method_Picture_1">
<title>boolean load ( string url )</title>
<para><itemizedlist><listitem><para>string url -
The URL to retrieve the image from.
</para></listitem></itemizedlist>
Load an image from a give url. Returns true on success.
</para>
</sect3>
<sect3 id="property_Picture_1">
<title><link linkend="class_Image">Image</link> image</title>
<para>
The raw image that is being displayed. You can take a copy
of this, manipulate it, then set it back to change the
image.
</para>
</sect3>
<sect3 id="property_Picture_2">
<title>string url [Read-Only]</title>
<para>
The URL of the image if it was loaded from a file and has
not been modified.
</para>
</sect3>
<sect3 id="property_Picture_3">
<title>number refreshTimer</title>
<para>
A timer to automatically refresh the picture. Value of 0
means the timer is disabled. Units are in seconds.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Plot">
<title>Class: Plot</title>
<para>
This class represents a plot in Kst.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_BorderedViewObject">BorderedViewObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_PlotCollection">PlotCollection</link>
</para>
<sect2 id="constructors_Plot">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Plot_1">Plot</link> ( window )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Plot">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Plot_1">createLegend</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Plot">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Plot_1">curves</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plot_2">legend</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plot_3">topLabel</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plot_4">xAxis</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plot_5">yAxis</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plot_6">title</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plot_7">tied</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Plot_1">
<title>Plot ( <link linkend="class_Window">Window</link> window )</title>
<para><itemizedlist><listitem><para><link linkend="class_Window">Window</link> window -
The window to place the new plot in. May also be a
string containing the name of an existing Window.
</para></listitem></itemizedlist>
Creates a new plot and places it in the Window <emphasis>window</emphasis>.
</para>
</sect3>
<sect3 id="method_Plot_1">
<title><link linkend="class_Legend">Legend</link> createLegend ( )</title>
<para>
Creates a Legend for this plot. If a legend already exists
then that one is returned.
</para>
</sect3>
<sect3 id="property_Plot_1">
<title><link linkend="class_CurveCollection">CurveCollection</link> curves [Read-Only]</title>
<para>
A list of all the Curves used by the plot.
</para>
</sect3>
<sect3 id="property_Plot_2">
<title><link linkend="class_Legend">Legend</link> legend [Read-Only]</title>
<para>
The Legend for this plot. May be null.
</para>
</sect3>
<sect3 id="property_Plot_3">
<title>string topLabel</title>
<para>
The top label for this plot.
</para>
</sect3>
<sect3 id="property_Plot_4">
<title><link linkend="class_Axis">Axis</link> xAxis [Read-Only]</title>
<para>
The X-axis for this plot.
</para>
</sect3>
<sect3 id="property_Plot_5">
<title><link linkend="class_Axis">Axis</link> yAxis [Read-Only]</title>
<para>
The Y-axis for this plot.
</para>
</sect3>
<sect3 id="property_Plot_6">
<title><link linkend="class_PlotLabel">PlotLabel</link> title [Read-Only]</title>
<para>
The title for this plot.
</para>
</sect3>
<sect3 id="property_Plot_7">
<title>boolean tied</title>
<para>
True if the plot zoom state is tied.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_PlotCollection">
<title>Class: PlotCollection</title>
<para>
An array of Plots.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_PlotLabel">
<title>Class: PlotLabel</title>
<para>
A class representing a plot label.
</para>
<sect2 id="properties_PlotLabel">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_PlotLabel_1">text</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PlotLabel_2">font</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PlotLabel_3">fontSize</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PlotLabel_4">justification</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PlotLabel_5">dataPrecision</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_PlotLabel_1">
<title>string text</title>
<para>
Contains the text contents of the label. This may include
carriage returns (\n), scalar references of the form
<emphasis>[scalar_name]</emphasis>, and some basic LaTeX.
</para>
</sect3>
<sect3 id="property_PlotLabel_2">
<title>string font</title>
<para>
Used to set or get the current font used for the label.
</para>
</sect3>
<sect3 id="property_PlotLabel_3">
<title>number fontSize</title>
<para>
Contains the size of the font used to draw the label.
</para>
</sect3>
<sect3 id="property_PlotLabel_4">
<title>number justification</title>
<para>
The horizontal justification for the label. This is a bit field.
The values are as follows:
<itemizedlist>
<listitem><para>0 - Justify None</para></listitem>
<listitem><para>1 - Justify Left / Top</para></listitem>
<listitem><para>2 - Justify Right / Bottom</para></listitem>
<listitem><para>3 - Justify Center</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_PlotLabel_5">
<title>number dataPrecision</title>
<para>
Contains the number of digits of precision to display data
values in the label. Restricted to a value between 0 and
16 inclusive.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Plugin">
<title>Class: Plugin</title>
<para>
This class represents a data plugin in Kst. It can be
instantiated to create a new instance of a plugin in the
Kst data collection.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_PluginCollection">PluginCollection</link>
</para>
<sect2 id="constructors_Plugin">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Plugin_1">Plugin</link> ( [module] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Plugin">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Plugin_1">setInput</link> ( index, input )</para>
</listitem>
<listitem>
<para><link linkend="method_Plugin_2">validate</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Plugin">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Plugin_1">inputs</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plugin_2">outputs</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plugin_3">module</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plugin_4">lastError</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Plugin_5">valid</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Plugin_1">
<title>Plugin ( [<link linkend="class_PluginModule">PluginModule</link> module] )</title>
<para><itemizedlist><listitem><para><link linkend="class_PluginModule">PluginModule</link> module -
The plugin module to use for this plugin.
[OPTIONAL]</para></listitem></itemizedlist>
Main constructor for the Plugin class. New plugins are
typically invalid until various properties have been set.
</para>
</sect3>
<sect3 id="method_Plugin_1">
<title>void setInput ( number index, <link linkend="class_Object">Object</link> input )</title>
<para><itemizedlist><listitem><para>number index -
or name of the input argument to be set.
</para></listitem><listitem><para><link linkend="class_Object">Object</link> input -
argument.
</para></listitem></itemizedlist>
Sets the input argument at the specified index or name.
</para>
</sect3>
<sect3 id="method_Plugin_2">
<title>void validate ( )</title>
<para>
Validates the plugin.
</para>
</sect3>
<sect3 id="property_Plugin_1">
<title><link linkend="class_ObjectCollection">ObjectCollection</link> inputs</title>
<para>
The list of inputs to the plugin.
</para>
</sect3>
<sect3 id="property_Plugin_2">
<title><link linkend="class_ObjectCollection">ObjectCollection</link> outputs</title>
<para>
The list of outputs to the plugin.
</para>
</sect3>
<sect3 id="property_Plugin_3">
<title><link linkend="class_PluginModule">PluginModule</link> module</title>
<para>
The library or module that is used for data processing by
this plugin object.
</para>
</sect3>
<sect3 id="property_Plugin_4">
<title>string lastError [Read-Only]</title>
<para>
A string containing details of the last error that
occurred while running the plugin.
</para>
</sect3>
<sect3 id="property_Plugin_5">
<title>boolean valid [Read-Only]</title>
<para>
True if this plugin object is valid. If false, there is
probably an invalid setting somewhere that needs to be
corrected before it can be used. Some errors include
invalid inputs or outputs, or an invalid or missing
PluginModule.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_PluginCollection">
<title>Class: PluginCollection</title>
<para>
An array of Plugins.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_PluginIO">
<title>Class: PluginIO</title>
<para>
An object representing an input or output for a given plugin
module.
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_PluginIOCollection">PluginIOCollection</link>
</para>
<sect2 id="properties_PluginIO">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_PluginIO_1">name</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginIO_2">type</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginIO_3">subType</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginIO_4">typeObject</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginIO_5">description</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginIO_6">defaultValue</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_PluginIO_1">
<title>string name [Read-Only]</title>
<para>
The name of the input or output.
</para>
</sect3>
<sect3 id="property_PluginIO_2">
<title>string type [Read-Only]</title>
<para>
The data type of the input or output.
</para>
</sect3>
<sect3 id="property_PluginIO_3">
<title>string subType [Read-Only]</title>
<para>
The sub-type of the input or output, if needed. For
instance, a <emphasis>table</emphasis> may have a subtype of <emphasis>float</emphasis>.
</para>
</sect3>
<sect3 id="property_PluginIO_4">
<title>string typeObject [Read-Only]</title>
<para>
The object type of the input or output. The result will be one of:
<itemizedlist>
<listitem><para>Vector</para></listitem>
<listitem><para>Scalar</para></listitem>
<listitem><para>String</para></listitem>
<listitem><para>Unknown - error condition</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_PluginIO_5">
<title>string description [Read-Only]</title>
<para>
A description of the meaning of the input or output.
</para>
</sect3>
<sect3 id="property_PluginIO_6">
<title>string defaultValue [Read-Only]</title>
<para>
The default value for this input or output, if specified by
the plugin.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_PluginIOCollection">
<title>Class: PluginIOCollection</title>
<para>
An array of Plugin inputs or outputs.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_PluginManager">
<title>Class: PluginManager</title>
<para>
A reference to Kst's plugin manager subsystem.
</para>
<sect2 id="constructors_PluginManager">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_PluginManager_1">PluginManager</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_PluginManager">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_PluginManager_1">modules</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_PluginManager_1">
<title>PluginManager ( )</title>
<para>
Creates a new PluginManager referring to the Kst plugin
manager.
</para>
</sect3>
<sect3 id="property_PluginManager_1">
<title><link linkend="class_PluginModuleCollection">PluginModuleCollection</link> modules [Read-Only]</title>
<para>
A list of all PluginModules available.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_PluginModule">
<title>Class: PluginModule</title>
<para>
Represents a plugin module in Kst. This is not an instance of
a plugin, but a reference to the actual plugin itself. It is
typically used to instantiate a plugin object.
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_PluginModuleCollection">PluginModuleCollection</link>
</para>
<sect2 id="properties_PluginModule">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_PluginModule_1">usesLocalData</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginModule_2">isFit</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginModule_3">isFilter</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginModule_4">name</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginModule_5">readableName</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginModule_6">author</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginModule_7">description</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginModule_8">version</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginModule_9">inputs</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PluginModule_10">outputs</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_PluginModule_1">
<title>boolean usesLocalData [Read-Only]</title>
<para>
If true, the plugin makes use of persistant local storage.
</para>
</sect3>
<sect3 id="property_PluginModule_2">
<title>boolean isFit [Read-Only]</title>
<para>
If true, this plugin is a <emphasis>fit</emphasis> for a curve.
</para>
</sect3>
<sect3 id="property_PluginModule_3">
<title>boolean isFilter [Read-Only]</title>
<para>
If true, this plugin is a <emphasis>filter</emphasis> for a vector.
</para>
</sect3>
<sect3 id="property_PluginModule_4">
<title>string name [Read-Only]</title>
<para>
Represents the short name of the plugin.
</para>
</sect3>
<sect3 id="property_PluginModule_5">
<title>string readableName [Read-Only]</title>
<para>
Contains a long name for the plugin suitable for display in
a user interface.
</para>
</sect3>
<sect3 id="property_PluginModule_6">
<title>string author [Read-Only]</title>
<para>
Contains the name of the author of the plugin.
</para>
</sect3>
<sect3 id="property_PluginModule_7">
<title>string description [Read-Only]</title>
<para>
Contains a text description of what the plugin is and/or
does.
</para>
</sect3>
<sect3 id="property_PluginModule_8">
<title>string version [Read-Only]</title>
<para>
Contains the version number or string of the plugin.
</para>
</sect3>
<sect3 id="property_PluginModule_9">
<title><link linkend="class_PluginIOCollection">PluginIOCollection</link> inputs [Read-Only]</title>
<para>
A list of all the inputs for the plugin.
</para>
</sect3>
<sect3 id="property_PluginModule_10">
<title><link linkend="class_PluginIOCollection">PluginIOCollection</link> outputs [Read-Only]</title>
<para>
A list of all the outputs of the plugin.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_PluginModuleCollection">
<title>Class: PluginModuleCollection</title>
<para>
An array of PluginModules.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_Point">
<title>Class: Point</title>
<para>
Represents a cartesian co-ordinate of the form (x,y).
</para>
<sect2 id="constructors_Point">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Point_1">Point</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Point_2">Point</link> ( x, y )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Point">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Point_1">x</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Point_2">y</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Point_1">
<title>Point ( )</title>
<para>
Creates a new point object with value (0.0, 0.0).
</para>
</sect3>
<sect3 id="constructor_Point_2">
<title>Point ( number x, number y )</title>
<para><itemizedlist><listitem><para>number x -
The X value.
</para></listitem><listitem><para>number y -
The Y value.
</para></listitem></itemizedlist>
Creates a new point object with value (x, y).
</para>
</sect3>
<sect3 id="property_Point_1">
<title>number x</title>
<para>
The value of the x co-ordinate.
</para>
</sect3>
<sect3 id="property_Point_2">
<title>number y</title>
<para>
The value of the y co-ordinate.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_PowerSpectrum">
<title>Class: PowerSpectrum</title>
<para>
This class represents a power spectrum (PSD) object in Kst.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_PowerSpectrumCollection">PowerSpectrumCollection</link>
</para>
<sect2 id="constructors_PowerSpectrum">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_PowerSpectrum_1">PowerSpectrum</link> ( vector, freq [, average [, len [, apodize [, removeMean]]]] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_PowerSpectrum">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_PowerSpectrum_1">vector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_2">length</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_3">output</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_4">removeMean</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_5">average</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_6">apodize</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_7">apodizeFn</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_8">frequency</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_9">xVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_10">yVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_11">vUnits</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_12">rUnits</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_PowerSpectrum_13">interpolateHoles</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_PowerSpectrum_1">
<title>PowerSpectrum ( <link linkend="class_Vector">Vector</link> vector, number freq [, boolean average [, number len [, boolean apodize [, boolean removeMean]]]] )</title>
<para><itemizedlist><listitem><para><link linkend="class_Vector">Vector</link> vector -
The vector to use as input to the power spectrum.
</para></listitem><listitem><para>number freq -
The frequency for the power spectrum.
</para></listitem><listitem><para>boolean average -
[OPTIONAL]</para></listitem><listitem><para>number len -
The base 2 logarithm of the length of the power
spectrum. Should be an integer >= 4.
[OPTIONAL]</para></listitem><listitem><para>boolean apodize -
If true, sharp discontinuities are removed.
[OPTIONAL]</para></listitem><listitem><para>boolean removeMean -
True if the mean should be removed before
performing the transform.
[OPTIONAL]</para></listitem></itemizedlist>
Creates a new power spectrum (PSD) object in Kst. Units
are <emphasis>V</emphasis> and <emphasis>Hz</emphasis> by default.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_1">
<title><link linkend="class_Vector">Vector</link> vector</title>
<para>
The input vector for the power spectrum.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_2">
<title>number length</title>
<para>
Contains the base 2 logarithm of the length to be used for interleaved averaging. Should be an integer >= 4.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_3">
<title>number output</title>
<para>
the normalization for the transform:
<itemizedlist>
<listitem><para>0 - amplitude spectral density</para></listitem>
<listitem><para>1 - power spectral density</para></listitem>
<listitem><para>2 - amplitude spectrum</para></listitem>
<listitem><para>3 - power spectrum</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_PowerSpectrum_4">
<title>boolean removeMean</title>
<para>
True if the mean should be removed before performing the
transform.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_5">
<title>boolean average</title>
<para>
True if the power spectrum should be calculated using an interleaved average.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_6">
<title>boolean apodize</title>
<para>
If true, sharp discontinuities are removed.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_7">
<title>number apodizeFn</title>
<para>
The apodization function to be used in the case that apodize is true:
<itemizedlist>
<listitem><para>0 - default</para></listitem>
<listitem><para>1 - bartlett</para></listitem>
<listitem><para>2 - blackman</para></listitem>
<listitem><para>3 - connes</para></listitem>
<listitem><para>4 - cosine</para></listitem>
<listitem><para>5 - gaussian</para></listitem>
<listitem><para>6 - hamming</para></listitem>
<listitem><para>7 - hann</para></listitem>
<listitem><para>8 - welch</para></listitem>
<listitem><para>9 - uniform</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_PowerSpectrum_8">
<title>number frequency</title>
<para>
Contains the sampling rate of the power spectrum.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_9">
<title><link linkend="class_Vector">Vector</link> xVector [Read-Only]</title>
<para>
The X-axis vector for the power spectrum.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_10">
<title><link linkend="class_Vector">Vector</link> yVector [Read-Only]</title>
<para>
The Y-axi vector for the power spectrum.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_11">
<title>string vUnits</title>
<para>
A string containing the units for the vector.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_12">
<title>string rUnits</title>
<para>
A string containing the units for the rate.
</para>
</sect3>
<sect3 id="property_PowerSpectrum_13">
<title>boolean interpolateHoles</title>
<para>
True if the transform should automatically interpolate over missing data values.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_PowerSpectrumCollection">
<title>Class: PowerSpectrumCollection</title>
<para>
An array of PowerSpectrums.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_Scalar">
<title>Class: Scalar</title>
<para>
Represents a scalar value (a number) in Kst.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Object">Object</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ScalarCollection">ScalarCollection</link>
</para>
<sect2 id="constructors_Scalar">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Scalar_1">Scalar</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Scalar_2">Scalar</link> ( value )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Scalar">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Scalar_1">value</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Scalar_1">
<title>Scalar ( )</title>
<para>
Default constructor. Creates a new scalar with value 0.0.
</para>
</sect3>
<sect3 id="constructor_Scalar_2">
<title>Scalar ( number value )</title>
<para><itemizedlist><listitem><para>number value -
</para></listitem></itemizedlist>
Creates a new scalar with the specified value.
</para>
</sect3>
<sect3 id="property_Scalar_1">
<title>number value</title>
<para>
Used to access or modify the value of a scalar.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_ScalarCollection">
<title>Class: ScalarCollection</title>
<para>
An array of Scalars.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_Size">
<title>Class: Size</title>
<para>
Represents a two-dimensional size of the form (w, h).
</para>
<sect2 id="constructors_Size">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Size_1">Size</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Size_2">Size</link> ( w, h )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Size">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Size_1">w</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Size_2">h</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Size_1">
<title>Size ( )</title>
<para>
Creates a new size object with value (0.0, 0.0).
</para>
</sect3>
<sect3 id="constructor_Size_2">
<title>Size ( number w, number h )</title>
<para><itemizedlist><listitem><para>number w -
The width.
</para></listitem><listitem><para>number h -
The height.
</para></listitem></itemizedlist>
Creates a new size object with value (w, h).
</para>
</sect3>
<sect3 id="property_Size_1">
<title>number w</title>
<para>
The width.
</para>
</sect3>
<sect3 id="property_Size_2">
<title>number h</title>
<para>
The height.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Spectrogram">
<title>Class: Spectrogram</title>
<para>
This class represents a spectrogram (CSD) object in Kst.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_SpectrogramCollection">SpectrogramCollection</link>
</para>
<sect2 id="constructors_Spectrogram">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Spectrogram_1">Spectrogram</link> ( vector, freq [, average [, len [, apodize [, removeMean]]]] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Spectrogram">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Spectrogram_1">vector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_2">length</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_3">output</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_4">removeMean</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_5">average</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_6">apodize</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_7">apodizeFn</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_8">frequency</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_9">matrix</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_10">vUnits</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_11">rUnits</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_12">windowSize</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Spectrogram_13">interpolateHoles</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Spectrogram_1">
<title>Spectrogram ( <link linkend="class_Vector">Vector</link> vector, number freq [, boolean average [, number len [, boolean apodize [, boolean removeMean]]]] )</title>
<para><itemizedlist><listitem><para><link linkend="class_Vector">Vector</link> vector -
The vector to use as input to the spectrogram.
</para></listitem><listitem><para>number freq -
The frequency for the spectrogram.
</para></listitem><listitem><para>boolean average -
[OPTIONAL]</para></listitem><listitem><para>number len -
The base 2 logarithm of the length of the power
spectrum. Should be an integer >= 4.
[OPTIONAL]</para></listitem><listitem><para>boolean apodize -
If true, sharp discontinuities are removed.
[OPTIONAL]</para></listitem><listitem><para>boolean removeMean -
True if the mean should be removed before
performing the transform.
[OPTIONAL]</para></listitem></itemizedlist>
Creates a new power spectrum (PSD) object in Kst. Units
are <emphasis>V</emphasis> and <emphasis>Hz</emphasis> by default.
</para>
</sect3>
<sect3 id="property_Spectrogram_1">
<title><link linkend="class_Vector">Vector</link> vector</title>
<para>
The input vector for the spectrogram.
</para>
</sect3>
<sect3 id="property_Spectrogram_2">
<title>number length</title>
<para>
Contains the base 2 logarithm of the length of the spectrogram.
Should be an integer >= 4.
</para>
</sect3>
<sect3 id="property_Spectrogram_3">
<title>number output</title>
<para>
the normalization for the transform:
<itemizedlist>
<listitem><para>0 - amplitude spectral density</para></listitem>
<listitem><para>1 - power spectral density</para></listitem>
<listitem><para>2 - amplitude spectrum</para></listitem>
<listitem><para>3 - power spectrum</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Spectrogram_4">
<title>boolean removeMean</title>
<para>
True if the mean should be removed before performing the
transform.
</para>
</sect3>
<sect3 id="property_Spectrogram_5">
<title>number average</title>
<para></para>
</sect3>
<sect3 id="property_Spectrogram_6">
<title>boolean apodize</title>
<para>
If true, sharp discontinuities are removed.
</para>
</sect3>
<sect3 id="property_Spectrogram_7">
<title>number apodizeFn</title>
<para>
The apodization function to be used in the case that apodize is true:
<itemizedlist>
<listitem><para>0 - default</para></listitem>
<listitem><para>1 - bartlett</para></listitem>
<listitem><para>2 - blackman</para></listitem>
<listitem><para>3 - connes</para></listitem>
<listitem><para>4 - cosine</para></listitem>
<listitem><para>5 - gaussian</para></listitem>
<listitem><para>6 - hamming</para></listitem>
<listitem><para>7 - hann</para></listitem>
<listitem><para>8 - welch</para></listitem>
<listitem><para>9 - uniform</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_Spectrogram_8">
<title>number frequency</title>
<para>
Contains the sampling rate of the spectrogram.
</para>
</sect3>
<sect3 id="property_Spectrogram_9">
<title><link linkend="class_Matrix">Matrix</link> matrix [Read-Only]</title>
<para>
The matrix for the spectrogram.
</para>
</sect3>
<sect3 id="property_Spectrogram_10">
<title>string vUnits</title>
<para>
A string containing the units for the vector.
</para>
</sect3>
<sect3 id="property_Spectrogram_11">
<title>string rUnits</title>
<para>
A string containing the units for the rate.
</para>
</sect3>
<sect3 id="property_Spectrogram_12">
<title>number windowSize</title>
<para>
The window size of the spectrogram.
</para>
</sect3>
<sect3 id="property_Spectrogram_13">
<title>boolean interpolateHoles</title>
<para>
True if the transform should automatically interpolate over missing data values.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_SpectrogramCollection">
<title>Class: SpectrogramCollection</title>
<para>
An array of Spectrograms.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_String">
<title>Class: String</title>
<para>
Represents a string in Kst. Note that this is <emphasis>not</emphasis>
analagous to a string in JavaScript, and may not be directly
interchanged as such. A Kst String is an object internal to
Kst and is subject to update scheduling, sharing, and other
policies of the Kst core. However the <emphasis>contents</emphasis> of a
String may be manipulated with JavaScript string manipulation
functions.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Object">Object</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_StringCollection">StringCollection</link>
</para>
<sect2 id="constructors_String">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_String_1">String</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_String">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_String_1">value</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_String_1">
<title>String ( )</title>
<para>
Default constructor - creates an empty String.
</para>
</sect3>
<sect3 id="property_String_1">
<title>string value</title>
<para>
The value of the String.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_StringCollection">
<title>Class: StringCollection</title>
<para>
An array of Kst Strings.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_TimeInterpretation">
<title>Class: TimeInterpretation</title>
<para>
A class representing a time interpretation. It is used to
convert values from one set of units to display in another.
</para>
<sect2 id="properties_TimeInterpretation">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_TimeInterpretation_1">active</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_TimeInterpretation_2">axisType</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_TimeInterpretation_3">input</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_TimeInterpretation_4">output</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="property_TimeInterpretation_1">
<title>boolean active</title>
<para>
True if the axis is being interpreted.
</para>
</sect3>
<sect3 id="property_TimeInterpretation_2">
<title>string axisType [Read-Only]</title>
<para>
The type of axis this interpretation applies to.
</para>
</sect3>
<sect3 id="property_TimeInterpretation_3">
<title>number input</title>
<para>
The format of the input to the interpretation.
Must be one of:
<itemizedlist>
<listitem><para>0 - Standard C Time</para></listitem>
<listitem><para>1 - TAI</para></listitem>
<listitem><para>2 - JD</para></listitem>
<listitem><para>3 - MJD</para></listitem>
<listitem><para>4 - RJD</para></listitem>
<listitem><para>5 - JY</para></listitem>
<listitem><para>6 - TAI (ns)</para></listitem>
<listitem><para>7 - TAI (2^-16s)</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 id="property_TimeInterpretation_4">
<title>number output</title>
<para>
The format to convert the interpretation to.
Must be one of:
<itemizedlist>
<listitem><para>0 - DD/MM/YY HH:MM:SS</para></listitem>
<listitem><para>1 - YY/MM/DD HH:MM:SS</para></listitem>
<listitem><para>2 - JD</para></listitem>
<listitem><para>3 - MJD</para></listitem>
<listitem><para>4 - RJD</para></listitem>
<listitem><para>5 - JY</para></listitem>
<listitem><para>6 - Localized Short Date</para></listitem>
<listitem><para>7 - Localized Long Date</para></listitem>
</itemizedlist>
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_Vector">
<title>Class: Vector</title>
<para>
Represents a vector of any type in Kst. Some vectors are
editable, while others are not. This class behaves just as a
JavaScript array, but has additional properties and methods.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Object">Object</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_VectorCollection">VectorCollection</link>
</para>
<sect2 id="constructors_Vector">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Vector_1">Vector</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="constructor_Vector_2">Vector</link> ( array )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Vector">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Vector_1">resize</link> ( size )</para>
</listitem>
<listitem>
<para><link linkend="method_Vector_2">interpolate</link> ( i, n )</para>
</listitem>
<listitem>
<para><link linkend="method_Vector_3">zero</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Vector_4">update</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Vector_5">valueAt</link> ( index )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Vector">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Vector_1">length</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Vector_2">min</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Vector_3">max</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Vector_4">mean</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Vector_5">numNew</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Vector_6">numShifted</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Vector_7">editable</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Vector_8">numNaN</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Vector_9">array</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Vector_1">
<title>Vector ( )</title>
<para>
Default constructor creates an empty, editable vector.
</para>
</sect3>
<sect3 id="constructor_Vector_2">
<title>Vector ( Array array )</title>
<para><itemizedlist><listitem><para>Array array -
The array to be copied.
</para></listitem></itemizedlist>
Creates a vector that is a copy of array.
</para>
</sect3>
<sect3 id="method_Vector_1">
<title>void resize ( number size )</title>
<para><itemizedlist><listitem><para>number size -
The new size of the vector. Should be >= 2.
</para></listitem></itemizedlist>
Resizes the vector.
<itemizedlist><listitem><para>
Throws: GeneralError -
Throws this exception if the vector is not
editable.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_Vector_2">
<title>number interpolate ( number i, number n )</title>
<para><itemizedlist><listitem><para>number i -
The sample number to obtain the interpolated value of.
</para></listitem><listitem><para>number n -
The number of samples to interpolate to.
</para></listitem></itemizedlist>
Interpolates the vector to <emphasis>n</emphasis> samples and
returns the interpolated value of sample <emphasis>i</emphasis>.
</para>
</sect3>
<sect3 id="method_Vector_3">
<title>void zero ( )</title>
<para>
Sets all values in the vector to zero.
<itemizedlist><listitem><para>
Throws: GeneralError -
Throws this exception if the vector is not editable.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_Vector_4">
<title>void update ( )</title>
<para>
Updates the statistical values associated with a vector.
<itemizedlist><listitem><para>
Throws: GeneralError -
Throws this exception if the vector is not editable.
</para></listitem></itemizedlist></para>
</sect3>
<sect3 id="method_Vector_5">
<title>void valueAt ( number index )</title>
<para><itemizedlist><listitem><para>number index -
The sample number to obtain the value of.
A negative value of -n returns the n'th sample from the end of the vector..
</para></listitem></itemizedlist>
Returns the value at the given index.
</para>
</sect3>
<sect3 id="property_Vector_1">
<title>number length [Read-Only]</title>
<para>
The number of samples in the vector.
</para>
</sect3>
<sect3 id="property_Vector_2">
<title>number min [Read-Only]</title>
<para>
The value of the smallest sample in the vector.
</para>
</sect3>
<sect3 id="property_Vector_3">
<title>number max [Read-Only]</title>
<para>
The value of the largest sample in the vector.
</para>
</sect3>
<sect3 id="property_Vector_4">
<title>number mean [Read-Only]</title>
<para>
The mean value of all samples in the vector.
</para>
</sect3>
<sect3 id="property_Vector_5">
<title>number numNew [Read-Only]</title>
<para></para>
</sect3>
<sect3 id="property_Vector_6">
<title>number numShifted [Read-Only]</title>
<para></para>
</sect3>
<sect3 id="property_Vector_7">
<title>number editable [Read-Only]</title>
<para>
True if the vector is editable by the user. This should be
checked before attempting to modify a vector in any way.
</para>
</sect3>
<sect3 id="property_Vector_8">
<title>number numNaN [Read-Only]</title>
<para>
The number of NaN values in the vector.
</para>
</sect3>
<sect3 id="property_Vector_9">
<title>Array array [Read-Only]</title>
<para>
The vector as an Array.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_VectorCollection">
<title>Class: VectorCollection</title>
<para>
An array of Vectors.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_VectorView">
<title>Class: VectorView</title>
<para>
Represents a vectorView.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_DataObject">DataObject</link>
</para>
<sect2 id="constructors_VectorView">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_VectorView_1">VectorView</link> ( x, y )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_VectorView">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_VectorView_1">xVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_2">yVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_3">flagVector</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_4">xMin</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_5">xMax</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_6">yMin</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_7">yMax</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_8">useXMin</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_9">useXMax</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_10">useYMin</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_11">useYMax</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_VectorView_12">interpolateTo</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_VectorView_1">
<title>VectorView ( <link linkend="class_Vector">Vector</link> x, <link linkend="class_Vector">Vector</link> y )</title>
<para><itemizedlist><listitem><para><link linkend="class_Vector">Vector</link> x -
The x-vector.
</para></listitem><listitem><para><link linkend="class_Vector">Vector</link> y -
The y-vector.
</para></listitem></itemizedlist>
Creates a new vector view with the given x-vector and y-vector.
</para>
</sect3>
<sect3 id="property_VectorView_1">
<title><link linkend="class_Vector">Vector</link> xVector</title>
<para>
the x-vector.
</para>
</sect3>
<sect3 id="property_VectorView_2">
<title><link linkend="class_Vector">Vector</link> yVector</title>
<para>
the y-vector.
</para>
</sect3>
<sect3 id="property_VectorView_3">
<title><link linkend="class_Vector">Vector</link> flagVector</title>
<para>
the flag-vector. Those points corresponding to non-zero values of the flag vector
are removed from the output vectors.
</para>
</sect3>
<sect3 id="property_VectorView_4">
<title><link linkend="class_Scalar">Scalar</link> xMin</title>
<para>
the value for the minimum x-value for the view range.
</para>
</sect3>
<sect3 id="property_VectorView_5">
<title><link linkend="class_Scalar">Scalar</link> xMax</title>
<para>
the value for the maximum x-value for the view range.
</para>
</sect3>
<sect3 id="property_VectorView_6">
<title><link linkend="class_Scalar">Scalar</link> yMin</title>
<para>
the value for the minimum y-value for the view range.
</para>
</sect3>
<sect3 id="property_VectorView_7">
<title><link linkend="class_Scalar">Scalar</link> yMax</title>
<para>
the value for the maximum y-value for the view range.
</para>
</sect3>
<sect3 id="property_VectorView_8">
<title>boolean useXMin</title>
<para>
If true, the minimum x-value is respected.
</para>
</sect3>
<sect3 id="property_VectorView_9">
<title>boolean useXMax</title>
<para>
If true, the maximum x-value is respected.
</para>
</sect3>
<sect3 id="property_VectorView_10">
<title>boolean useYMin</title>
<para>
If true, the minimum y-value is respected.
</para>
</sect3>
<sect3 id="property_VectorView_11">
<title>boolean useYMax</title>
<para>
If true, the maximum y-value is respected.
</para>
</sect3>
<sect3 id="property_VectorView_12">
<title>number interpolateTo</title>
<para>
the value for the maximum y-value for the view range. Must be one of:
<itemizedlist>
<listitem><para>0 - interpolate to the x-vector</para></listitem>
<listitem><para>1 - interpolate to the y-vector</para></listitem>
<listitem><para>2 - interpolate to the high resolution vector</para></listitem>
<listitem><para>3 - interpolate to the low resolution vector</para></listitem>
</itemizedlist>
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_ViewObject">
<title>Class: ViewObject</title>
<para>
Represents any object in a Kst window. This is an abstract
object and may not be instantiated directly.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Object">Object</link>
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_ViewObjectCollection">ViewObjectCollection</link>
</para>
<sect2 id="methods_ViewObject">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_ViewObject_1">resize</link> ( size )</para>
</listitem>
<listitem>
<para><link linkend="method_ViewObject_2">move</link> ( pos )</para>
</listitem>
<listitem>
<para><link linkend="method_ViewObject_3">findChild</link> ( pos )</para>
</listitem>
<listitem>
<para><link linkend="method_ViewObject_4">convertTo</link> ( type )</para>
</listitem>
<listitem>
<para><link linkend="method_ViewObject_5">raiseToTop</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_ViewObject_6">lowerToBottom</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_ViewObject_7">raise</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_ViewObject_8">lower</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_ViewObject_9">remove</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_ViewObject">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_ViewObject_1">position</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_2">size</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_3">transparent</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_4">onGrid</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_5">columns</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_6">color</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_7">backgroundColor</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_8">maximized</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_9">minimumSize</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_10">type</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_ViewObject_11">children</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="method_ViewObject_1">
<title><link linkend="class_ViewObject">ViewObject</link> resize ( <link linkend="class_Size">Size</link> size )</title>
<para><itemizedlist><listitem><para><link linkend="class_Size">Size</link> size -
The new size for the object.
</para></listitem></itemizedlist>
Resizes the object to the given size, if possible.
</para>
</sect3>
<sect3 id="method_ViewObject_2">
<title><link linkend="class_ViewObject">ViewObject</link> move ( <link linkend="class_Point">Point</link> pos )</title>
<para><itemizedlist><listitem><para><link linkend="class_Point">Point</link> pos -
The position to move the object to.
</para></listitem></itemizedlist>
Moves the object to a new position, if possible.
</para>
</sect3>
<sect3 id="method_ViewObject_3">
<title><link linkend="class_ViewObject">ViewObject</link> findChild ( <link linkend="class_Point">Point</link> pos )</title>
<para><itemizedlist><listitem><para><link linkend="class_Point">Point</link> pos -
The relative position to search.
</para></listitem></itemizedlist>
Finds the topmost child of this view object at the given
point. Returns null if there is no child there.
</para>
</sect3>
<sect3 id="method_ViewObject_4">
<title><link linkend="class_ViewObject">ViewObject</link> convertTo ( string type )</title>
<para><itemizedlist><listitem><para>string type -
The type to attempt to convert this object to.
</para></listitem></itemizedlist>
Attempts to convert this ViewObject to a different type.
The object must be derived from this type at some level.
Null is returned if it is not possible to convert to the
requested type.
</para>
</sect3>
<sect3 id="method_ViewObject_5">
<title>void raiseToTop ( )</title>
<para>
Raises the object to the top of the z-order.
</para>
</sect3>
<sect3 id="method_ViewObject_6">
<title>void lowerToBottom ( )</title>
<para>
Lowers the object to the bottom of the z-order.
</para>
</sect3>
<sect3 id="method_ViewObject_7">
<title>void raise ( )</title>
<para>
Raises the object one place in the z-order.
</para>
</sect3>
<sect3 id="method_ViewObject_8">
<title>void lower ( )</title>
<para>
Lowers the object one place in the z-order.
</para>
</sect3>
<sect3 id="method_ViewObject_9">
<title>void remove ( )</title>
<para>
Deletes the object.
</para>
</sect3>
<sect3 id="property_ViewObject_1">
<title><link linkend="class_Point">Point</link> position</title>
<para>
The location of the object relative to its parent.
</para>
</sect3>
<sect3 id="property_ViewObject_2">
<title><link linkend="class_Size">Size</link> size</title>
<para>
The size of the object in pixels.
</para>
</sect3>
<sect3 id="property_ViewObject_3">
<title>boolean transparent</title>
<para>
True if this object is transparent. Not all objects
support transparency.
</para>
</sect3>
<sect3 id="property_ViewObject_4">
<title>boolean onGrid</title>
<para>
True if the children of this object are on a grid.
</para>
</sect3>
<sect3 id="property_ViewObject_5">
<title>number columns</title>
<para>
The number of columns the children are organized into. If
this value is modified, <emphasis>onGrid</emphasis> is set to true.
</para>
</sect3>
<sect3 id="property_ViewObject_6">
<title>string color</title>
<para>
The foreground color for this object.
</para>
</sect3>
<sect3 id="property_ViewObject_7">
<title>string backgroundColor</title>
<para>
The background color for this object.
</para>
</sect3>
<sect3 id="property_ViewObject_8">
<title>boolean maximized</title>
<para>
If true, this object is maximized relative to its parent.
This is a temporary state whereby the plot uses all the
space available in the parent but can be restored to
<emphasis>normal</emphasis> size again.
</para>
</sect3>
<sect3 id="property_ViewObject_9">
<title><link linkend="class_Size">Size</link> minimumSize [Read-Only]</title>
<para>
The minimum size of the view object.
</para>
</sect3>
<sect3 id="property_ViewObject_10">
<title>string type [Read-Only]</title>
<para>
A string containing the type of this view object.
</para>
</sect3>
<sect3 id="property_ViewObject_11">
<title><link linkend="class_ViewObjectCollection">ViewObjectCollection</link> children [Read-Only]</title>
<para>
The list of all children of this view object in z-order
from the furthest back to the closest to the top. This
is a reference to a collection which may be modified, but
cannot be <emphasis>set</emphasis>.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_ViewObjectCollection">
<title>Class: ViewObjectCollection</title>
<para>
An array of ViewObjects.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
<sect1 id="class_Window">
<title>Class: Window</title>
<para>
An object that represents a reference to a Kst window or tab.
</para>
<para>
<emphasis role="bold">Collection class:</emphasis>
<link linkend="class_WindowCollection">WindowCollection</link>
</para>
<sect2 id="constructors_Window">
<title>Constructors:</title>
<itemizedlist>
<listitem>
<para><link linkend="constructor_Window_1">Window</link> ( [name] )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="methods_Window">
<title>Methods:</title>
<itemizedlist>
<listitem>
<para><link linkend="method_Window_1">repaint</link> ( )</para>
</listitem>
<listitem>
<para><link linkend="method_Window_2">close</link> ( )</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="properties_Window">
<title>Properties:</title>
<itemizedlist>
<listitem>
<para>
<link linkend="property_Window_1">name</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Window_2">plots</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Window_3">view</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="property_Window_4">columns</link>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title/>
<para/>
<sect3 id="constructor_Window_1">
<title>Window ( [string name] )</title>
<para><itemizedlist><listitem><para>string name -
A name for the new window.
[OPTIONAL]</para></listitem></itemizedlist>
Creates a new window and object to refer to it.
</para>
</sect3>
<sect3 id="method_Window_1">
<title>void repaint ( )</title>
<para>
Repaints the window.
</para>
</sect3>
<sect3 id="method_Window_2">
<title>void close ( )</title>
<para>
Closes the window.
</para>
</sect3>
<sect3 id="property_Window_1">
<title>string name</title>
<para>
The name of the window this object refers to.
</para>
</sect3>
<sect3 id="property_Window_2">
<title><link linkend="class_PlotCollection">PlotCollection</link> plots</title>
<para>
The list of plots contained in this window, flattened.
</para>
</sect3>
<sect3 id="property_Window_3">
<title><link linkend="class_ViewObject">ViewObject</link> view</title>
<para>
The view object for this window.
</para>
</sect3>
<sect3 id="property_Window_4">
<title>number columns</title>
<para>
The number of columns the children are organized into. If
this value is modified, <emphasis>onGrid</emphasis> is set to true.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="class_WindowCollection">
<title>Class: WindowCollection</title>
<para>
An array of Kst Windows.
</para>
<para>
<emphasis role="bold">Inherits:</emphasis>
<link linkend="class_Collection">Collection</link>
</para>
<sect2>
<title/>
<para/>
</sect2>
</sect1>
</appendix>
