Class for marked polyline displayers. More...

#include <ilviews/charts/scatter.h>

Inheritance diagram for IlvMarkedPolylineChartDisplayer:

Public Member Functions
	IlvMarkedPolylineChartDisplayer (IlvMarkerType marker=IlvMarkerFilledSquare, IlvDim markerSize=IlvDefaultMarkerSize, IlvPalette markerPalette=0, IlvPalette linePalette=0)
	Constructor. More...

IlvColor *	getLineBackground () const
	Returns the background color used to display the lines. More...

IlvPolylineChartDisplayer *	getLineDisplayer () const
	Returns the polyline displayer that composes the current displayer. More...

IlvColor *	getLineForeground () const
	Returns the foreground color used to display the lines. More...

IlvPalette *	getLinePalette () const
	Returns the palette used to display the lines. More...

IlvColor *	getMarkerBackground () const
	Returns the background color used to display the markers. More...

IlvScatterChartDisplayer *	getMarkerDisplayer () const
	Returns the scatter displayer that composes the current displayer. More...

IlvColor *	getMarkerForeground () const
	Returns the foreground color used to display the markers. More...

IlvPalette *	getMarkerPalette () const
	Returns the palette used to display the markers. More...

IlBoolean	isLineVisible () const
	Indicates whether the lines are shown. More...

IlBoolean	isMarkerVisible () const
	Indicates whether the markers are shown. More...

virtual void	setLegendItems (IlvChartLegend *legend) const
	Sets the legend items associated with the current displayer. More...

void	setLineBackground (IlvColor *color)
	Sets the background color used to display the lines. More...

void	setLineForeground (IlvColor *color)
	Sets the foreground color used to display the lines. More...

void	setLinePalette (IlvPalette *pal)
	Sets the palette used to display the lines. More...

void	setLineVisible (IlBoolean visible)
	Specifies whether the lines have to be shown. More...

void	setMarkerBackground (IlvColor *color)
	Sets the background color used to display the markers. More...

void	setMarkerForeground (IlvColor *color)
	Sets the foreground color used to display the markers. More...

void	setMarkerPalette (IlvPalette *pal)
	Sets the palette used to display the markers. More...

void	setMarkerVisible (IlBoolean visible)
	Specifies whether the markers have to be shown. More...

Public Member Functions inherited from IlvCompositeChartDisplayer
virtual	~IlvCompositeChartDisplayer ()
	Destructor. More...

void	addDisplayer (IlvAbstractChartDisplayer *displayer, IlUInt position=IlvLastPositionIndex)
	Adds a displayer to the current displayer. More...

virtual IlBoolean	boundingBox (IlvRect &bbox, const IlvTransformer *t=0) const
	Returns the bounding box of the graphical representation of data. More...

virtual IlBoolean	dataPointBBox (IlUInt dataPtIdx, IlvRect &bbox, IlBoolean takeInfoIntoAccount, const IlvTransformer *t=0) const
	Returns the bounding box of the graphical representation of the data points at a given index. More...

virtual void	draw (IlvPort dst, const IlvTransformer t=0, const IlvRegion *clip=0) const
	Draws the graphical representation of data. More...

virtual void	drawDataPoint (IlUInt dataPtIdx, IlvPort dst, const IlvTransformer t=0, const IlvRegion *clip=0) const
	Draws the graphical representation of the data point(s) at a given index. More...

virtual void	drawDataPoints (IlUInt iMin, IlUInt iMax, IlvPort dst, const IlvTransformer t=0, const IlvRegion *clip=0) const
	Draws the graphical representation of the data points between a given interval. More...

virtual void	drawFill (IlBoolean b)
	Sets the filling mode of the displayer. More...

virtual void	drawLegendItem (IlvPort dst, const IlvRect &legendArea, IlvPalette itemPal, const IlvRegion *clip, IlAny clientData=0) const
	Draws the graphic part of a legend item associated with the current displayer. More...

virtual IlvColor *	getBackground (IlUInt index=0) const
	Returns the background color of a palette used by the current displayer to display data. More...

virtual void	getClipArea (IlvRect &area, const IlvTransformer *t) const
	Returns the clipping region that is used for the drawing. More...

IlvAbstractChartDisplayer *	getDisplayer (IlUInt index) const
	Returns one of the displayers that compose the current displayer. More...

