Visit Gigasoft's Web Site
 ProEssentials v9 Help

SubsetsToLegend

Scope

Pego, Pesgo, Pe3do, Pepso

Type

Property Array of type Int32

Default

empty

.NET

PeLegend.SubsetsToLegend

Ocx|Vcl

SubsetsToLegend

DLL

PEP_naSUBSETSTOLEGEND

 

Purpose

This property array stores zero-based subset indices which represent subsets to legend. If this property array is empty, all subsets have legends.

 

For example: to show only the 1st, 3d and 5th subsets.

Pego1.SubsetsToLegend(0) = 0 ' 0 means zero based first subset

Pego1.SubsetsToLegend(1) = 2 ' 2 means zero based 3rd subset

Pego1.SubsetsToLegend(2) = 4 ' 4 means zero based 5th subset

 

Comments

PeLegend.SubsetsToLegend members of Pego.PeLegend, Pesgo.PeLegend, Pe3do.PeLegend, Pepso.PeLegend

 

See example 033 in the demo for more info.

 

Subset legends show a subset label along with a graphic helping distinguish multiple subsets from each other. See SubsetLabels, SubsetLineTypes, SubsetPointTypes, SubsetColors

 

You can prevent all subset legends by assigning (-1) to element zero as follows: Or easier, set ShowLegend = False

.NET: Pego1.PeLegend.SubsetsToLegend(0) = -1

 

Active: Pego1.SubsetsToLegend(0) = -1

 

SDK/DLL:

int nNoLegends = -1;

PEvset(hPE, PEP_naSUBSETSTOLEGEND, &nNoLegends, 1);

 

You can empty this array and show all legends as follows:

.NET: Pego1.PeLegend.SubsetsToLegend.Clear()

 

ActiveX: Pego1.SubsetsToLegend(-1) = 0

 

SDK/DLL: PEvset (hWndPE, PEP_naSUBSETSTOLEGEND, nArray, 0)

 

You can force a subset legend when Subsets = 1 by assigning (0) to element zero.

.NET: Pego1.PeLegend.SubsetsToLegend(0) = 0

 

Active: Pego1.SubsetsToLegend(0) = 0

 

SDK/DLL:

int nNoLegends = 0;

PEvset(hPE, PEP_naSUBSETSTOLEGEND, &nNoLegends, 1);

 

LegendAnnotationType can be used to add legends that represent annotations.

 

For more information, see Chapter 7, Question 9.

 

See Also: ShowLegend