TiPlotChannelCustom.DataCursorStatus

TiPlotChannelCustom

Retrieves the status of the data point being accessed by the Data Cursor assigned to this channel.

type TiPlotDataPointStatus= (ipdpsValid, ipdpsNull, ipdpsEmpty);

property DataCursorStatus : TiPlotDataPointStatus;

Description

Use DataCursorStatus to get the status of the Data Point being accessed by the current Data Cursor assigned to this channel. The status refers to whether the data point is a valid data point, a null data point, or an empty data point.

This is useful because if you access the DataCursorXValue, DataCursorYValue, DataCursorXString, and/or DataCursorYString properties, it may not be apparent if the value being returned is a valid value or not.

These are the possible values:

Value
Meaning
ipdpsValid
The data point contains a valid X and Y coordinate value.
ipdpsNull
The data point is a null data point.
ipdpsEmpty
The data point is an empty data point. In the iPlot component, this means that the data point has an X-Value, but no Y-Value.

Example

Delphi

Value := iComponent.Channel[0].DataCursorStatus;

C++ Builder

Value = iComponent->Channel[0]->DataCursorStatus;

Contents | Index | Previous | Next