IlvStacked100ChartDataSet Class Reference

Class defining a data set representing the percentage of a data set relative to the sum of the data sets. More...

#include <ilviews/charts/data.h>

Inheritance diagram for IlvStacked100ChartDataSet:

List of all members.

Public Member Functions
virtual void	getPoint (IlUInt i, IlvDoublePoint &point) const
	Returns a represented data point.
virtual IlBoolean	retrieveDataSetPoint (IlvChartDataSet *&dataSet, IlUInt ptidx, const IlvDoublePoint &point, IlUInt &dataSetPtIndex, IlvDoublePoint &dataSetPt) const
	Retrieves from a data point of the current combined data set the corresponding data point of a component data set.

---

Detailed Description

Class defining a data set representing the percentage of a data set relative to the sum of the data sets.

Library: ilvcharts

This class is a subclass of IlvCombinedChartDataSet that allows you to define a stacked-100-data-set. This type of data set is computed for a given real data set that is part of a set of real data sets. The values of the stacked-100-data-set correspond to the percentage represented by each data value of the given data set relative to the total across the set of real data sets.

This type of data set is used by the stacked displayers to put the data to be displayed into a format that the displayer can display. See the IlvStackedChartDisplayer class to have more information.

The following example illustrates a stacked-100-data-set. The real data sets that make up the stacked-100-data-set are shown in the left column and the stacked-100-data-set that is constructed from these data sets is shown in the right column. The percentages are computed for the first real data set, but they can be computed for each real data set that makes up the stacked-100-data-set.

Data-set-1	Stacked-100-data-set
(0, 0.7)	(0, 35)
(1, 0.6)	(1, 40)
(2, 0.9)	(2, 37.5)
Data-set-2	-
(0, 1.3)	-
(1, 0.9)	-
(2, 1.5)	-

See also:

IlvCombinedChartDataSet, IlvStackedChartDisplayer.

---

Member Function Documentation

virtual void IlvStacked100ChartDataSet::getPoint	(	IlUInt	i,
		IlvDoublePoint &	point
	)			const [virtual]

Returns a represented data point.

Parameters:

	i	The index of the returned data point.
	point	The returned data point.

Implements IlvChartDataSet.

virtual IlBoolean IlvStacked100ChartDataSet::retrieveDataSetPoint	(	IlvChartDataSet *&	dataSet,
		IlUInt	ptidx,
		const IlvDoublePoint &	point,
		IlUInt &	dataSetPointIndex,
		IlvDoublePoint &	dataSetPoint
	)			const [virtual]

Retrieves from a data point of the current combined data set the corresponding data point of a component data set.

Warning:

[note] If no data set is specified (dataSet is equal to 0), dataSet is set to a default data set which is one of the data sets that make up the current combined data set.

Parameters:

	dataSet	The component data set for which we want to retrieve a data point. This data set is one of the data sets that make up the current combined data set.
	ptidx	The index of the data point of the current combined data set from which we want to retrieve the corresponding point in dataSet.
	point	The point of the current combined data set from which we want to retrieve the corresponding point in dataSet.
	dataSetPointIndex	The index of the retrieved point in the data set dataSet.
	dataSetPoint	The retrieved point in the data set dataSet.

Returns:

IlTrue if the data point has been successfully retrieved and IlFalse otherwise.

Implements IlvCombinedChartDataSet.