CDColorSetGradient < Main

Tags: view all tags
---+ .COLOR SET GRADIENT

<em>Changes the "current" color object to have a two-point linear gradient color.<br /></em>

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;start_x&gt;                  FIELD            SHARE? N
      PASS         &lt;start_y&gt;                  FIELD            SHARE? N
      PASS         &lt;end_x&gt;                    FIELD            SHARE? N
      PASS         &lt;end_y&gt;                    FIELD            SHARE? N
      PASS         &lt;start_color&gt;              FIELD            SHARE? N
      PASS         &lt;end_color&gt;                FIELD            SHARE? N
      PASS         &lt;periodic&gt;                 FIELD            SHARE? N
      GOSUB    0CD .COLOR SET GRADIENT
      *        Check for error
      IF       0CD .COLOR SET GRADIENT        NE

</pre>
---++ Description:

Changes the "current" color object to have a two-point linear gradient color. All parameters except for &lt;periodic&gt; are required. If any are missing, the routine will CANCEL with an error message.

&lt;start_x&gt;<span style="white-space: pre;"> The x coordinate of the starting point of the reference gradient line segment</span>, 0-999.

&lt;start_y&gt;<span style="white-space: pre;"> The y coordinate of the starting point of the reference gradient line segment</span>, 0-999.

&lt;end_x&gt;<span style="white-space: pre;"> The x coordinate of the ending point of the reference gradient line segment</span>, 0-999.

&lt;end_y&gt; <span style="white-space: pre;"> The y coordinate of the ending point of the reference gradient line segment</span>, 0-999.

&lt;start_color&gt;<span style="white-space: pre;"> The color at the starting point of the reference gradient line segment</span>. This must refer to one of the valid color values as explained on the ColorSpec page.

&lt;end_color&gt;<span style="white-space: pre;"> The color at the ending point of the reference gradient line segment</span>. This must refer to one of the valid color values as explained on the ColorSpec page.

&lt;periodic&gt;<span style="white-space: pre;"> </span>On or True to activate it, or Off or False to turn it off. Specifies whether the gradient will repeat itself periodically. If the gradient does not repeat itself, the points that lie beyond the end points of the gradient line segment will assume the colors of the end points. Default is off.

This only modifies an existing color spec to be a gradient color, so you will have to assign a color to an object using the appropriate API first, then use this routine to change that color to be a gradient. For example, to create a gradient background on your chart, you would first assign a background color to the chart using [[CDChartSetBGColor][.CHART SET BG COLOR]], then immediately use this routine to change the background color to a gradient color. In this case, it doesn't matter what the initial background color will be, since you're going to immediately change it to a gradient color.

See ColorSpec for more information on working with colors.
---++ Comments:

_Read what other users have said about this page or add your own comments._

<br />%COMMENT%

-- Main.JeanNeron - 2012-01-19
Topic revision: r2 - 2012-02-22 - JeanNeron