IlvChartDisplayerFactory *	getDisplayerFactory () const
	Returns the displayer factory that has been set on the current displayer. More...

virtual IlvAbstractChartDisplayer *	getDisplayerForDataSet (const IlvChartDataSet *dataSet) const
	Returns the child displayer used to display a given data set. More...

IlvAbstractChartDisplayer *	getDisplayerModel () const
	Returns the model that is used for child displayers. More...

virtual IlUInt	getDisplayersCount () const
	Returns the number of displayers. More...

virtual IlUInt	getDisplayItem (IlvChartDataSet &dataSet, const IlvPoint &viewPoint, const IlvTransformer t) const
	Returns the item to which a view point corresponds. More...

virtual IlBoolean	getDisplayPoint (const IlvChartDataSet dataSet, IlUInt dataPtIdx, IlvPoint &point, const IlvTransformer t=0) const
	Returns the corresponding screen point for a data point. More...

virtual IlvColor *	getForeground (IlUInt index=0) const
	Returns the foreground color of a palette used by the current displayer to display data. More...

virtual const char *	getInternalLegendText (IlUInt index=0) const
	Returns the legend text stored in the current displayer. More...

virtual const char *	getLegendText (IlUInt index=0) const
	Returns the text that will be used in a legend for the current displayer. More...

virtual IlUInt	getNearestPoint (IlvChartDataSet &dataSet, const IlvPoint &viewPoint, IlvDim distance, IlvPoint &point, const IlvTransformer t=0) const
	Returns the nearest data point. More...

virtual IlvPalette *	getPalette (IlUInt index=0) const
	Returns a palette used by the current displayer to display data. More...

virtual IlvPointInfoCollection *	getPointInfoCollection (const IlvChartDataSet *dataSet) const
	Returns the point information collection defined to be used to display a given data set. More...

virtual IlBoolean	graphicalRepresentationByDataPoint () const
	Indicates whether there is a graphical representation by data point. More...

virtual IlBoolean	isContinuous () const
	Indicates whether the graphical representation is continuous. More...

virtual IlBoolean	isFilled () const
	Indicates whether the graphical representation is filled. More...

virtual IlBoolean	isViewable () const
	Indicates whether the graphical representation can be viewed. More...

IlvAbstractChartDisplayer *	removeDisplayer (IlUInt index)
	Removes one of the displayers that compose the current displayer. More...

virtual void	setBackground (IlvColor *color, IlUInt index=0)
	Sets the background color of a palette used by the current displayer to display data. More...

virtual void	setChartGraphic (IlvChartGraphic *chart)
	Sets the chart graphic which uses the current displayer. More...

virtual IlBoolean	setDataPoint (IlvChartDataSet dataSet, IlUInt dataPtIdx, const IlvPoint &point, const IlvTransformer t=0) const
	Sets the corresponding data point from a screen point. More...

IlvChartDisplayerFactory *	setDisplayerFactory (IlvChartDisplayerFactory *factory, IlBoolean reCreate=IlFalse)
	Sets the displayer factory that will be used by the current displayer. More...

IlvAbstractChartDisplayer *	setDisplayerModel (IlvAbstractChartDisplayer *model)
	Sets the model that will be used when creating child displayers. More...

virtual void	setForeground (IlvColor *color, IlUInt index=0)
	Sets the foreground color of a palette used by the current displayer to display data. More...

virtual void	setLegendText (const char *text, IlUInt index=0)
	Sets the text that will be used in a legend for the current displayer. More...

virtual void	setMode (IlvDrawMode mode)
	Sets the drawing mode. More...

virtual void	setOrdinateInfo (IlvCoordinateInfo *ordinateInfo)
	Sets the coordinate information associated with the ordinate scale considered to display data. More...

virtual void	setOverwrite (IlBoolean o)
	Sets the overwrite mode. More...

virtual void	setPalette (IlvPalette *pal, IlUInt index=0)
	Sets a palette used by the current displayer to display data. More...

virtual void	setPointInfoCollection (const IlvChartDataSet dataSet, IlvPointInfoCollection ptInfoCollection)
	Sets the point information collection that will be used to display a given data set. More...

virtual void	write (IlvOutputFile &file) const
	Writes the attributes of the current object in a file. More...

Public Member Functions inherited from IlvAbstractChartDisplayer
virtual	~IlvAbstractChartDisplayer ()
	Destructor. More...

