IlvSideBySideChartDisplayer Class Reference

Base class for adjacent data displayers. More...

#include <ilviews/charts/sidebyside.h>

Inheritance diagram for IlvSideBySideChartDisplayer:

List of all members.

Public Member Functions
	IlvSideBySideChartDisplayer (IlvChartDisplayerFactory *factory, IlUInt count, IlvPalette *const *palettes=0)
	Constructor.
	IlvSideBySideChartDisplayer (IlvAbstractChartDisplayer *model, IlUInt count, IlvPalette *const *palettes=0)
	Constructor.
	IlvSideBySideChartDisplayer ()
	Constructor.
virtual IlvAbstractChartDisplayer *	copy () const
	Virtual copy constructor.
Protected Member Functions
virtual void	dataSetRemoved (IlUInt index)
	Performs the updates needed when a real data set is removed.
virtual void	updateDisplayers ()
	Updates the displayers that compose the current displayer.

---

Detailed Description

Base class for adjacent data displayers.

Library: ilvcharts

This class is a subclass of IlvCompositeChartDisplayer. This class is the base class for displayers representing data side by side. One subclass is provided that defines the child displayers that are created by default: IlvSideBySideBarChartDisplayer that displays bars side by side.

The side-by-side displayers display as many data sets as you want. The data items of the first data set are represented first. The data items of the second data set are represented by the side of the data items of the first data set. The data items of the third data set are represented by the side of the data items of the second data set and so on. The side-by-side displayers can be used with any type of projection. (See the IlvAbstractProjector class for more details.)

See also:

IlvCompositeChartDisplayer, IlvSideBySideBarChartDisplayer.

---

Constructor & Destructor Documentation

IlvSideBySideChartDisplayer::IlvSideBySideChartDisplayer

(

)

Constructor.

Initializes a new IlvSideBySideChartDisplayer object.

IlvSideBySideChartDisplayer::IlvSideBySideChartDisplayer	(	IlvAbstractChartDisplayer *	model,
		IlUInt	count,
		IlvPalette *const *	palettes = 0
	)

Constructor.

Initializes a new IlvSideBySideChartDisplayer object with count child displayers.

Parameters:

	model	The displayer model that will be used to create the child displayers.
	count	The number of child displayers that are created.
	palettes	The palettes that will be used by the created child displayers. If a valid array of palettes is provided, its size must match count.

See also:

IlvCompositeChartDisplayer::setDisplayerModel.

IlvSideBySideChartDisplayer::IlvSideBySideChartDisplayer	(	IlvChartDisplayerFactory *	factory,
		IlUInt	count,
		IlvPalette *const *	palettes = 0
	)

Constructor.

Initializes a new IlvSideBySideChartDisplayer object with count child displayers.

Parameters:

	factory	The displayer factory that will be used to create the child displayers.
	count	The number of child displayers that are created.
	palettes	The palettes that will be used by the created child displayers. If a valid array of palettes is provided, its size must match count.

See also:

IlvChartDisplayerFactory, IlvCompositeChartDisplayer::setDisplayerFactory.

---

Member Function Documentation

virtual IlvAbstractChartDisplayer* IlvSideBySideChartDisplayer::copy

(

)

const [virtual]

Virtual copy constructor.

Creates and returns a copy of the current object. This method must be overloaded in subclasses. It is automatically declared by the DeclareChartDisplayerTypeInfo macro. The IlvPredefinedChartDisplayerIOMembers macro lets you define a default implementation, which returns an instance initialized with the copy constructor.

Returns:

A copy of the current object.

Implements IlvAbstractChartDisplayer.

Reimplemented in IlvSideBySideBarChartDisplayer.

virtual void IlvSideBySideChartDisplayer::dataSetRemoved

(

IlUInt

index

)

[protected, virtual]

Performs the updates needed when a real data set is removed.

This method removes the child displayer at the index index and then calls the IlvCompositeChartDisplayer::dataSetRemoved method.

Parameters:

index

The index of the removed data set.

Reimplemented from IlvAbstractChartDisplayer.

virtual void IlvSideBySideChartDisplayer::updateDisplayers

(

)

[protected, virtual]

Updates the displayers that compose the current displayer.

This method first calls the IlvCompositeChartDisplayer::updateDisplayers method and then sets the shift offset for each child displayer so that the child displayers can be displayed side by side. See the IlvSingleChartDisplayer::setShiftOffset and the IlvCompositeChartDisplayer::updateDisplayers methods for more details.

Reimplemented from IlvCompositeChartDisplayer.