IlvMarkedPolylineChartDisplayer Class Reference

Class for marked polyline displayers. More...

#include <ilviews/charts/scatter.h>

Inheritance diagram for IlvMarkedPolylineChartDisplayer:

List of all members.

Public Member Functions
	IlvMarkedPolylineChartDisplayer (IlvMarkerType marker=IlvMarkerFilledSquare, IlvDim markerSize=IlvDefaultMarkerSize, IlvPalette *markerPalette=0, IlvPalette *linePalette=0)
	Constructor.
virtual IlvAbstractChartDisplayer *	copy () const
	Virtual copy constructor.
IlvColor *	getLineBackground () const
	Returns the background color used to display the lines.
IlvPolylineChartDisplayer *	getLineDisplayer () const
	Returns the polyline displayer that composes the current displayer.
IlvColor *	getLineForeground () const
	Returns the foreground color used to display the lines.
IlvPalette *	getLinePalette () const
	Returns the palette used to display the lines.
IlvColor *	getMarkerBackground () const
	Returns the background color used to display the markers.
IlvScatterChartDisplayer *	getMarkerDisplayer () const
	Returns the scatter displayer that composes the current displayer.
IlvColor *	getMarkerForeground () const
	Returns the foreground color used to display the markers.
IlvPalette *	getMarkerPalette () const
	Returns the palette used to display the markers.
IlBoolean	isLineVisible () const
	Indicates whether the lines are shown.
IlBoolean	isMarkerVisible () const
	Indicates whether the markers are shown.
virtual void	setLegendItems (IlvChartLegend *legend) const
	Sets the legend items associated with the current displayer.
void	setLineBackground (IlvColor *color)
	Sets the background color used to display the lines.
void	setLineForeground (IlvColor *color)
	Sets the foreground color used to display the lines.
void	setLinePalette (IlvPalette *pal)
	Sets the palette used to display the lines.
void	setLineVisible (IlBoolean visible)
	Specifies whether the lines have to be shown.
void	setMarkerBackground (IlvColor *color)
	Sets the background color used to display the markers.
void	setMarkerForeground (IlvColor *color)
	Sets the foreground color used to display the markers.
void	setMarkerPalette (IlvPalette *pal)
	Sets the palette used to display the markers.
void	setMarkerVisible (IlBoolean visible)
	Specifies whether the markers have to be shown.
virtual void	write (IlvOutputFile &) const
	Writes the attributes of the current object in a file.
Protected Member Functions
virtual IlvAbstractChartDisplayer *	createDisplayer (IlUInt index, IlvPalette *=0)
	Defines the child displayers that will be created by default to compose the current displayer.
virtual void	updateDisplayers ()
	Updates the displayers that compose the current displayer.

---

Detailed Description

Class for marked polyline displayers.

Library: ilvcharts

This class is a subclass of IlvCompositeChartDisplayer which allows you to represent data with both polylines and markers.

The marked polyline displayer is a composite displayer that is simply composed of a polyline displayer (see the IlvPolylineChartDisplayer class) and a scatter displayer (see the IlvScatterChartDisplayer class).

The marked polyline displayer displays a unique data set. This displayer can be used with any type of projection. (See the IlvAbstractProjector class for more details.)

The following images show data sets represented with marked polyline displayers in a Cartesian chart (on the left) and a polar chart (on the right).

See also:

IlvCompositeChartDisplayer, IlvPolylineChartDisplayer, IlvScatterChartDisplayer.

---

Constructor & Destructor Documentation

IlvMarkedPolylineChartDisplayer::IlvMarkedPolylineChartDisplayer	(	IlvMarkerType	marker = IlvMarkerFilledSquare,
		IlvDim	markerSize = IlvDefaultMarkerSize,
		IlvPalette *	markerPalette = 0,
		IlvPalette *	linePalette = 0
	)

Constructor.

Initializes a new IlvMarkedPolylineChartDisplayer object. The constructor creates the polyline and scatter displayers that compose the current composite displayer by calling the IlvCompositeChartDisplayer::initDisplayers method.

Parameters:

	marker	The type of the markers that will be used to represent the data.
	markerSize	The size of the markers.
	markerPalette	The palette that will be used to display the markers.
	linePalette	The palette that will be used to display the lines.

---

Member Function Documentation

virtual IlvAbstractChartDisplayer* IlvMarkedPolylineChartDisplayer::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.

virtual IlvAbstractChartDisplayer* IlvMarkedPolylineChartDisplayer::createDisplayer	(	IlUInt	index,
		IlvPalette *	= 0
	)			[protected, virtual]

Defines the child displayers that will be created by default to compose the current displayer.

This method creates an instance of IlvPolylineChartDisplayer if index is equal to 0 and an instance of IlvScatterChartDisplayer if index is equal to 1. See the IlvCompositeChartDisplayer::createDisplayer method for more details.

Parameters:

	index	The index at which the created displayer will be added later to the collection of displayers that compose the current displayer.
	palette	The palette that will be used by the new displayer.

Reimplemented from IlvCompositeChartDisplayer.

IlvColor* IlvMarkedPolylineChartDisplayer::getLineBackground

(

)

const

Returns the background color used to display the lines.

Returns:

A pointer to the background color used to display the lines.

IlvPolylineChartDisplayer* IlvMarkedPolylineChartDisplayer::getLineDisplayer

