LayerSetAxesAttribsΒΆ

The LayerSetAxesAttribs sets display attribs for the x an y axis.

bool = LayerSetAxesAttribs(hLayer, nAttrib)

Return Value

bool is TRUE (1) if the function was successful and otherwise FALSE (0).

Parameters

hLayer

hLayer is the handle of a diagram (layer).

nAttrib

nAttrib is an or combination of the following values:

Define

Value

Description

YAXIS_STACKEDDIA_LABELFREE

1

The axis scaling can be set independently of the stacked diagram grid settings. Otherwise the scaling is adjusted to the grid. This setting has no effect, if the diagram is not part of a stacked diagram. If the axis belongs to a stacked diagram, only two blue handles at to top and bottom of the diagram box are displayed. Otherwise 8 blue handles are displayed.

XAXIS_PROTECTTITLE

2

The axis title can only be set manually. If the attribute is not set, the axis title will be updated if a new dataset is loaded.

XAXIS_AUTOTITLE

4

The x-channel name of the first dataset will be displayed as an axis title.

YAXIS_PROTECTTITLE

8

The axis title can only be set manually. If the attribute is not, set the axis title will be updated if a new dataset is loaded.

YAXIS_AUTOTITLE

16

The axis title is the y-channel name of the displayed datasets.

ZAXIS_PROTECTTITLE

32

The axis title can only be set manually. If the attribute is not set the axis title will be updated if a new dataset is loaded.

ZAXIS_AUTOTITLE

64

The axis title is the channel name of the displayed datasets.

YAXIS_SHOWSYMBOL

128

A line symbol will be displayed in front of the axis title.

YAXIS_AUTOCOLORTITLE

256

The axis title will be displayed in the color of the first dataset.

YAXIS_AUTOCOLORAXIS

512

The axis and the labelling will be displayed in the color of the first dataset.

YAXIS_SYMBOL_MARKER

1024

The marker symbol will be displayed in front of the axis title.

To set the attributes the following helper functions can be used:

LayerIsYAxisTitleInCurveColor(hLayer)   // YAXIS_AUTOCOLORTITLE
LayerIsYAxisInCurveColor(hLayer)        // YAXIS_AUTOCOLORAXIS
LayerIsAxisShowSymbol(hLayer)           // YAXIS_SHOWSYMBOL
LayerIsYLabelFree_StackedDia(hLayer)    // YAXIS_STACKEDDIA_LABELFREE
LayerIsTitleProtected(hLayer, ssAxis)   // XAXIS_PROTECTTITLE, YAXIS.., ZAXIS...
LayerIsAutoTitle(hLayer, ssAxis)        // XAXIS_AUTOTITLE,...
LayerIsTitleSetOnLoad(hLayer, ssAxis)   // XAXIS_PROTECTTITLE, ..
LayerSetYAxisTitleInCurveColor(hLayer, bool) // YAXIS_AUTOCOLORTITLE
LayerSetYAxisInCurveColor(hLayer, bool) // YAXIS_AUTOCOLORAXIS, ..
LayerSetAutoTitle(hLayer, ssAxis, bool) // XAXIS_AUTOTITLE, ...
LayerSetAxisShowSymbol(hLayer, bool)    // YAXIS_SHOWSYMBOL
IsAxisShowSymbol(hLayer)                // YAXIS_SHOWSYMBOL
LayerGetAxisSymbolID(hLayer)            // YAXIS_SYMBOL_MARKER
LayerSetAxisSymbolID(hLayer, bool)      // YAXIS_SYMBOL_MARKER
LayerSetYLabelFree_StackedDia(hLayer, bool)  // YAXIS_STACKEDDIA_LABELFREE
LayerSetTitleProtected(hLayer, ssAxis, bool) // XAXIS_PROTECTTITLE;

History

Version

Description

R2013.10

Documentation added.

id-307275