LayerSetPolarConfig

LayerSetPolarConfig set the polar diagram configuration.

bool = LayerSetPolarConfig(hLayer, rvConfig)

Return Value

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

Parameters

hLayer

Identifies the layer.

rvConfig

rvConfig is a real vector with six elements:

Value Meaning
rvConfig[1] nAttrib: OR-Combination of display attributes, see next table.
rvConfig[2] nDrawToCenterFreq
rvConfig[3] nDrawToCenterOffsetMajor
rvConfig[4] nDrawToCenterOffsetMinor
rvConfig[5] wMinRadius: Inside radius in centimeters.
rvConfig[6] dAngleOffset: Angle offset against 0 degrees at 3 o’clock.
nAttrib

nAttrib is an OR combination of the following values:

Value Meaning
POLAR_RAD_LABEL_OPAQUE (1) Draw radius label opaque.
POLAR_ANGLE_LABEL_OPAQUE (2) Draw angle label opaque.
POLAR_ANGLE_LABEL_GRADIENT (4) Draw angle label in the spoke angle.
POLAR_CLOCKWISE (8) Angle clock wise (default is counter clock wise).

Example

To set only one element:

rvConfig = LayerGetPolarConfig(hLayer);
rvConfig[6] = -90.0;
LayerSetPolarConfig(hLayer, rvConfig);

or

rvConfig = LayerGetPolarConfig(hLayer);
rvConfig[1] = rvConfig[1] | POLAR_CLOCKWISE | POLAR_ANGLE_LABEL_GRADIENT;
LayerSetPolarConfig(hLayer, rvConfig);

To set all elements:

rvConfig = [POLAR_CLOCKWISE | POLAR_ANGLE_LABEL_GRADIENT, 1, 2, 3, 1.0, -90]
LayerSetPolarConfig(hLayer, rvConfig);

History

Version Description
5.0.0 New

id-244918