[Kst] www/areas/extragear/apps/kst/kstscript/docs
Andrew Walker
arwalker at sumusltd.com
Fri Jun 13 23:31:01 CEST 2008
SVN commit 820324 by arwalker:
update javaScript online documentation
M +1 -10 Box.html
M +2 -12 ColorSequence.html
M +8 -8 Curve.html
M +1 -21 Label.html
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Box.html #820323:820324
@@ -20,7 +20,7 @@
<a class="link" href="#constructor_1">Box</a> ( parent )<br><a class="link" href="#constructor_2">Box</a> ( window )<br>
</ul>
<span class="title">Properties:</span><ul>
-<a class="link" href="#property_xRound">xRound</a><br><a class="link" href="#property_yRound">yRound</a><br><a class="link" href="#property_cornerStyle">cornerStyle</a><br><a class="link" href="#property_borderWidth">borderWidth</a><br><a class="link" href="#property_borderColor">borderColor</a><br>
+<a class="link" href="#property_xRound">xRound</a><br><a class="link" href="#property_yRound">yRound</a><br><a class="link" href="#property_borderWidth">borderWidth</a><br><a class="link" href="#property_borderColor">borderColor</a><br>
</ul>
Collection class: <a class="link" href="ViewObjectCollection.html">ViewObjectCollection</a><br><hr>
<br><span class="subTitle"><a name="constructor_1"></a><b>Box ( <a class="link" href="ViewObject.html">ViewObject</a> parent )</b></span><br><ul>
@@ -60,15 +60,6 @@
an integer between 0 and 99.
</p></ul>
-<br><br><span class="subTitle"><a name="property_cornerStyle"></a><b>number cornerStyle</b></span><br><ul><p>
- The style to draw the corners of the box.
- <ul>
- <li>0 - Miter (default)</li>
- <li>1 - Bevel</li>
- <li>2 - Round</li>
- </ul>
-
- </p></ul>
<br><br><span class="subTitle"><a name="property_borderWidth"></a><b>number borderWidth</b></span><br><ul><p>
The width in pixels of the border.
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/ColorSequence.html #820323:820324
@@ -16,21 +16,11 @@
</p>
<br>
</div>
-<br><span class="title">Constructors:</span><ul>
-<a class="link" href="#constructor_1">ColorSequence</a> ( )<br>
-</ul>
-<span class="title">Methods:</span><ul>
+<br><span class="title">Methods:</span><ul>
<a class="link" href="#method_next">next</a> ( [previous] )<br><a class="link" href="#method_tooClose">tooClose</a> ( firstColor, secondColor )<br>
</ul>
<hr>
-<br><span class="subTitle"><a name="constructor_1"></a><b>ColorSequence ( )</b></span><br><ul>
-<div class="parameters"></div>
-<p>
- Default constructor. Creates a new color sequence object.
-
- </p>
-</ul>
-<br><br><span class="subTitle"><a name="method_next"></a><b>string next ( [string previous] )</b></span><br><ul>
+<br><span class="subTitle"><a name="method_next"></a><b>string next ( [string previous] )</b></span><br><ul>
<div class="parameters">string <b>previous</b> -
The previous color in the color sequence you are
following. Not necessary.
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Curve.html #820323:820324
@@ -93,7 +93,7 @@
</p>
</ul>
-<br><br><span class="subTitle"><a name="method_xErrorPoint"></a><b><a class="link" href="Point.html">Point</a> xErrorPoint ( number index )</b></span><br><ul>
+<br><br><span class="subTitle"><a name="method_xErrorPoint"></a><b>number xErrorPoint ( number index )</b></span><br><ul>
<div class="parameters">number <b>index</b> -
The index of the point to retrieve the coordinates
for. Starts at 0.
@@ -101,13 +101,13 @@
<br>
</div>
<p>
- Retrieve the coordinates for a given point in the X error
+ Retrieve the value for a given point in the X error
bars. Returns an invalid point if that index does not
exist.
</p>
</ul>
-<br><br><span class="subTitle"><a name="method_yErrorPoint"></a><b><a class="link" href="Point.html">Point</a> yErrorPoint ( number index )</b></span><br><ul>
+<br><br><span class="subTitle"><a name="method_yErrorPoint"></a><b>number yErrorPoint ( number index )</b></span><br><ul>
<div class="parameters">number <b>index</b> -
The index of the point to retrieve the coordinates
for. Starts at 0.
@@ -115,13 +115,13 @@
<br>
</div>
<p>
- Retrieve the coordinates for a given point in the Y error
+ Retrieve the value for a given point in the Y error
bars. Returns an invalid point if that index does not
exist.
</p>
</ul>
-<br><br><span class="subTitle"><a name="method_xMinusErrorPoint"></a><b><a class="link" href="Point.html">Point</a> xMinusErrorPoint ( number index )</b></span><br><ul>
+<br><br><span class="subTitle"><a name="method_xMinusErrorPoint"></a><b>number xMinusErrorPoint ( number index )</b></span><br><ul>
<div class="parameters">number <b>index</b> -
The index of the point to retrieve the coordinates
for. Starts at 0.
@@ -129,13 +129,13 @@
<br>
</div>
<p>
- Retrieve the coordinates for a given point in the X minus
+ Retrieve the value for a given point in the X minus
error bars. Returns an invalid point if that index does
not exist.
</p>
</ul>
-<br><br><span class="subTitle"><a name="method_yMinusErrorPoint"></a><b><a class="link" href="Point.html">Point</a> yMinusErrorPoint ( number index )</b></span><br><ul>
+<br><br><span class="subTitle"><a name="method_yMinusErrorPoint"></a><b>number yMinusErrorPoint ( number index )</b></span><br><ul>
<div class="parameters">number <b>index</b> -
The index of the point to retrieve the coordinates
for. Starts at 0.
@@ -143,7 +143,7 @@
<br>
</div>
<p>
- Retrieve the coordinates for a given point in the Y minus
+ Retrieve the value for a given point in the Y minus
error bars. Returns an invalid point if that index does
not exist.
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Label.html #820323:820324
@@ -23,7 +23,7 @@
<a class="link" href="#method_adjustSizeForText">adjustSizeForText</a> ( )<br>
</ul>
<span class="title">Properties:</span><ul>
-<a class="link" href="#property_text">text</a><br><a class="link" href="#property_font">font</a><br><a class="link" href="#property_fontSize">fontSize</a><br><a class="link" href="#property_justification">justification</a><br><a class="link" href="#property_rotation">rotation</a><br><a class="link" href="#property_dataPrecision">dataPrecision</a><br><a class="link" href="#property_interpreted">interpreted</a><br><a class="link" href="#property_scalarReplacement">scalarReplacement</a><br>autoResize [Obsolete]<br>
+<a class="link" href="#property_text">text</a><br><a class="link" href="#property_font">font</a><br><a class="link" href="#property_fontSize">fontSize</a><br><a class="link" href="#property_rotation">rotation</a><br><a class="link" href="#property_dataPrecision">dataPrecision</a><br><a class="link" href="#property_interpreted">interpreted</a><br><a class="link" href="#property_scalarReplacement">scalarReplacement</a><br>autoResize [Obsolete]<br>
</ul>
Collection class: <a class="link" href="ViewObjectCollection.html">ViewObjectCollection</a><br><hr>
<br><span class="subTitle"><a name="constructor_1"></a><b>Label ( <a class="link" href="ViewObject.html">ViewObject</a> parent )</b></span><br><ul>
@@ -74,26 +74,6 @@
Contains the size of the font used to draw the label.
</p></ul>
-<br><br><span class="subTitle"><a name="property_justification"></a><b>number justification</b></span><br><ul><p>
- The justification for the label. This is a bit field with
- two segments, one for horizontal and one for vertical
- justification. The values are as follows:
- <ul>
- <li>0 - Justify None</li>
- <li>1 - Justify Left / Top</li>
- <li>2 - Justify Right / Bottom</li>
- <li>3 - Justify Center</li>
- </ul>
- <p>Set the low order 8 bits to one of these values to
- control horizontal justification. Set the next 8 bits
- to one of these to control vertical justification.
- Example:</p>
- <code><pre>
- // Set justification to Right-Center
- label.justification = 2 | (3 << 8);
- </pre></code>
-
- </p></ul>
<br><br><span class="subTitle"><a name="property_rotation"></a><b>number rotation</b></span><br><ul><p>
Contains the rotation angle of the label. Rotation is
clockwise from <i>normal</i> and is stored in degrees.
More information about the Kst
mailing list