[Kst] www/areas/extragear/apps/kst/kstscript/docs

[Andrew Walker]

SVN commit 924521 by arwalker:

add new method to data vector

 M  +53 -1     DataVector.html  


--- trunk/www/areas/extragear/apps/kst/kstscript/docs/DataVector.html #924520:924521
@@ -20,7 +20,7 @@
 <a class="link" href="#constructor_1">DataVector</a> ( source, field [, start [, n [, skip [, ave]]]] )<br>
 </ul>
 <span class="title">Methods:</span><ul>
-<a class="link" href="#method_reload">reload</a> (  )<br><a class="link" href="#method_changeFile">changeFile</a> ( source )<br><a class="link" href="#method_changeFrames">changeFrames</a> ( start, count [, skip [, ave]] )<br>
+<a class="link" href="#method_reload">reload</a> (  )<br><a class="link" href="#method_changeFile">changeFile</a> ( source )<br><a class="link" href="#method_changeFrames">changeFrames</a> ( start, count [, skip [, ave]] )<br><a class="link" href="#method_changeFramesByTime">changeFramesByTime</a> ( typeStart, start, typeCount, count [, skip [, ave]] )<br>
 </ul>
 <span class="title">Properties:</span><ul>
 <a class="link" href="#property_valid">valid</a><br><a class="link" href="#property_skip">skip</a><br><a class="link" href="#property_boxcar">boxcar</a><br><a class="link" href="#property_readToEnd">readToEnd</a><br><a class="link" href="#property_countFromEnd">countFromEnd</a><br><a class="link" href="#property_skipLength">skipLength</a><br><a class="link" href="#property_startFrame">startFrame</a><br><a class="link" href="#property_startFrameRequested">startFrameRequested</a><br><a class="link" href="#property_frames">frames</a><br><a class="link" href="#property_framesRequested">framesRequested</a><br><a class="link" href="#property_samplesPerFrame">samplesPerFrame</a><br><a class="link" href="#property_field">field</a><br><a class="link" href="#property_dataSource">dataSource</a><br>
@@ -92,6 +92,58 @@
     
     </p>
 </ul>
+<br><br><span class="subTitle"><a name="method_changeFramesByTime"></a><b>void changeFramesByTime ( string typeStart, number start, string typeCount, number count [, number skip [, boolean ave]] )</b></span><br><ul>
+<div class="parameters">string <b>typeStart</b> - 
+      The type of the value specifying the start position
+                    The permissible values are as follows:
+                    <ul>
+                    <li>frames</li>
+                    <li>date</li>
+                    <li>ms (milliseconds)</li>
+                    <li>s (seconds)</li>
+                    <li>m (minutes)</li>
+                    <li>h (hours)</li>
+                    <li>days</li>
+                    <li>weeks</li>
+                    <li>months</li>
+                    <li>years</li>
+                    </ul>
+       
+      <br>number <b>start</b> - 
+      The starting frame, date, or time offset.
+       
+      <br>string <b>typeCount</b> - 
+      The type of the value specifying the count
+       
+      <br>number <b>count</b> - 
+      The number of frames or time duration to read.
+                    The permissible values are as follows:
+                    <ul>
+                    <li>frames</li>
+                    <li>ms (milliseconds)</li>
+                    <li>s (seconds)</li>
+                    <li>m (minutes)</li>
+                    <li>h (hours)</li>
+                    <li>days</li>
+                    <li>weeks</li>
+                    <li>months</li>
+                    <li>years</li>
+                    </ul>
+       
+      <br>number <b>skip</b> - 
+      The number of frames to skip by.
+       
+       [OPTIONAL]<br>boolean <b>ave</b> - 
+      True to boxcar filter.
+       
+       [OPTIONAL]<br>
+</div>
+<p>
+    Changes the sequence of data that is read in by this
+                    vector.
+    
+    </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 vector is valid.