ILNumerics Ultimate VS

Legend Constructor (String)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Create legend object for any suitable plot object in the plot cube; provide label text for all items

[ILNumerics Visualization Engine]

Namespace:  ILNumerics.Drawing.Plotting
Assembly:  ILNumerics.Drawing (in ILNumerics.Drawing.dll) Version: ILNumerics Ultimate VS 4
Syntax

public Legend(
	params string[] labels
)

Parameters

labels
Type: SystemString
item label text strings
Remarks

The number of created items depends on the number of elements in labels and the number of plot objects found in the plot cube. The iteration of suitable plot objects in the plot cube is walked. Every object gets a new legend item associated to with the label text given by the corresponding element in labels. If the corresponding element in labels is null, the Tag property of the plot object is used as label text instead.

The iteration of suitable plot objects is acquired from the subtree of that plot cube in the scene, where this legend object is contained within at time of rendering. If the number of suitable objects found is n, the number of legend items created is min(labels.Count, n). If labels is string[0] (empty array) no items are created. If labels is null, items for all suitable objects are created.

Not all plot objects are suitable objects for display in a legend. Examples of suitable objects are line plots and contour plots.

[ILNumerics Visualization Engine]

See Also

Reference