2.2.4.38.34 Project::GetPlotDesignations

Description

Given a plot type, like IDM_PLOT_LINE, return an array of integers containing all possible column plot designations.

Syntax

BOOL GetPlotDesignations( int nPlotType, DWORD dwAuxTypeInfo, LPCTSTR lpcszColPattern, vector<uint> & vplotdesig )

Parameters

nPlotType
[input] the plot type, general plot ID, can be more then the internal basic plot type id
dwAuxTypeInfo
[input] cntrl info about the internal details of the plot type
lpcszColPattern
[input] internal pattern to represent the col designations
vplotdesig
[output] the array integers from the following enumeration:
enum {
COLDESIG_X = 1,
COLDESIG_Y,
COLDESIG_Z,
COLDESIG_LABEL,
COLDESIG_XERROR,
COLDESIG_YERROR,
COLDESIG_YPLUSERROR,
COLDESIG_YMINUSERROR,
COLDESIG_SIZE, // for symbol size in bubble plots
COLDESIG_COLOR, // for symbol color in scatter color plots
COLDESIG_VECTOR_ANGLE, // for vector XYAM plots
COLDESIG_VECTOR_MAGNITUDE // for vector XYAM plots
};

Return

TURE if success, FALSE if nPlotType is invalid or inconsistent with other arguments

Examples

EX1

void Project_GetPlotDesignations_ex1()
{
    DWORD dwAuxTypeInfo;
    DWORD dwAuxPlotInfo;
    string strColPattern;
    
    int nPlotID = IDM_PLOT_LINE;
    int nRet = Project.GetPlotTypeInfo(nPlotID,dwAuxTypeInfo,dwAuxPlotInfo,strColPattern);
    
    vector<uint> vplotdesig;
    BOOL bRet = Project.GetPlotDesignations(nPlotID, dwAuxTypeInfo, strColPattern, vplotdesig);                
}

Remark

See Also

Project::GetPlotTypeInfo

Header to Include

origin.h