void	addDataSet (IlvChartDataSet *dataSet)
	Adds a real data set to be displayed by the current displayer. More...

virtual IlBoolean	canBeProjectedIfOutOfBounds () const
	Indicates whether the graphical representation can be projected when it is out-of-bounds. More...

virtual IlvAbstractChartDisplayer *	copy () const =0
	Virtual copy constructor. More...

IlBoolean	dataPointToDisplay (const IlvDoublePoint &dataPoint, IlvPoint &point, const IlvTransformer *t=0) const
	Projects a data point into screen coordinates. More...

virtual IlBoolean	displayDataSet (const IlvChartDataSet *dataSet) const
	Indicates whether the current displayer displays a data set. More...

IlBoolean	displayToDataPoint (const IlvPoint &point, IlvDoublePoint &dataPoint, const IlvTransformer *t=0) const
	Inversely projects a screen point to retrieve the corresponding data point. More...

IlvChartGraphic *	getChartGraphic () const
	Returns the chart graphic which uses the current displayer. More...

IlvChartDataSet *	getDataSet (IlUInt index=0) const
	Returns a data set used by the current displayer. More...

IlUInt	getDataSetsCount () const
	Returns the number of data sets used by the current displayer. More...

IlUInt	getMaxDataSetsCount () const
	Returns the maximum number of real data sets that the current displayer is allowed to display. More...

const char *	getName () const
	Returns the name of the current displayer. More...

IlvCoordinateInfo *	getOrdinateInfo () const
	Deprecated Returns the coordinate information associated with the ordinate scale considered to display data. More...

const IlvCompositeChartDisplayer *	getParentDisplayer () const
	Returns the parent displayer. More...

virtual IlvChartDataPointInfo *	getPointInfo (IlUInt dataPtIdx, const IlvChartDataSet *dataSet=0) const
	Returns the point information associated with a given data point. More...

virtual IlvPalette *	getProjectedPointsPalette () const
	Returns the palette used to display out-of-bounds values. More...

IlvChartDataSet *	getRealDataSet (IlUInt index=0) const
	Returns a real data set to be displayed by the current displayer. More...

IlUInt	getRealDataSetsCount () const
	Returns the number of real data sets. More...

virtual IlvCombinedChartDataSet *	getVirtualDataSet (const IlvChartDataSet *dataSet, IlUInt &index) const
	Returns a virtual data set used by the current displayer. More...

virtual void	insertDataSet (IlvChartDataSet *dataSet, IlUInt index=IlvLastPositionIndex)
	Inserts a real data set to be displayed by the current displayer. More...

IlBoolean	isVisible () const
	Indicates whether the graphical representation is visible. More...

virtual void	removeDataSet (IlvChartDataSet *dataSet)
	Removes a real data set from the data sets to be displayed by the current displayer. More...

virtual void	removeDataSets ()
	Removes all the real data sets to be displayed by the current displayer.

void	removePointInfoCollection (const IlvChartDataSet *dataSet)
	Removes the point information collection defined to be used to display a given data set. More...

virtual IlBoolean	replaceDataSet (IlvChartDataSet oldDataSet, IlvChartDataSet newDataSet)
	Replaces a real data set with another one. More...

IlvOutputFile &	save (IlvOutputFile &file) const
	Writes a complete description of the current object in a file. More...

virtual void	setDataSet (IlvChartDataSet *dataSet, IlUInt index=0)
	Sets a real data set to be displayed by the current displayer. More...

void	setDataSet (IlvChartDataSet dataSet, IlvPalette palette, IlUInt index=0)
	Sets a real data set to be displayed by the current displayer. More...

virtual void	setDataSets (IlUInt count, IlvChartDataSet const dataSets)
	Sets the real data sets to be displayed by the current displayer. More...

void	setName (const char *name)
	Sets the name of the current displayer. More...

void	setParentDisplayer (const IlvCompositeChartDisplayer *displayer)
	Sets the parent displayer. More...

void	setVirtualDataSet (IlvCombinedChartDataSet *vDataSet, IlUInt index=0)
	Sets a virtual data set used by the current displayer. More...

void	setVisible (IlBoolean visible)
	Specifies whether the graphical representation is visible. More...

virtual IlBoolean	useVirtualDataSets () const
	Indicates whether the current displayer uses virtual data sets. More...

Protected Member Functions
virtual IlvAbstractChartDisplayer *	createDisplayer (IlUInt index, IlvPalette *palette=0)
	Defines the child displayers that will be created by default to compose the current displayer. More...

