[Kst] www/areas/extragear/apps/kst/kstscript/docs
Andrew Walker
arwalker at sumusltd.com
Mon Mar 2 18:40:46 CET 2009
SVN commit 934284 by arwalker:
add Dir object to online documentation
M +1 -1 Curve.html
M +12 -1 DataSource.html
A Dir.html
M +13 -1 Vector.html
M +19 -16 classindex.html
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Curve.html #934283:934284
@@ -230,7 +230,7 @@
<br><br><span class="subTitle"><a name="property_lineStyle"></a><b>number lineStyle</b></span><br><ul><p>
Sets the line style for this curve when lines are drawn.
<ul>
- <li>0 - Soild</li>
+ <li>0 - Solid</li>
<li>1 - Dash</li>
<li>2 - Dot</li>
<li>3 - Dash Dot</li>
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/DataSource.html #934283:934284
@@ -21,7 +21,7 @@
<a class="link" href="#constructor_1">DataSource</a> ( url [, type] )<br>
</ul>
<span class="title">Methods:</span><ul>
-<a class="link" href="#method_isValidField">isValidField</a> ( field )<br><a class="link" href="#method_fieldList">fieldList</a> ( )<br><a class="link" href="#method_reset">reset</a> ( )<br><a class="link" href="#method_matrixList">matrixList</a> ( )<br><a class="link" href="#method_samplesPerFrame">samplesPerFrame</a> ( field )<br><a class="link" href="#method_frameCount">frameCount</a> ( [field] )<br><a class="link" href="#method_setConfiguration">setConfiguration</a> ( setting, setting )<br><a class="link" href="#method_configuration">configuration</a> ( setting )<br>
+<a class="link" href="#method_isValidField">isValidField</a> ( field )<br><a class="link" href="#method_fieldList">fieldList</a> ( )<br><a class="link" href="#method_reset">reset</a> ( )<br><a class="link" href="#method_matrixList">matrixList</a> ( )<br><a class="link" href="#method_samplesPerFrame">samplesPerFrame</a> ( field )<br><a class="link" href="#method_frameCount">frameCount</a> ( [field] )<br><a class="link" href="#method_setConfiguration">setConfiguration</a> ( setting, setting )<br><a class="link" href="#method_configuration">configuration</a> ( setting )<br><a class="link" href="#method_units">units</a> ( field )<br>
</ul>
<span class="title">Properties:</span><ul>
<a class="link" href="#property_valid">valid</a><br><a class="link" href="#property_empty">empty</a><br><a class="link" href="#property_completeFieldList">completeFieldList</a><br><a class="link" href="#property_fileName">fileName</a><br><a class="link" href="#property_fileType">fileType</a><br><a class="link" href="#property_source">source</a><br><a class="link" href="#property_metaData">metaData</a><br>
@@ -126,6 +126,17 @@
</p>
</ul>
+<br><br><span class="subTitle"><a name="method_units"></a><b>string units ( string field )</b></span><br><ul>
+<div class="parameters">string <b>field</b> -
+ Gives the field name to retrieve the units of.
+
+ <br>
+</div>
+<p>
+ Gets the units associated with a field of the data source.
+
+ </p>
+</ul>
<br><br><span class="subTitle"><a name="property_valid"></a><b>boolean valid [Read-Only]</b></span><br><ul><p>
True if the data source is valid.
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Vector.html #934283:934284
@@ -22,7 +22,7 @@
<a class="link" href="#constructor_1">Vector</a> ( )<br><a class="link" href="#constructor_2">Vector</a> ( array )<br>
</ul>
<span class="title">Methods:</span><ul>
-<a class="link" href="#method_resize">resize</a> ( size )<br><a class="link" href="#method_interpolate">interpolate</a> ( i, n )<br><a class="link" href="#method_zero">zero</a> ( )<br><a class="link" href="#method_update">update</a> ( )<br>
+<a class="link" href="#method_resize">resize</a> ( size )<br><a class="link" href="#method_interpolate">interpolate</a> ( i, n )<br><a class="link" href="#method_zero">zero</a> ( )<br><a class="link" href="#method_update">update</a> ( )<br><a class="link" href="#method_valueAt">valueAt</a> ( index )<br>
</ul>
<span class="title">Properties:</span><ul>
<a class="link" href="#property_length">length</a><br><a class="link" href="#property_min">min</a><br><a class="link" href="#property_max">max</a><br><a class="link" href="#property_mean">mean</a><br><a class="link" href="#property_numNew">numNew</a><br><a class="link" href="#property_numShifted">numShifted</a><br><a class="link" href="#property_editable">editable</a><br><a class="link" href="#property_numNaN">numNaN</a><br><a class="link" href="#property_array">array</a><br>
@@ -99,6 +99,18 @@
<br>
</ul>
+<br><br><span class="subTitle"><a name="method_valueAt"></a><b>void valueAt ( number index )</b></span><br><ul>
+<div class="parameters">number <b>index</b> -
+ The sample number to obtain the value of.
+ A negative value of -n returns the n'th sample from the end of the vector..
+
+ <br>
+</div>
+<p>
+ Returns the value at the given index.
+
+ </p>
+</ul>
<br><br><span class="subTitle"><a name="property_length"></a><b>number length [Read-Only]</b></span><br><ul><p>
The number of samples in the vector.
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/classindex.html #934283:934284
@@ -42,86 +42,89 @@
<td><a href="DebugLogEntry.html">DebugLogEntry</a></td>
</tr>
<tr>
+<td><a href="Dir.html">Dir</a></td>
<td><a href="Document.html">Document</a></td>
<td><a href="Ellipse.html">Ellipse</a></td>
-<td><a href="ELOG.html">ELOG</a></td>
</tr>
<tr>
+<td><a href="ELOG.html">ELOG</a></td>
<td><a href="Equation.html">Equation</a></td>
<td><a href="EquationCollection.html">EquationCollection</a></td>
-<td><a href="Extension.html">Extension</a></td>
</tr>
<tr>
+<td><a href="Extension.html">Extension</a></td>
<td><a href="ExtensionCollection.html">ExtensionCollection</a></td>
<td><a href="File.html">File</a></td>
-<td><a href="Group.html">Group</a></td>
</tr>
<tr>
+<td><a href="Group.html">Group</a></td>
<td><a href="Histogram.html">Histogram</a></td>
<td><a href="HistogramCollection.html">HistogramCollection</a></td>
-<td><a href="Image.html">Image</a></td>
</tr>
<tr>
+<td><a href="Image.html">Image</a></td>
<td><a href="Kst.html">Kst</a></td>
<td><a href="Label.html">Label</a></td>
-<td><a href="Legend.html">Legend</a></td>
</tr>
<tr>
+<td><a href="Legend.html">Legend</a></td>
<td><a href="Line.html">Line</a></td>
<td><a href="Matrix.html">Matrix</a></td>
-<td><a href="MatrixCollection.html">MatrixCollection</a></td>
</tr>
<tr>
+<td><a href="MatrixCollection.html">MatrixCollection</a></td>
<td><a href="Object.html">Object</a></td>
<td><a href="ObjectCollection.html">ObjectCollection</a></td>
-<td><a href="Picture.html">Picture</a></td>
</tr>
<tr>
+<td><a href="Picture.html">Picture</a></td>
<td><a href="Plot.html">Plot</a></td>
<td><a href="PlotCollection.html">PlotCollection</a></td>
-<td><a href="PlotLabel.html">PlotLabel</a></td>
</tr>
<tr>
+<td><a href="PlotLabel.html">PlotLabel</a></td>
<td><a href="Plugin.html">Plugin</a></td>
<td><a href="PluginCollection.html">PluginCollection</a></td>
-<td><a href="PluginIO.html">PluginIO</a></td>
</tr>
<tr>
+<td><a href="PluginIO.html">PluginIO</a></td>
<td><a href="PluginIOCollection.html">PluginIOCollection</a></td>
<td><a href="PluginManager.html">PluginManager</a></td>
-<td><a href="PluginModule.html">PluginModule</a></td>
</tr>
<tr>
+<td><a href="PluginModule.html">PluginModule</a></td>
<td><a href="PluginModuleCollection.html">PluginModuleCollection</a></td>
<td><a href="Point.html">Point</a></td>
-<td><a href="PowerSpectrum.html">PowerSpectrum</a></td>
</tr>
<tr>
+<td><a href="PowerSpectrum.html">PowerSpectrum</a></td>
<td><a href="PowerSpectrumCollection.html">PowerSpectrumCollection</a></td>
<td><a href="Scalar.html">Scalar</a></td>
-<td><a href="ScalarCollection.html">ScalarCollection</a></td>
</tr>
<tr>
+<td><a href="ScalarCollection.html">ScalarCollection</a></td>
<td><a href="Size.html">Size</a></td>
<td><a href="Spectrogram.html">Spectrogram</a></td>
-<td><a href="SpectrogramCollection.html">SpectrogramCollection</a></td>
</tr>
<tr>
+<td><a href="SpectrogramCollection.html">SpectrogramCollection</a></td>
<td><a href="String.html">String</a></td>
<td><a href="StringCollection.html">StringCollection</a></td>
-<td><a href="TimeInterpretation.html">TimeInterpretation</a></td>
</tr>
<tr>
+<td><a href="TimeInterpretation.html">TimeInterpretation</a></td>
<td><a href="Vector.html">Vector</a></td>
<td><a href="VectorCollection.html">VectorCollection</a></td>
-<td><a href="VectorView.html">VectorView</a></td>
</tr>
<tr>
+<td><a href="VectorView.html">VectorView</a></td>
<td><a href="ViewObject.html">ViewObject</a></td>
<td><a href="ViewObjectCollection.html">ViewObjectCollection</a></td>
+</tr>
+<tr>
<td><a href="Window.html">Window</a></td>
+<td><a href="WindowCollection.html">WindowCollection</a></td>
</tr>
-<tr><td><a href="WindowCollection.html">WindowCollection</a></td></tr>
</table>
<br><br><a href="../index.html">[Index]</a><hr>
<h6>Copyright ©
More information about the Kst
mailing list