|
META TOPICPARENT |
name="CDChartDirectorDesignerAPI" |
.CHART SET TITLE |
|
< < | This subroutine is called to set the title for the "current" chart spec. |
> > | This subroutine is called to set the title for the "current" chart. |
|
Usage:
PASS <chart_title> FIELD SHARE? N |
|
< < | PASS FIELD SHARE? N |
> > | PASS FIELD SHARE? N |
| GOSUB CHT .CHART SET TITLE
-
- Check for error IF CHT .CHART SET TITLE NE
Description: |
|
< < | This subroutine sets the title for the "current" chart. |
> > | This subroutine sets the title for the "current" chart. This subroutine only needs to be called if the chart is to have a title or if a previously set chart title is to be changed or removed. |
| |
|
< < | The parameters for this subroutine are both optional. |
> > | <chart_title> is the text string which will be rendered as the chart title in a text box normally positioned at the top the chart area. The <chart_title> parameter is optional.
- If a non-blank <chart_title> is passed, then a title is set for the "current" chart. If a title has been previously set, then that title is replaced.
- If a <chart_title> is not passed or if a blank title is passed, then no title is set. If a title has been previously set, then that title is cleared along with all of the related chart title attributes.
<text_box_name> is the name of a previously initialized text box. The <text_box_name> parameter is optional.
- If a <text_box_name> is passed, then the attributes of the specified text box are used as a prototype for the attributes of the <chart_title>. Two special keywords may be used in lieu of a <text_box_name>: "INITIALIZE" and "CURRENT"
- "INITIALIZE" indicates that the chart title is to be set and no special title attributes are to be set. Any previously set title attributes are to be cleared.
- "CURRENT" indicates that the chart title is to be set and the attributes of the "current" text box are to be used as a prototype for the attributes of the <chart_title>.
- If a <text_box_name> is not passed, then the following rules determine how the attributes of the chart title are set:
- If the chart title has been previously set, then the new chart title is set and any previously set attributes of the chart title are not changed.
- If the chart title has not been previously set, then the attributes of the "current" text box will be used as a prototype for the attributes of the <chart_title> provided that the "current" text box has been explicitly initialized or is associated with another chart's title. If the "current" text box is not appropriate, then no attributes of the <chart_title> will be set in conjunction with setting the chart title.
|
| |
|
< < | If a <chart_title> is passed, then the title is set for the "current" chart spec. |
> > | If no attributes are set for a chart title, the title is rendered using certain default text attributes which are appropriate for a chart title. For example, the chart title will be be positioned at the top of the chart area, centered horizontally, and rendered using a larger, bold font. |
| |
|
< < | If a <chart_title> is not passed, then any existing chart title for the "current" chart spec is cleared along with all of the related chart title attributes.
If a <text_spec_name> is passed, then the text attributes of the named text spec are set as the default attributes for the chart title.
The chart title become the "current" text object and subsequent calls to the various text routines set/modify the text attributes of the title. |
> > | The chart title text box become the "current" text box and subsequent calls to the various text subroutines may be made to further set/modify the text attributes of the chart title. |
| Comments:
Read what other users have said about this page or add your own comments. |