Updates the given chart with the specified clusters.

Namespace:  CenterSpace.NMath.Charting.Microsoft
Assembly:  NMathStatsChartMicrosoft (in NMathStatsChartMicrosoft.dll) Version: 3.4.0.0

Syntax

C#
public static void Update(
	ref Chart chart,
	ClusterSet clusters,
	DoubleMatrix data,
	int xColIndex,
	int yColIndex
)
Visual Basic (Declaration)
Public Shared Sub Update ( _
	ByRef chart As Chart, _
	clusters As ClusterSet, _
	data As DoubleMatrix, _
	xColIndex As Integer, _
	yColIndex As Integer _
)
Visual C++
public:
static void Update(
	Chart^% chart, 
	ClusterSet^ clusters, 
	DoubleMatrix^ data, 
	int xColIndex, 
	int yColIndex
)

Parameters

chart
Type: Chart %
A chart.
clusters
Type: CenterSpace.NMath.Stats..::.ClusterSet
The cluster assignments.
data
Type: CenterSpace.NMath.Core..::.DoubleMatrix
A matrix of data. Each row in the matrix represents an object that was clustered.
xColIndex
Type: System..::.Int32
The index of the matrix column containing the x data.
yColIndex
Type: System..::.Int32
The index of the matrix column containing the y data.

Remarks

Instances of class ClusterSet are created by ClusterAnalysis, KMeanClustering, and NMFClustering objects and cannot be constructed independently.
Objects are shown plotted in the specified x,y plane, and colored according to their cluster assignment.
A new, default ChartArea is added if one does not exist, otherwise chart.ChartAreas[0] is used. Axis titles, and DefaultAxisTitleFont and DefaultMajorGridLineColor, only have an effect if a new ChartArea is added.
Titles are added only if chart does not currently contain any titles.
The first clusters.NumberOfClusters data series are replaced, or added if necessary.

Exceptions

ExceptionCondition
CenterSpace.NMath.Core..::.IndexOutOfRangeExceptionThrown if either column index is outside the range of the columns of the given data matrix.

See Also