LayerSetAxisUserLabel

LayerSetAxisUserLabel sets the user labels. The user labels are labels which can be places at the axis. The labels can display text.

bool = LayerSetAxisUserLabel(hLayer, ssXYZ, smLabel)
bool = LayerSetAxisUserLabel(hLayer, ssXYZ, svLabel, rvPos)

Return Value

If the function succeeds, the return value is TRUE (1); otherwise it is FALSE (0).

Parameters

hLayer

Identifies the layer.

ssXYZ

ssXYZ is "X" for the x-axis, "Y" for the y-axis and "Z" for the z-axis.

smLabel

smLabel is a string matrix with two columns. The first columns contains the position as a string and the second column the display string.

svLabel

svLabel is a string vector with the display string.

rvPos

rvPos is a real vector with the label positions. To remove all user label set rvPos to 1e10 and svLabel to “”.

Example

smEnum = ["1.0", "On";
          "0.0", "Off"];
LayerSetAxisUserLabel(hLayer, "Y", smEnum);
LayerSetAxisUserLabelAttribs(hLayer, "Y", ...
       AXIS_USERLABEL_ENABLE | AXIS_STANDARDLABEL_DISABLE | AXIS_USERLABEL_SKIPOVERLAP);

Remove alle user label:

LayerSetAxisUserLabel(hLayer, "Y", "", 1e10);

History

Version Description
R2014 New.

id-1190257