[Kst] www/areas/extragear/apps/kst/kstscript/docs
Andrew Walker
arwalker at sumusltd.com
Thu Feb 21 22:30:48 CET 2008
SVN commit 777898 by arwalker:
update documentation for javaScript
A BinnedMap.html
A CrossPowerSpectrum.html
M +40 -1 DataSource.html
M +20 -2 Matrix.html
M +25 -21 classindex.html
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/DataSource.html #777897:777898
@@ -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> ( )<br><a class="link" href="#method_fieldList">fieldList</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_isValidField">isValidField</a> ( )<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>
</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>
@@ -56,6 +56,20 @@
</p>
</ul>
+<br><br><span class="subTitle"><a name="method_reset"></a><b>void reset ( )</b></span><br><ul>
+<div class="parameters"></div>
+<p>
+ Resets the data source.
+
+ </p>
+</ul>
+<br><br><span class="subTitle"><a name="method_matrixList"></a><b><a class="link" href="StringArray.html">StringArray</a> matrixList ( )</b></span><br><ul>
+<div class="parameters"></div>
+<p>
+ Generates a list of the matrices available from this source.
+
+ </p>
+</ul>
<br><br><span class="subTitle"><a name="method_samplesPerFrame"></a><b>number samplesPerFrame ( string field )</b></span><br><ul>
<div class="parameters">string <b>field</b> -
A field name to get the number of
@@ -83,6 +97,31 @@
</p>
</ul>
+<br><br><span class="subTitle"><a name="method_setConfiguration"></a><b>boolean setConfiguration ( string setting, string setting )</b></span><br><ul>
+<div class="parameters">string <b>setting</b> -
+ Gives the setting name to set the value of.
+
+ <br>string <b>setting</b> -
+ Gives the value of the setting.
+
+ <br>
+</div>
+<p>
+ Sets a configuration setting of the data source.
+
+ </p>
+</ul>
+<br><br><span class="subTitle"><a name="method_configuration"></a><b>string configuration ( string setting )</b></span><br><ul>
+<div class="parameters">string <b>setting</b> -
+ Gives the setting name to retrive the value of.
+
+ <br>
+</div>
+<p>
+ Gets a configuration setting 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/Matrix.html #777897:777898
@@ -21,7 +21,7 @@
<a class="link" href="#constructor_1">Matrix</a> ( )<br>
</ul>
<span class="title">Methods:</span><ul>
-<a class="link" href="#method_resize">resize</a> ( columns, rows )<br><a class="link" href="#method_zero">zero</a> ( )<br><a class="link" href="#method_setValue">setValue</a> ( row, column, value )<br><a class="link" href="#method_update">update</a> ( )<br>
+<a class="link" href="#method_resize">resize</a> ( columns, rows )<br><a class="link" href="#method_zero">zero</a> ( )<br><a class="link" href="#method_value">value</a> ( row, column )<br><a class="link" href="#method_setValue">setValue</a> ( row, column, value )<br><a class="link" href="#method_update">update</a> ( )<br>
</ul>
<span class="title">Properties:</span><ul>
<a class="link" href="#property_editable">editable</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_rows">rows</a><br><a class="link" href="#property_columns">columns</a><br>
@@ -64,6 +64,24 @@
<br>
</ul>
+<br><br><span class="subTitle"><a name="method_value"></a><b>number value ( number row, number column )</b></span><br><ul>
+<div class="parameters">number <b>row</b> -
+ The row index of the matrix position to be set.
+
+ <br>number <b>column</b> -
+ The column index of the matrix position to be set.
+
+ <br>
+</div>
+<p>
+ Gets the value of a matrix at the given row and column indices.
+
+ </p>
+ Throws: <b>GeneralError</b> -
+ Throws this exception if the indices are out of range.
+
+ <br>
+</ul>
<br><br><span class="subTitle"><a name="method_setValue"></a><b>void setValue ( number row, number column, number value )</b></span><br><ul>
<div class="parameters">number <b>row</b> -
The row index of the matrix position to be set.
@@ -77,7 +95,7 @@
<br>
</div>
<p>
- Sets the value of a matrix at the given x and y indices.
+ Sets the value of a matrix at the given row and column indices.
</p>
Throws: <b>GeneralError</b> -
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/classindex.html #777897:777898
@@ -13,110 +13,114 @@
</tr>
<tr>
<td><a href="AxisTickLabel.html">AxisTickLabel</a></td>
+<td><a href="BinnedMap.html">BinnedMap</a></td>
<td><a href="BorderedViewObject.html">BorderedViewObject</a></td>
-<td><a href="Box.html">Box</a></td>
</tr>
<tr>
+<td><a href="Box.html">Box</a></td>
<td><a href="Collection.html">Collection</a></td>
<td><a href="ColorSequence.html">ColorSequence</a></td>
+</tr>
+<tr>
+<td><a href="CrossPowerSpectrum.html">CrossPowerSpectrum</a></td>
<td><a href="Curve.html">Curve</a></td>
+<td><a href="CurveCollection.html">CurveCollection</a></td>
</tr>
<tr>
-<td><a href="CurveCollection.html">CurveCollection</a></td>
<td><a href="DataMatrix.html">DataMatrix</a></td>
<td><a href="DataObject.html">DataObject</a></td>
+<td><a href="DataObjectCollection.html">DataObjectCollection</a></td>
</tr>
<tr>
-<td><a href="DataObjectCollection.html">DataObjectCollection</a></td>
<td><a href="DataSource.html">DataSource</a></td>
<td><a href="DataSourceCollection.html">DataSourceCollection</a></td>
+<td><a href="DataVector.html">DataVector</a></td>
</tr>
<tr>
-<td><a href="DataVector.html">DataVector</a></td>
<td><a href="Debug.html">Debug</a></td>
<td><a href="DebugLog.html">DebugLog</a></td>
+<td><a href="DebugLogEntry.html">DebugLogEntry</a></td>
</tr>
<tr>
-<td><a href="DebugLogEntry.html">DebugLogEntry</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="ViewObject.html">ViewObject</a></td>
</tr>
<tr>
-<td><a href="ViewObject.html">ViewObject</a></td>
<td><a href="ViewObjectCollection.html">ViewObjectCollection</a></td>
<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