CDXYSetBarGradient < Main

Tags: view all tags
---+ .XY SET BAR GRADIENT

_This subroutine applies a special shading effect for rectangular and polygonal bars._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;start_bright&gt;             FIELD            SHARE? N
      PASS         &lt;end_bright&gt;               FIELD            SHARE? N
      GOSUB    0CD .XY SET BAR GRADIENT
      *        Check for error
      IF       0CD .XY SET BAR GRADIENT       NE
</pre>
---++ Description:

This subroutine applies a special shading effect for rectangular and polygonal bars. You must have initialized the chart as an XY Chart via [[CDChartInitialize][.CHART INITIALIZE]] and added a bar layer via [[CDXYAddBarLayer][.XY ADD BAR LAYER]] for this to have any effect.

&lt;start_bright&gt;<span style="white-space: pre;"> T</span>his is t<span style="white-space: pre;">he brightness at the starting point.</span> If not passed, it will default to 0.75

&lt;end_bright&gt;<span style="white-space: pre;"> </span>This is the brightness at the ending point. If not passed, it will default to 1.5.

To turn off the effect, pass blank values for both fields. This will override [[CDColorSetGlass][.COLOR SET GLASS]], [[CDColorSetsoft][.COLOR SET SOFT]], [[CDXYSetBarEdgeEffect][.XY SET BAR EDGE EFF]] and [[CDXYSetBarEdgeWidth][.XY SET BAR EDGE WIDTH]].

This will shade all surfaces of a 2D or 3D bar with gradient colors.

For the front surface of a bar, the gradient is from base line of the bar to the end of the bar. For example, for a vertical bar pointing upwards, the gradient is from bottom to the top. Similarly, for a horizontal bar pointing rightwards, the gradient is from left to right.

For a 3D bar, the gradient for the top surface of a vertical bar or the right surface of a horizontal bar is from front to back. The gradients for the side surfaces are the same as for the front surface.

The gradient is specified with two brightness values at the gradient end points. A brightness less than 1 means the color is darkened, while a brightness greater than 1 means the color is brightened. For example, a brightness of 0.5 means the color is half as bright as the original color. If the original color is red, the color will become dark red. Conversely, a brightness of 2 means the color is twice as bright as the original color. If the original color is red, the color will become light red.

See ColorSpec for more information on working with colors.

See [[CDOverviewDatasetDefinition][Datasets Overview]] for more information on data sets, data groups, and layers.
---++ 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-25 - JeanNeron