virtual void	updateDisplayers ()
	Updates the displayers that compose the current displayer. More...

Protected Member Functions inherited from IlvCompositeChartDisplayer
	IlvCompositeChartDisplayer (const IlvCompositeChartDisplayer &displayer)
	Constructor. More...

	IlvCompositeChartDisplayer (IlvChartDisplayerFactory *factory=0)
	Constructor. More...

	IlvCompositeChartDisplayer (IlvInputFile &file)
	Constructor. More...

void	initDisplayers (IlUInt count, IlvPalette const palettes=0)
	Creates the displayers that compose the current displayer. More...

virtual IlvAbstractChartDisplayer *	makeDisplayer (IlUInt idx, IlvPalette *pal=0)
	Creates one of the displayers that compose the current displayer. More...

virtual void	update ()
	Performs the updates needed when modifications (removing, adding, replacing) are made to the real data sets.

Protected Member Functions inherited from IlvAbstractChartDisplayer
	IlvAbstractChartDisplayer ()
	Constructor. More...

	IlvAbstractChartDisplayer (const IlvAbstractChartDisplayer &displayer)
	Constructor. More...

	IlvAbstractChartDisplayer (IlvInputFile &file)
	Constructor. More...

virtual void	dataSetAdded (IlUInt position=IlvLastPositionIndex)
	Performs the updates needed when a real data set is added. More...

virtual void	dataSetRemoved (IlUInt index)
	Performs the updates needed when a real data set is removed. More...

virtual void	updateVirtualDataSets ()
	Updates the virtual data sets. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvAbstractChartDisplayer
static IlvAbstractChartDisplayer *	Load (IlvInputFile &file)
	Reads a displayer object from a file. More...

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::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

◆ createDisplayer()

virtual IlvAbstractChartDisplayer* IlvMarkedPolylineChartDisplayer::createDisplayer	(	IlUInt	index,
		IlvPalette *	palette = `0`
	)

protectedvirtual

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.

◆ getLineBackground()

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.

◆ getLineDisplayer()

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.

◆ getLineForeground()

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.

◆ getLinePalette()

IlvPalette* IlvMarkedPolylineChartDisplayer::getLinePalette ( ) const

Returns the palette used to display the lines.

Returns: A pointer to the palette used to display the lines.

◆ getMarkerBackground()

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.

◆ getMarkerDisplayer()

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.

◆ getMarkerForeground()

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.

◆ getMarkerPalette()

IlvPalette* IlvMarkedPolylineChartDisplayer::getMarkerPalette ( ) const

Returns the palette used to display the markers.

Returns: A pointer to the palette used to display the markers.

◆ isLineVisible()

IlBoolean IlvMarkedPolylineChartDisplayer::isLineVisible ( ) const

Indicates whether the lines are shown.

Returns: IlTrue if the lines are shown and IlFalse otherwise.

◆ isMarkerVisible()

IlBoolean IlvMarkedPolylineChartDisplayer::isMarkerVisible ( ) const

Indicates whether the markers are shown.

Returns: IlTrue if the markers are shown and IlFalse otherwise.

◆ setLegendItems()

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.

◆ setLineBackground()

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.

◆ setLineForeground()

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.

◆ setLinePalette()

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.

◆ setLineVisible()

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.

◆ setMarkerBackground()

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.

◆ setMarkerForeground()

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.

◆ setMarkerPalette()

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.

◆ setMarkerVisible()

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.

◆ updateDisplayers()

virtual void IlvMarkedPolylineChartDisplayer::updateDisplayers ( )

protectedvirtual

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.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IlvMarkedPolylineChartDisplayer()

Member Function Documentation

◆ createDisplayer()

◆ getLineBackground()

◆ getLineDisplayer()

◆ getLineForeground()

◆ getLinePalette()

◆ getMarkerBackground()

◆ getMarkerDisplayer()

◆ getMarkerForeground()

◆ getMarkerPalette()

◆ isLineVisible()

◆ isMarkerVisible()

◆ setLegendItems()

◆ setLineBackground()

◆ setLineForeground()

◆ setLinePalette()

◆ setLineVisible()

◆ setMarkerBackground()

◆ setMarkerForeground()

◆ setMarkerPalette()

◆ setMarkerVisible()

◆ updateDisplayers()