CDXYSetLegendTxt < Main

Tags: view all tags
---+ .XY SET LEGEND TXT

_This subroutine sets the name to be included in the Legend box._

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

Sets the name to be included in the legend box for the "current" dataset template of the current data group of the current XY Layer. 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]] and added a data set template via [[CDLayerAddDataSetTemplate][.LAYER ADD DATASET TM]] for this to have any effect.

The parameter is optional. If not passed, or blank, the current legend will be removed and the current Text spec will be deleted. If a value is passed, it will become a legend in the current legend box.

After setting the Legend text, it becomes the "current" text spec.

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 - 2011-10-19
Topic revision: r7 - 2012-02-25 - JeanNeron