DataPlot::GetStackOffsetValues

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 header to Included

Description

Get stack offset values for data plot.

Syntax

int GetStackOffsetValues( vector & vOffsets, int nDesig = COLDESIG_Y )

Parameters

vOffsets: [output]offset values
nDesig: [input]Designation of offset

Return

StackOffsetValues_None if no offset exist.

StackOffsetValues_Scalar if single fixed offset value, in vOffsets[0]

StackOffsetValues_Vector if exists offset value for every points.

Examples

void GetStackOffsetValues_ex()
{
        GraphLayer gl = Project.ActiveLayer();
        if(!gl)
                return;
        DataPlot dp = gl.DataPlots();
        if(!dp)
                return;
        
        vector vOffsets;
        int nRet = dp.GetStackOffsetValues(vOffsets, COLDESIG_Y);
        switch(nRet)
        {
        case StackOffsetValues_None:
                out_str("no offset");
                break;
                
        case StackOffsetValues_Scalar:
                out_double("offset=", vOffsets[0]);
                break;
                
        case StackOffsetValues_Vector:
                int nSize = vOffsets.GetSize();
                out_double("first point's offset=", vOffsets[0]);
                out_double("last point's offset=", vOffsets[nSize-1]);
                break;
                
        default:
                break;
        }
}