GroupPlot::GetModifiers

GetModifiers

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

Description

Get modifiers.

Syntax

int GetModifiers( vector<int> & vnDesigs, vector<string> & saNames, vector<int> & vnIndices )

Parameters

vnDesigs: [output]the property for which the modifier is specified:; COLDESIG_SIZE, symbol size; COLDESIG_COLOR, symbol color from a colormap; COLDESIG_VECTOR_ANGLE, vector plot angle column; COLDESIG_VECTOR_MAGNITUDE, vector plot magnitude column; COLDESIG_VECTOR_XEND, flow vector x-coordinate of the arrow end; COLDESIG_VECTOR_XEND, flow vector y-coordinate of the arrow end; COLDESIG_PLOTLABEL_FORM, label; see PlotDesignationEx in OC_const.h for more options.

saNames: [output]range names of the columns to be used as the modifier from which the dataplot will draw values for the modified property.

vnIndices: [output]plot indices, -1 if all group member share the same dataset

Return

0 if successfully get the modifiers

Examples

EX1

// prepare a group plot graph
void GroupPlot_GetModifier_ex()
{
        GraphLayer gl = Project.ActiveLayer();
        if(!gl)
                return;
        
        GroupPlot gPlot;
        gPlot= gl.Groups(0);
        
        vector<int> vnDesigs;
        vector<string> saNames;
        vector<int> vnIndices;
        gPlot.GetModifiers(vnDesigs, saNames, vnIndices);
}