(

)

const

Returns the polyline displayer that composes the current displayer.

Returns:

A pointer to the polyline displayer that composes the current displayer.

IlvColor* IlvMarkedPolylineChartDisplayer::getLineForeground

(

)

const

Returns the foreground color used to display the lines.

Returns:

A pointer to the foreground color used to display the lines.

IlvPalette* IlvMarkedPolylineChartDisplayer::getLinePalette

(

)

const

Returns the palette used to display the lines.

Returns:

A pointer to the palette used to display the lines.

IlvColor* IlvMarkedPolylineChartDisplayer::getMarkerBackground

(

)

const

Returns the background color used to display the markers.

Returns:

A pointer to the background color used to display the markers.

IlvScatterChartDisplayer* IlvMarkedPolylineChartDisplayer::getMarkerDisplayer

(

)

const

Returns the scatter displayer that composes the current displayer.

Returns:

A pointer to the scatter displayer that composes the current displayer.

IlvColor* IlvMarkedPolylineChartDisplayer::getMarkerForeground

(

)

const

Returns the foreground color used to display the markers.

Returns:

A pointer to the foreground color used to display the markers.

IlvPalette* IlvMarkedPolylineChartDisplayer::getMarkerPalette

(

)

const

Returns the palette used to display the markers.

Returns:

A pointer to the palette used to display the markers.

IlBoolean IlvMarkedPolylineChartDisplayer::isLineVisible

(

)

const

Indicates whether the lines are shown.

Returns:

IlTrue if the lines are shown and IlFalse otherwise.

IlBoolean IlvMarkedPolylineChartDisplayer::isMarkerVisible

(

)

const

Indicates whether the markers are shown.

Returns:

IlTrue if the markers are shown and IlFalse otherwise.

virtual void IlvMarkedPolylineChartDisplayer::setLegendItems

(

IlvChartLegend *

legend

)

const [virtual]

Sets the legend items associated with the current displayer.

Sets the legend items associated with the current displayer on the legend legend.

The current implementation simply calls the IlvChartLegend::addLegendItem method once if the current displayer can be viewed. (See the IlvAbstractChartDisplayer::isViewable method.)

See the IlvAbstractChartDisplayer::setLegendItems method for more details.

Parameters:

legend

The legend that will display the legend items associated with the current displayer.

Reimplemented from IlvCompositeChartDisplayer.

void IlvMarkedPolylineChartDisplayer::setLineBackground

(

IlvColor *

color

)

Sets the background color used to display the lines.

Parameters:

color

The new background color used to display the lines.

void IlvMarkedPolylineChartDisplayer::setLineForeground

(

IlvColor *

color

)

Sets the foreground color used to display the lines.

Parameters:

color

The new foreground color used to display the lines.

void IlvMarkedPolylineChartDisplayer::setLinePalette

(

IlvPalette *

pal

)

Sets the palette used to display the lines.

The old palette, if one exists, is unlocked and the new palette is locked. (See the methods IlvResource::lock and IlvResource::unLock for more details.)

Parameters:

pal

The new palette that is used to display the lines.

void IlvMarkedPolylineChartDisplayer::setLineVisible

(

IlBoolean

visible

)

Specifies whether the lines have to be shown.

Parameters:

visible

The new value of the Boolean indicating whether the lines are shown.

void IlvMarkedPolylineChartDisplayer::setMarkerBackground

(

IlvColor *

color

)

Sets the background color used to display the markers.

Parameters:

color

The new background color used to display the markers.

void IlvMarkedPolylineChartDisplayer::setMarkerForeground

(

IlvColor *

color

)

Sets the foreground color used to display the markers.

Parameters:

color

The new foreground color used to display the markers.

void IlvMarkedPolylineChartDisplayer::setMarkerPalette

(

IlvPalette *

pal

)

Sets the palette used to display the markers.

The old palette, if one exists, is unlocked and the new palette is locked. (See the methods IlvResource::lock and IlvResource::unLock for more details.)

Parameters:

pal

The new palette that is used to display the markers.

void IlvMarkedPolylineChartDisplayer::setMarkerVisible

(

IlBoolean

visible

)

Specifies whether the markers have to be shown.

Parameters:

visible

The new value of the Boolean indicating whether the markers are shown.

virtual void IlvMarkedPolylineChartDisplayer::updateDisplayers

(

)

[protected, virtual]

Updates the displayers that compose the current displayer.

This method simply sets the data set used by the current displayer on the child displayers that compose the current displayer (that is the polyline and the scatter displayers). The data set that is set is the one returned by the IlvAbstractChartDisplayer::getDataSet method.

See the IlvCompositeChartDisplayer::updateDisplayers method for more details.

Reimplemented from IlvCompositeChartDisplayer.

virtual void IlvMarkedPolylineChartDisplayer::write

(

IlvOutputFile &

file

)

const [virtual]

Writes the attributes of the current object in a file.

Called by the IlvAbstractChartDisplayer::save method. This method can be overloaded in subclasses that define new attributes. The information written by the write method is read by the IO constructor, which takes an IlvInputFile as its only argument. Both this method and the IO constructor can be automatically declared by using the DeclareChartDisplayerTypeInfo macro within the class declaration.

Parameters:

file

The file where the attributes of the current object are written.

Reimplemented from IlvCompositeChartDisplayer.