| RMC_AddLabelAxis function. | ||
| Add a label axis to a region of an existing chart | ||
| Syntax | ||
| nResult (LONG) = RMC_AddLabelAxis( ByVal nCtrlId (LONG), ByVal nRegion (LONG), ByRef sLabels (ASCIIZ), Optional ByVal nAxisCount (LONG), Optional ByVal nTickcount (LONG), Optional ByVal nAlignment (LONG), Optional ByVal nFontsize (LONG), Optional ByVal nTextcolor (LONG), Optional ByVal nTextalignment (LONG), Optional ByVal nLinecolor (LONG), Optional ByVal nLinestyle (LONG), Optional ByRef sText (ASCIIZ) ) |
||
| Parameter | ||
| nCtrlId (LONG) | ||
| Unique ID of the chart control, to which the label axis belongs. | ||
| nRegion (LONG) | ||
| Region to which the label axis belongs. | ||
| sLabels (ASCIIZ) | ||
| String with the axis' labels. The labels must be separated either with * or | ("Label1*Label2*Label3"). The maximum length of each label can be 50 chars. You can pass an empty string, then no labels will be drawn. | ||
| nAxisCount (LONG) | ||
| Number of label axes (1 or 2). If omitted or 0: 1 | ||
| nTickcount (LONG) | ||
| Number of vertical or horizontal (in case of horizontal bar charts) lines. This is an important parameter because it determines at last the number of data columns. If you want to have for example 10 single bars and each of them shall have an own label on the label axis, you must set this parameter to 10. If parameter sLabels holds 10 label texts you can omit this parameter, because then the number of labels will determine. | ||
| nAlignment (LONG) | ||
| Alignment of the label axis as an axis alignment constant. If omitted or 0, in case of horizontal bar charts: RMC_LABELAXISLEFT, in all other cases RMC_LABELAXISBOTTOM. | ||
| nFontsize (LONG) | ||
| Fontsize of the labels in points. If omitted or 0: 8 point | ||
| nTextColor (LONG) | ||
| Textcolor of the labels as a Color...constant. If omitted or 0: ColorBlack | ||
| nTextAlignment (LONG) | ||
| Textalignment of the labels: RMC_TEXTCENTER (default), RMC_TEXTLEFT or RMC_TEXTRIGHT. In case of horizontal alignment of the axis the labels can also be vertical aligned with RMC_TEXTDOWNWARD or RMC_TEXTUPWARD. | ||
| nLineColor (LONG) | ||
| Linecolor as a Color...constant. If omitted or 0: ColorBlack | ||
| nLineStyle (LONG) | ||
| Style of the lines as a linestyle constant. If omitted or 0: RMC_LINESTYLESOLID | ||
| sText (ASCIIZ) | ||
| Text for illustrations of the label axis, maximum length is 100 chars.
If the label axis has alignment of RMC_LABELXISLEFT, the text is drawn vertically from bottom to top, if the alignment is
RMC_LABELXISRIGHT, the text is painted vertically from top to bottom, in other cases it is painted horizontally.
As default the text will be printed in the same font size as the axis labels, defined with parameter nFontsize, but you can set the font's size and weight independently: add a backslash (\) at the end of the text, followed by a number and/or the char b, if you want to have the text printetd bold. | ||
| Return value | ||
| 0 | ||
| No error, function succeeded. | ||
| RMC_ERROR_CTRLID | ||
| Wrong control ID (0 or no chart with this control ID was found). | ||
| RMC_ERROR_MAXREGION | ||
| The region index exceeds the maximum possible numbers of regions (6) within a chart control. | ||
| RMC_ERROR_WRONGREGION | ||
| The region index is inexistent in the chart control. | ||
| RMC_ERROR_ALLOC | ||
| Error while allocating memory for the labels text. | ||
| Remarks | ||
| This function call is not optional. Each grid can live without a data axis, but must have at least one label axis. You can leave parameter sLables empty, you can even choose as linestyle RMC_LINESTYLENONE, so the label axis will be completely invisible, but you must add a label axis to the grid. | ||