DataPlot::SetSymbol

Description

Set data plot symbol based by index of one in the symbol gallery.

Syntax

BOOL SetSymbol( int nIndex, BOOL bUndo = FALSE )

Parameters

nIndex
[input] An Integer value which is the index of the symbol for this DataPlot.
bUndo
[input] if bUndo is true, you can use Ctrl + Z to undo SetSymbol.

Return

TRUE for success, otherwise FALSE.

Examples

void DataPlot_SetGetSymbol_Ex1()
{
        //make sure there exists a graph with dataplots on it before running this code.
        GraphLayer gl = Project.ActiveLayer();
        if ( gl )
        {
                DataPlot dp = gl.DataPlots(0); //get the first dataplot on graphlayer
                if ( dp )
                {
                        if ( dp.SetSymbol(11) ) //set symbol as solid circle
                        {
                                printf("SetSymbol change DataPlot symbol to " + dp.GetSymbol()); 
                        }
                }
        }
}

Remark

See Also

DataPlot::GetSymbol

Header to Include

origin.h