Views
Charts Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
IlvAbstractChartDisplayer Class Referenceabstract

Abstract base class for data display. More...

#include <ilviews/charts/display.h>

Inheritance diagram for IlvAbstractChartDisplayer:
IlvValueInterface IlvCompositeChartDisplayer IlvSingleChartDisplayer IlvHiLoOpenCloseChartDisplayer IlvMarkedPolylineChartDisplayer IlvSideBySideChartDisplayer IlvStackedChartDisplayer IlvBarChartDisplayer IlvBubbleChartDisplayer IlvFixedStepChartDisplayer IlvHiLoChartDisplayer IlvPieChartDisplayer IlvPolylineChartDisplayer IlvScatterChartDisplayer IlvStepChartDisplayer

Public Member Functions

virtual ~IlvAbstractChartDisplayer ()
 Destructor. More...
 
void addDataSet (IlvChartDataSet *dataSet)
 Adds a real data set to be displayed by the current displayer. More...
 
virtual IlBoolean boundingBox (IlvRect &bbox, const IlvTransformer *t=0) const =0
 Returns the bounding box of the graphical representation of data. More...
 
virtual IlBoolean canBeProjectedIfOutOfBounds () const
 Indicates whether the graphical representation can be projected when it is out-of-bounds. More...
 
virtual IlvAbstractChartDisplayercopy () const =0
 Virtual copy constructor. More...
 
virtual IlBoolean dataPointBBox (IlUInt dataPtIdx, IlvRect &bbox, IlBoolean takeInfoIntoAccount=IlTrue, const IlvTransformer *t=0) const =0
 Returns the bounding box of the graphical representation of the data points at a given index. 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...
 
virtual void draw (IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *clip=0) const =0
 Draws the graphical representation of data. More...
 
virtual void drawDataPoint (IlUInt dataPtIdx, IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *clip=0) const =0
 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 =0
 Draws the graphical representation of the data points between a given interval. More...
 
virtual void drawFill (IlBoolean b)=0
 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 =0
 Draws the graphic part of a legend item associated with the current displayer. More...
 
virtual IlvColorgetBackground (IlUInt index=0) const =0
 Returns the background color of a palette used by the current displayer to display data. More...
 
IlvChartGraphicgetChartGraphic () const
 Returns the chart graphic which uses the current displayer. More...
 
virtual void getClipArea (IlvRect &area, const IlvTransformer *t) const =0
 Returns the clipping region that is used for the drawing. More...
 
IlvChartDataSetgetDataSet (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...
 
virtual IlUInt getDisplayersCount () const =0
 Returns the number of displayers.
 
virtual IlUInt getDisplayItem (IlvChartDataSet *&dataSet, const IlvPoint &viewPoint, const IlvTransformer *t) const =0
 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 =0
 Returns the corresponding screen point for a data point. More...
 
virtual IlvColorgetForeground (IlUInt index=0) const =0
 Returns the foreground color of a palette used by the current displayer to display data. More...
 
virtual const char * getInternalLegendText (IlUInt index=0) const =0
 Returns the legend text stored in the current displayer. More...
 
virtual const char * getLegendText (IlUInt index=0) const =0
 Returns the text that will be used in a legend for 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...
 
virtual IlUInt getNearestPoint (IlvChartDataSet *&dataSet, const IlvPoint &viewPoint, IlvDim distance, IlvPoint &point, const IlvTransformer *t=0) const =0
 Returns the nearest data point. More...
 
IlvCoordinateInfogetOrdinateInfo () const
 Deprecated Returns the coordinate information associated with the ordinate scale considered to display data. More...
 
virtual IlvPalettegetPalette (IlUInt index=0) const =0
 Returns a palette used by the current displayer to display data. More...
 
const IlvCompositeChartDisplayergetParentDisplayer () const
 Returns the parent displayer. More...
 
virtual IlvChartDataPointInfogetPointInfo (IlUInt dataPtIdx, const IlvChartDataSet *dataSet=0) const
 Returns the point information associated with a given data point. More...
 
virtual IlvPointInfoCollectiongetPointInfoCollection (const IlvChartDataSet *dataSet) const =0
 Returns the point information collection defined to be used to display a given data set. More...
 
virtual IlvPalettegetProjectedPointsPalette () const
 Returns the palette used to display out-of-bounds values. More...
 
IlvChartDataSetgetRealDataSet (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 IlvCombinedChartDataSetgetVirtualDataSet (const IlvChartDataSet *dataSet, IlUInt &index) const
 Returns a virtual data set used by the current displayer. More...
 
virtual IlBoolean graphicalRepresentationByDataPoint () const
 Indicates whether there is a graphical representation by data point. More...
 
virtual void insertDataSet (IlvChartDataSet *dataSet, IlUInt index=IlvLastPositionIndex)
 Inserts a real data set to be displayed by the current displayer. 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...
 
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...
 
IlvOutputFilesave (IlvOutputFile &file) const
 Writes a complete description of the current object in a file. More...
 
virtual void setBackground (IlvColor *color, IlUInt index=0)=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 =0
 Sets the corresponding data point from a screen point. 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...
 
virtual void setForeground (IlvColor *color, IlUInt index=0)=0
 Sets the foreground color of a palette used by the current displayer to display data. More...
 
virtual void setLegendItems (IlvChartLegend *legend) const =0
 Sets the legend items associated with the current displayer. More...
 
virtual void setLegendText (const char *text, IlUInt index=0)=0
 Sets the text that will be used in a legend for the current displayer. More...
 
virtual void setMode (IlvDrawMode mode)=0
 Sets the drawing mode. More...
 
void setName (const char *name)
 Sets the name of the current displayer. 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)=0
 Sets the overwrite mode. More...
 
virtual void setPalette (IlvPalette *pal, IlUInt index=0)=0
 Sets a palette used by the current displayer to display data. More...
 
void setParentDisplayer (const IlvCompositeChartDisplayer *displayer)
 Sets the parent displayer. More...
 
virtual void setPointInfoCollection (const IlvChartDataSet *dataSet, IlvPointInfoCollection *ptInfoCollection)=0
 Sets the point information collection that will be used to display a given data set. 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...
 
virtual void write (IlvOutputFile &file) const
 Writes the attributes of the current object in a file. More...
 

Static Public Member Functions

static IlvAbstractChartDisplayerLoad (IlvInputFile &file)
 Reads a displayer object from a file. More...
 

Protected Member Functions

 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 update ()
 Performs the updates needed when modifications (removing, adding, replacing) are made to the real data sets.
 
virtual void updateVirtualDataSets ()
 Updates the virtual data sets. More...
 

Detailed Description

Abstract base class for data display.

Library: ilvcharts

This abstract class defines a given type of graphical representation of data that is used within a chart. For example, data can be represented by markers, by polylines, and so on.

Each type of graphical representation of data is displayed within a chart by an instance of a derived class of IlvAbstractChartDisplayer. These objects that allow you to represent data in a specific way are commonly called displayers.

The displayers are divided into two categories:

A displayer can be used to display one or several data sets, depending on the type of the displayer. (See the IlvChartDataSet class for details about the data sets.) For example, a displayer that displays data with bars displays a unique data set, and a displayer that displays data with a high-low chart displays at least two data sets. For a given displayer, there are two kinds of data sets:

The current class stores a pointer to the chart graphic that uses it to display data and a pointer to a possible parent displayer. For a given displayer, the parent displayer corresponds to the composite displayer that uses this displayer if the displayer is used by a composite displayer.

See also
IlvSingleChartDisplayer, IlvCompositeChartDisplayer, IlvChartGraphic, IlvChartDataSet, IlvCombinedChartDataSet.

Constructor & Destructor Documentation

◆ ~IlvAbstractChartDisplayer()

virtual IlvAbstractChartDisplayer::~IlvAbstractChartDisplayer ( )
virtual

Destructor.

The destructor sets the pointers to the chart graphic that uses the current displayer and to the parent displayer if it is defined to 0.

◆ IlvAbstractChartDisplayer() [1/3]

IlvAbstractChartDisplayer::IlvAbstractChartDisplayer ( )
protected

Constructor.

Initializes a new IlvAbstractChartDisplayer instance. By default, the Boolean that indicates the visibility is set to IlTrue. The name, the pointers to the chart graphic that uses the current displayer, and the pointers to the parent displayer are set to 0.

◆ IlvAbstractChartDisplayer() [2/3]

IlvAbstractChartDisplayer::IlvAbstractChartDisplayer ( const IlvAbstractChartDisplayer displayer)
protected

Constructor.

Initializes a new IlvAbstractChartDisplayer instance as a copy of displayer.

Parameters
displayerThe object used to initialize the current one.

◆ IlvAbstractChartDisplayer() [3/3]

IlvAbstractChartDisplayer::IlvAbstractChartDisplayer ( IlvInputFile file)
protected

Constructor.

Initializes a new IlvAbstractChartDisplayer instance from the description read in the input file named file.

Parameters
fileThe file used to initialize the current displayer.

Member Function Documentation

◆ addDataSet()

void IlvAbstractChartDisplayer::addDataSet ( IlvChartDataSet dataSet)

Adds a real data set to be displayed by the current displayer.

Adds a data set at the end of the collection of data sets to be displayed by the current displayer.

Parameters
dataSetThe data set to add.

◆ boundingBox()

virtual IlBoolean IlvAbstractChartDisplayer::boundingBox ( IlvRect bbox,
const IlvTransformer t = 0 
) const
pure virtual

Returns the bounding box of the graphical representation of data.

Parameters
bboxThe bounding box of the graphical representation of data displayed by the current displayer.
tThe transformer that is applied to the returned bounding box.
Returns
IlTrue if the bounding box has been successfully computed and IlFalse otherwise.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ canBeProjectedIfOutOfBounds()

virtual IlBoolean IlvAbstractChartDisplayer::canBeProjectedIfOutOfBounds ( ) const
virtual

Indicates whether the graphical representation can be projected when it is out-of-bounds.

This method returns IlTrue if the graphical representation displayed by the current displayer can be projected when it is out-of-bounds and IlFalse otherwise.

Returns
IlFalse by default.

Reimplemented in IlvPolylineChartDisplayer.

◆ copy()

virtual IlvAbstractChartDisplayer* IlvAbstractChartDisplayer::copy ( ) const
pure 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.

◆ dataPointBBox()

virtual IlBoolean IlvAbstractChartDisplayer::dataPointBBox ( IlUInt  dataPtIdx,
IlvRect bbox,
IlBoolean  takeInfoIntoAccount = IlTrue,
const IlvTransformer t = 0 
) const
pure virtual

Returns the bounding box of the graphical representation of the data points at a given index.

Parameters
dataPtIdxThe index of the data point(s) for which we want to get the bounding box of their graphical representation.
bboxThe returned bounding box of the graphical representation of the data point(s).
takeInfoIntoAccountA Boolean value indicating whether the point information must be taken into account when the bounding box is computed.
tThe transformer that is applied to the bounding box.
Returns
IlTrue if the bounding box has been successfully computed and IlFalse otherwise.

Implemented in IlvSingleChartDisplayer, and IlvCompositeChartDisplayer.

◆ dataPointToDisplay()

IlBoolean IlvAbstractChartDisplayer::dataPointToDisplay ( const IlvDoublePoint dataPoint,
IlvPoint point,
const IlvTransformer t = 0 
) const

Projects a data point into screen coordinates.

Parameters
dataPointThe data point to project into screen coordinates.
pointThe corresponding screen point.
tThe optional transformer that is applied to the computed screen point.
Returns
IlTrue if the computation has been successfully performed and IlFalse otherwise.
Note
The data point passed as a parameter to this method belongs to a real data set that is displayed by the current displayer if the current displayer does not use virtual data sets. Otherwise, it belongs to a virtual data set used by the current displayer.

◆ dataSetAdded()

virtual void IlvAbstractChartDisplayer::dataSetAdded ( IlUInt  position = IlvLastPositionIndex)
protectedvirtual

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

Parameters
positionThe index at which the data set is added.

◆ dataSetRemoved()

virtual void IlvAbstractChartDisplayer::dataSetRemoved ( IlUInt  index)
protectedvirtual

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

This method just calls the IlvAbstractChartDisplayer::update() method.

Parameters
indexThe index of the removed data set.

Reimplemented in IlvStackedChartDisplayer, and IlvSideBySideChartDisplayer.

◆ displayDataSet()

virtual IlBoolean IlvAbstractChartDisplayer::displayDataSet ( const IlvChartDataSet dataSet) const
virtual

Indicates whether the current displayer displays a data set.

This method returns IlTrue if the data set dataSet is one of the real data sets to be displayed by the current displayer or one of the virtual data sets used by this displayer. Otherwise, it returns IlFalse.

Parameters
dataSetThe data set for which we want to know whether it is displayed by the current displayer.
Returns
IlTrue if the data set dataSet is displayed by the current displayer and IlFalse otherwise.

◆ displayToDataPoint()

IlBoolean IlvAbstractChartDisplayer::displayToDataPoint ( const IlvPoint point,
IlvDoublePoint dataPoint,
const IlvTransformer t = 0 
) const

Inversely projects a screen point to retrieve the corresponding data point.

Parameters
dataPointThe data point retrieved from the screen point point.
pointThe screen point that is inversely projected to retrieve the corresponding data point.
tThe transformer that has already been applied to point.
Returns
IlTrue if the computation has been successfully performed and IlFalse otherwise.

◆ draw()

virtual void IlvAbstractChartDisplayer::draw ( IlvPort dst,
const IlvTransformer t = 0,
const IlvRegion clip = 0 
) const
pure virtual

Draws the graphical representation of data.

Draws the graphical representation of data in the given IlvPort dst using the transformer t and the clipping region clip. In the case of a composite displayer, the draw() method is called for each child displayer that composes the composite displayer.

Parameters
dstThe port used for the drawing.
tThe optional transformer.
clipThe optional clipping region.

Implemented in IlvCompositeChartDisplayer, IlvSingleChartDisplayer, and IlvStackedChartDisplayer.

◆ drawDataPoint()

virtual void IlvAbstractChartDisplayer::drawDataPoint ( IlUInt  dataPtIdx,
IlvPort dst,
const IlvTransformer t = 0,
const IlvRegion clip = 0 
) const
pure virtual

Draws the graphical representation of the data point(s) at a given index.

Draws the graphical representation of the data point(s) at the index dataPtIdx in the data set(s) to be displayed by the current displayer. The drawing is performed in the port dst using the transformer t, and the clipping region clip.

Parameters
dataPtIdxThe index of the data point(s) to draw.
dstThe port used for the drawing.
tThe optional transformer.
clipThe optional clipping region.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ drawDataPoints()

virtual void IlvAbstractChartDisplayer::drawDataPoints ( IlUInt  iMin,
IlUInt  iMax,
IlvPort dst,
const IlvTransformer t = 0,
const IlvRegion clip = 0 
) const
pure virtual

Draws the graphical representation of the data points between a given interval.

Draws the graphical representation of the data points between the indexes iMin and iMax in the data set(s) to be displayed by the current displayer. The drawing is performed in the port dst using the transformer t and the clipping region clip.

Parameters
iMinThe minimum index used to select the data points to draw.
iMaxThe maximum index used to select the data points to draw.
dstThe port used for the drawing.
tThe optional transformer.
clipThe optional clipping region.
Note
For handling the needs of chart drawing, iMin is decreased by 1 and iMax is increased by 1 before selecting the data points whenever possible. This ensures continuity when drawing the chart, especially when polylines are used.
Warning
This method is simplified for performance reasons and does not work if the data have to be shifted by the cycle length before being displayed. If the data must be shifted, you have to use the IlvAbstractChartDisplayer::drawDataPoint() method, which works for all cases.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ drawFill()

virtual void IlvAbstractChartDisplayer::drawFill ( IlBoolean  b)
pure virtual

Sets the filling mode of the displayer.

This method tells the displayer whether the shape to render must be filled (using the background color of the palette) or simply outlined. In the case of a composite displayer, the new mode is propagated to all the child displayers.

Parameters
bThe new value of the Boolean indicating if the shape is to be filled (IlTrue) or only outlined (IlFalse).

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ drawLegendItem()

virtual void IlvAbstractChartDisplayer::drawLegendItem ( IlvPort dst,
const IlvRect legendArea,
IlvPalette itemPal,
const IlvRegion clip,
IlAny  clientData = 0 
) const
pure virtual

Draws the graphic part of a legend item associated with the current displayer.

The drawing is performed in the port dst using the clipping region clip. It is bounded by the rectangle legendArea.

Parameters
dstThe port used for the drawing.
legendAreaThe area where the drawing is performed.
itemPalThe palette of the legend item associated with the current displayer.
clipThe optional clipping region.
clientDataThe client data defined for the legend item associated with the current displayer.

Implemented in IlvScatterChartDisplayer, IlvStairChartDisplayer, IlvFixedStepChartDisplayer, IlvStepChartDisplayer, IlvPolygonChartDisplayer, IlvPolylineChartDisplayer, IlvPieChartDisplayer, IlvHiLoBarChartDisplayer, IlvHiLoChartDisplayer, IlvCompositeChartDisplayer, IlvSingleChartDisplayer, and IlvBubbleChartDisplayer.

◆ getBackground()

virtual IlvColor* IlvAbstractChartDisplayer::getBackground ( IlUInt  index = 0) const
pure virtual

Returns the background color of a palette used by the current displayer to display data.

If the current displayer is a single displayer (that is, an object inherited from the IlvSingleChartDisplayer class), this method just returns the background color of the palette stored inside the displayer. If the current displayer is a composite displayer (that is, an object inherited from the IlvCompositeChartDisplayer class), this method returns the background color of the palette used by the displayer at the index index in the collection of displayers that compose the current displayer.

Parameters
indexIf the current displayer is a composite displayer, this parameter indicates the index of the displayer within the displayers that compose the current displayer. Otherwise, this parameter can be omitted.
Returns
A pointer to the background color.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ getChartGraphic()

IlvChartGraphic* IlvAbstractChartDisplayer::getChartGraphic ( ) const

Returns the chart graphic which uses the current displayer.

Returns
A pointer to the chart graphic which uses the current displayer.

◆ getClipArea()

virtual void IlvAbstractChartDisplayer::getClipArea ( IlvRect area,
const IlvTransformer t 
) const
pure virtual

Returns the clipping region that is used for the drawing.

Parameters
areaThe clipping region that is used to clip the graphical representation of data drawn by the current displayer.
tThe transformer that is applied to the returned clipping region.

Implemented in IlvScatterChartDisplayer, IlvFixedStepChartDisplayer, IlvPieChartDisplayer, IlvHiLoChartDisplayer, IlvCompositeChartDisplayer, IlvSingleChartDisplayer, IlvBubbleChartDisplayer, Ilv3dBarChartDisplayer, and IlvBarChartDisplayer.

◆ getDataSet()

IlvChartDataSet* IlvAbstractChartDisplayer::getDataSet ( IlUInt  index = 0) const

Returns a data set used by the current displayer.

The returned data set corresponds to the data set at the index index among the virtual data sets if the current displayer uses virtual data sets. (See the IlvAbstractChartDisplayer::useVirtualDataSets() method.) Otherwise, it corresponds to the data set at the index index among the real data sets to be displayed by the current displayer.

Parameters
indexThe index of the returned data set.
Returns
A pointer to the returned data set.

◆ getDataSetsCount()

IlUInt IlvAbstractChartDisplayer::getDataSetsCount ( ) const

Returns the number of data sets used by the current displayer.

This number of data sets corresponds to the number of virtual data sets if the current displayer uses virtual data sets. (See the IlvAbstractChartDisplayer::useVirtualDataSets() method.) Otherwise, it corresponds to the number of real data sets to be displayed by the current displayer.

Returns
The number of data sets used by the current displayer.

◆ getDisplayItem()

virtual IlUInt IlvAbstractChartDisplayer::getDisplayItem ( IlvChartDataSet *&  dataSet,
const IlvPoint viewPoint,
const IlvTransformer t 
) const
pure virtual

Returns the item to which a view point corresponds.

Returns the index of the data point in the data set dataSet displayed by the current displayer that has its corresponding representation colliding with the point viewPoint. The returned index is equal to IlvBadIndex if no data point has been found. If the data set dataSet passed as a parameter is equal to 0, the nearest data point is searched for in all the data sets displayed by the current displayer. Otherwise, it is searched for in the data set dataSet. At the end, dataSet references the data set in which the data point has been found or 0 if no data set has been found. If no point has been found in a data set, dataSet is also equal to 0.

Parameters
dataSetThe data set from which a data point is retrieved.
viewPointThe point in screen coordinates for which we want to get the nearest displayed data point.
tThe optional transformer.
Returns
The index of the nearest data point that has been found.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ getDisplayPoint()

virtual IlBoolean IlvAbstractChartDisplayer::getDisplayPoint ( const IlvChartDataSet dataSet,
IlUInt  dataPtIdx,
IlvPoint point,
const IlvTransformer t = 0 
) const
pure virtual

Returns the corresponding screen point for a data point.

Returns in point the point in screen coordinates corresponding to the data point at the index dataPtIdx in the data set data set to be displayed by the current displayer.

Parameters
dataSetThe data set to which the considered data point belongs.
dataPtIdxThe index of the considered data point in the data set dataSet.
pointThe screen point corresponding to the considered data point.
tThe transformer that is applied to the returned screen point.
Returns
IlTrue if the corresponding screen point has been successfully computed and IlFalse otherwise.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ getForeground()

virtual IlvColor* IlvAbstractChartDisplayer::getForeground ( IlUInt  index = 0) const
pure virtual

Returns the foreground color of a palette used by the current displayer to display data.

If the current displayer is a single displayer (that is, an object inherited from the IlvSingleChartDisplayer class), this method just returns the foreground color of the palette stored inside the displayer. If the current displayer is a composite displayer (that is, an object inherited from the IlvCompositeChartDisplayer class), this method returns the foreground color of the palette used by the displayer at the index index in the collection of displayers that compose the current displayer.

Parameters
indexIf the current displayer is a composite displayer, this parameter indicates the index of the displayer within the displayers that compose the current displayer. Otherwise, this parameter can be omitted.
Returns
A pointer to the foreground color.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ getInternalLegendText()

virtual const char* IlvAbstractChartDisplayer::getInternalLegendText ( IlUInt  index = 0) const
pure virtual

Returns the legend text stored in the current displayer.

This text, if it is defined, is used in a legend as comments for the data represented by the current displayer. (See the IlvAbstractChartDisplayer::getLegendText() method.) If the current displayer is a single displayer (that is, an object inherited from the IlvSingleChartDisplayer class), this method just returns the legend text stored inside the displayer. If the current displayer is a composite displayer (that is, an object inherited from the IlvCompositeChartDisplayer class), this method returns the legend text stored for the displayer at the index index in the collection of displayers that compose the current displayer.

Parameters
indexIf the current displayer is a composite displayer, this parameter indicates the index of the displayer within the displayers that compose the current displayer. Otherwise, this parameter can be omitted.
Returns
The legend text that is stored.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ getLegendText()

virtual const char* IlvAbstractChartDisplayer::getLegendText ( IlUInt  index = 0) const
pure virtual

Returns the text that will be used in a legend for the current displayer.

If the current displayer is a single displayer (that is, an object inherited from the IlvSingleChartDisplayer class), this method just returns the legend text stored inside the displayer if it is defined. Otherwise, the method returns the name of the data set obtained by the IlvAbstractChartDisplayer::getRealDataSet() method. If the current displayer is a composite displayer (that is, an object inherited from the IlvCompositeChartDisplayer class), this method returns the text that will be used in a legend for the displayer at the index index in the collection of displayers that compose the current displayer.

Parameters
indexIf the current displayer is a composite displayer, this parameter indicates the index of the displayer within the displayers that compose the current displayer. Otherwise, this parameter can be omitted.
Returns
The text that will be used in a legend as comments for the data represented by the current displayer.

Implemented in IlvHiLoChartDisplayer, IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ getMaxDataSetsCount()

IlUInt IlvAbstractChartDisplayer::getMaxDataSetsCount ( ) const

Returns the maximum number of real data sets that the current displayer is allowed to display.

Returns
The maximum number of real data sets that the current displayer is allowed to display.

◆ getName()

const char* IlvAbstractChartDisplayer::getName ( ) const
virtual

Returns the name of the current displayer.

Returns
The name of the current displayer.

Reimplemented from IlvValueInterface.

◆ getNearestPoint()

virtual IlUInt IlvAbstractChartDisplayer::getNearestPoint ( IlvChartDataSet *&  dataSet,
const IlvPoint viewPoint,
IlvDim  distance,
IlvPoint point,
const IlvTransformer t = 0 
) const
pure virtual

Returns the nearest data point.

Returns the index of the data point in the data set dataSet displayed by the current displayer that has its corresponding point in screen coordinates nearest to the point viewPoint. The returned index is equal to IlvBadIndex if no data point has been found. If the data set dataSet passed as a parameter is equal to 0, the nearest data point is searched for in all the data sets displayed by the current displayer. Otherwise, it is searched for in the data set dataSet. At the end, dataSet references the data set in which the data point has been found or 0 if no data set has been found. If no point has been found in a data set, dataSet is also equal to 0.

Parameters
dataSetThe data set from which a data point is retrieved.
viewPointThe point in screen coordinates for which we want to get the nearest displayed data point.
distanceThe maximum distance allowed between viewPoint and the screen point corresponding to the returned data point.
pointThe screen point corresponding to the nearest data point that has been found.
tThe optional transformer.
Returns
The index of the nearest data point that has been found.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ getOrdinateInfo()

IlvCoordinateInfo* IlvAbstractChartDisplayer::getOrdinateInfo ( ) const

Deprecated Returns the coordinate information associated with the ordinate scale considered to display data.

Returns
A pointer to the coordinate information associated with the ordinate scale that is considered to display data.

◆ getPalette()

virtual IlvPalette* IlvAbstractChartDisplayer::getPalette ( IlUInt  index = 0) const
pure virtual

Returns a palette used by the current displayer to display data.

If the current displayer is a single displayer (that is, an object inherited from the IlvSingleChartDisplayer class), this method just returns the palette stored inside the displayer. If the current displayer is a composite displayer (that is, an object inherited from the IlvCompositeChartDisplayer class), this method returns the palette used by the displayer at the index index in the collection of displayers that compose the current displayer.

Parameters
indexIf the current displayer is a composite displayer, this parameter indicates the index of the displayer within the displayers composing the current displayer. Otherwise, this parameter can be omitted.
Returns
A pointer to the palette.

Implemented in IlvSingleChartDisplayer, and IlvCompositeChartDisplayer.

◆ getParentDisplayer()

const IlvCompositeChartDisplayer* IlvAbstractChartDisplayer::getParentDisplayer ( ) const

Returns the parent displayer.

This method is appropriate when the current displayer is used by a composite displayer.

Returns
A pointer to the composite displayer that uses the current displayer if the current displayer is used by a composite displayer. Otherwise, it returns 0.

◆ getPointInfo()

virtual IlvChartDataPointInfo* IlvAbstractChartDisplayer::getPointInfo ( IlUInt  dataPtIdx,
const IlvChartDataSet dataSet = 0 
) const
virtual

Returns the point information associated with a given data point.

Returns the point information associated with the data point at the index index in the data set dataSet if dataSet is different from 0. dataSet must be a real data set displayed by the current displayer.

If dataSet is equal to 0, this method returns the point information associated with the data point at the index index in the data set returned by the IlvAbstractChartDisplayer::getRealDataSet() method.

If a point information collection has been defined to be used by the current displayer to display the considered data set, this method returns the point information that is managed by this point information collection. If no such point information collection has been defined, this method returns the point information that is managed by the point information collection that has directly been set on the considered data set (by using the IlvChartDataSet::setPointInfoCollection() method) if this point information collection exists.

Parameters
dataPtIdxThe index of the data point for which we want to get the point information.
dataSetThe data set to which the data point belongs.
Returns
A pointer to the point information associated with the considered data point.
Note
The returned point information will be used by the current displayer to display the data point with which it is associated.

Reimplemented in IlvHiLoChartDisplayer.

◆ getPointInfoCollection()

virtual IlvPointInfoCollection* IlvAbstractChartDisplayer::getPointInfoCollection ( const IlvChartDataSet dataSet) const
pure virtual

Returns the point information collection defined to be used to display a given data set.

Parameters
dataSetThe data set that will be displayed by the current displayer.
Returns
A pointer to the point information collection defined to be used to display the data set dataSet.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ getProjectedPointsPalette()

virtual IlvPalette* IlvAbstractChartDisplayer::getProjectedPointsPalette ( ) const
virtual

Returns the palette used to display out-of-bounds values.

The current implementation of the method returns a pointer to the palette object that has been set to display out-of-bounds data points in the chart object that uses the current displayer.

Returns
A pointer to the palette object used to display out-of-bounds data points.

Reimplemented in IlvPolylineChartDisplayer.

◆ getRealDataSet()

IlvChartDataSet* IlvAbstractChartDisplayer::getRealDataSet ( IlUInt  index = 0) const

Returns a real data set to be displayed by the current displayer.

Parameters
indexThe index of the real data set that is returned.
Returns
A pointer to the real data set that is returned.

◆ getRealDataSetsCount()

IlUInt IlvAbstractChartDisplayer::getRealDataSetsCount ( ) const

Returns the number of real data sets.

Returns
The number of real data sets to be displayed by the current displayer.

◆ getVirtualDataSet()

virtual IlvCombinedChartDataSet* IlvAbstractChartDisplayer::getVirtualDataSet ( const IlvChartDataSet dataSet,
IlUInt index 
) const
virtual

Returns a virtual data set used by the current displayer.

The default implementation returns the first virtual data set among the virtual data sets used by the current displayer for which the data set dataSet is one of the real data sets used to construct this virtual data set.

Parameters
dataSetThe real data set for which we want to get the first virtual data set that uses it.
indexThe index of the virtual data set that is returned.
Returns
The first virtual data set among the virtual data sets used by the current displayer for which the data set dataSet is one of the real data sets used to construct this virtual data set.

Reimplemented in IlvStackedChartDisplayer.

◆ graphicalRepresentationByDataPoint()

virtual IlBoolean IlvAbstractChartDisplayer::graphicalRepresentationByDataPoint ( ) const
virtual

Indicates whether there is a graphical representation by data point.

There is a graphical representation by data point for displayers displaying markers, bars, and so on. But there is not a graphical representation by data point for some displayers (such as polyline displayers, step displayers, and so on) that display continuous graphical representations linking several data points together.

This method returns IlTrue if there is a graphical representation by data point for the current displayer and IlFalse otherwise.

Returns
IlTrue by default.

Reimplemented in IlvStepChartDisplayer, IlvPolylineChartDisplayer, and IlvCompositeChartDisplayer.

◆ insertDataSet()

virtual void IlvAbstractChartDisplayer::insertDataSet ( IlvChartDataSet dataSet,
IlUInt  index = IlvLastPositionIndex 
)
virtual

Inserts a real data set to be displayed by the current displayer.

Parameters
dataSetThe data set to insert.
indexThe index at which the data set must be inserted.

◆ isContinuous()

virtual IlBoolean IlvAbstractChartDisplayer::isContinuous ( ) const
virtual

Indicates whether the graphical representation is continuous.

The graphical representation of data displayed by a displayer is continuous if the graphical representation displayed for a given data point extends to and relies on another data point. So it is continuous if a given data point is not sufficient to display the graphical representation for this data point. For example, the graphical representation of data by a polyline is continuous since it requires the given data point and the following data point to be able to draw the graphical representation for a given data point. On the other hand, the graphical representation of data by markers is not continuous.

This method returns IlTrue if the current displayer is continuous and IlFalse otherwise.

Returns
IlFalse by default.

Reimplemented in IlvStepChartDisplayer, IlvPolylineChartDisplayer, IlvPieChartDisplayer, IlvHiLoChartDisplayer, and IlvCompositeChartDisplayer.

◆ isFilled()

virtual IlBoolean IlvAbstractChartDisplayer::isFilled ( ) const
virtual

Indicates whether the graphical representation is filled.

A graphical representation is filled for a given data point if it is not only located around this data point but also if it extends towards the origin. This is the case, for example, for displayers representing data with bars. A bar begins at the data point position and is drawn to the abscissa scale in Cartesian charts and to the center of the data display area in polar charts.

This method returns IlTrue if the graphical representation displayed by the current displayer is filled and IlFalse otherwise.

Returns
IlFalse by default.

Reimplemented in IlvStairChartDisplayer, IlvPolygonChartDisplayer, IlvHiLoChartDisplayer, IlvCompositeChartDisplayer, and IlvBarChartDisplayer.

◆ isViewable()

virtual IlBoolean IlvAbstractChartDisplayer::isViewable ( ) const
virtual

Indicates whether the graphical representation can be viewed.

The graphical representation displayed by the current displayer can be viewed if and only if all the elements required to be able to display this graphical representation are verified. By default, it can be viewed if the graphical representation is visible, if the number of data sets to display is greater than 0, and if the coordinate information associated with the ordinate scale considered to display the data is defined.

Returns
IlTrue if the graphical representation displayed by the current displayer can be viewed, IlFalse otherwise.

Reimplemented in IlvHiLoChartDisplayer, IlvCompositeChartDisplayer, and IlvBubbleChartDisplayer.

◆ isVisible()

IlBoolean IlvAbstractChartDisplayer::isVisible ( ) const

Indicates whether the graphical representation is visible.

Returns
IlTrue if the graphical representation displayed by the current displayer is visible and IlFalse otherwise.

◆ Load()

static IlvAbstractChartDisplayer* IlvAbstractChartDisplayer::Load ( IlvInputFile file)
static

Reads a displayer object from a file.

Creates a displayer instance from the description stored in the file file. The object description must have been written with the IlvAbstractChartDisplayer::save() method.

Parameters
fileThe file where the object description is stored.
Returns
A pointer to the created object.

◆ removeDataSet()

virtual void IlvAbstractChartDisplayer::removeDataSet ( IlvChartDataSet dataSet)
virtual

Removes a real data set from the data sets to be displayed by the current displayer.

Parameters
dataSetThe data set that is to be removed from the collection of data sets to be displayed by the current displayer.
Note
To get the data set that will be removed, you must uses the getRealDataSet() function if the displayer uses composite data sets like the IlvStackedChartDisplayer.

◆ removePointInfoCollection()

void IlvAbstractChartDisplayer::removePointInfoCollection ( const IlvChartDataSet dataSet)

Removes the point information collection defined to be used to display a given data set.

Parameters
dataSetThe data set for which we want to remove the defined point information collection.

◆ replaceDataSet()

virtual IlBoolean IlvAbstractChartDisplayer::replaceDataSet ( IlvChartDataSet oldDataSet,
IlvChartDataSet newDataSet 
)
virtual

Replaces a real data set with another one.

Parameters
oldDataSetThe data set that is to be replaced in the collection of data sets to be displayed by the current displayer.
newDataSetThe data set that will replace oldDataSet.
Returns
IlTrue if the data set replacement has been successfully performed and IlFalse otherwise.

◆ save()

IlvOutputFile& IlvAbstractChartDisplayer::save ( IlvOutputFile file) const

Writes a complete description of the current object in a file.

Writes the complete object description in a file. This description contains all the information necessary to read back this object with the IlvAbstractChartDisplayer::Load() member function. This method first writes information regarding the type of the object and calls the IlvAbstractChartDisplayer::write() method.

Parameters
fileThe file where the complete object description is written.

◆ setBackground()

virtual void IlvAbstractChartDisplayer::setBackground ( IlvColor color,
IlUInt  index = 0 
)
pure virtual

Sets the background color of a palette used by the current displayer to display data.

If the current displayer is a single displayer (that is, an object inherited from the IlvSingleChartDisplayer class), this method just sets the background color of the palette stored inside the displayer. If the current displayer is a composite displayer (that is, an object inherited from the IlvCompositeChartDisplayer class), this method sets the background color of the palette used by the displayer at the index index in the collection of displayers that compose the current displayer.

Parameters
colorThe background color to be set.
indexIf the current displayer is a composite displayer, this parameter indicates the index of the displayer within the displayers that compose the current displayer. Otherwise, this parameter can be omitted.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ setChartGraphic()

virtual void IlvAbstractChartDisplayer::setChartGraphic ( IlvChartGraphic chart)
virtual

Sets the chart graphic which uses the current displayer.

Parameters
chartThe chart graphic which uses the current displayer.
Note
This method is for internal use only and should not be used directly by the user. The chart graphic that uses the current displayer is automatically set when the displayer is added to this chart graphic. Therefore, the chart graphic does not need to be set by hand.

Reimplemented in IlvPieChartDisplayer, and IlvCompositeChartDisplayer.

◆ setDataPoint()

virtual IlBoolean IlvAbstractChartDisplayer::setDataPoint ( IlvChartDataSet dataSet,
IlUInt  dataPtIdx,
const IlvPoint point,
const IlvTransformer t = 0 
) const
pure virtual

Sets the corresponding data point from a screen point.

Computes from the point in screen coordinates point the corresponding data point and sets this data point at the index dataPtIdx in the data set dataSet that is displayed by the current displayer.

Parameters
dataSetThe data set for which we want to set a data point.
dataPtIdxThe index of the data point to be set.
pointThe point in screen coordinates that is considered to be already transformed by t.
tThe transformer that has already been applied to point.
Returns
IlTrue if the data point has been successfully set and IlFalse otherwise.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ setDataSet() [1/2]

virtual void IlvAbstractChartDisplayer::setDataSet ( IlvChartDataSet dataSet,
IlUInt  index = 0 
)
virtual

Sets a real data set to be displayed by the current displayer.

If a data set already exists at the index index, it is replaced by the new one. Otherwise, the new data set is added at the end.

Parameters
dataSetThe new real data set to be displayed by the current displayer.
indexThe index at which the new data set is set.

◆ setDataSet() [2/2]

void IlvAbstractChartDisplayer::setDataSet ( IlvChartDataSet dataSet,
IlvPalette palette,
IlUInt  index = 0 
)

Sets a real data set to be displayed by the current displayer.

If a data set already exists at the index index, it is replaced by the new one. Otherwise, the new data set is added at the end.

Parameters
dataSetThe new real data set to be displayed by the current displayer.
paletteA pointer to the palette that will be used to display the data set dataSet.
indexThe index at which the new data set is set.

◆ setDataSets()

virtual void IlvAbstractChartDisplayer::setDataSets ( IlUInt  count,
IlvChartDataSet *const *  dataSets 
)
virtual

Sets the real data sets to be displayed by the current displayer.

Parameters
countThe number of data sets contained in the array dataSets.
dataSetsThe new array of real data sets to be displayed by the current displayer.

◆ setForeground()

virtual void IlvAbstractChartDisplayer::setForeground ( IlvColor color,
IlUInt  index = 0 
)
pure virtual

Sets the foreground color of a palette used by the current displayer to display data.

If the current displayer is a single displayer (that is, an object inherited from the IlvSingleChartDisplayer class), this method just sets the foreground color of the palette stored inside the displayer. If the current displayer is a composite displayer (that is, an object inherited from the IlvCompositeChartDisplayer class), this method sets the foreground color of the palette used by the displayer at the index index in the collection of displayers that compose the current displayer.

Parameters
colorThe foreground color to be set.
indexIf the current displayer is a composite displayer, this parameter indicates the index of the displayer within the displayers that compose the current displayer. Otherwise, this parameter can be omitted.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ setLegendItems()

virtual void IlvAbstractChartDisplayer::setLegendItems ( IlvChartLegend legend) const
pure virtual

Sets the legend items associated with the current displayer.

Sets the legend items associated with the current displayer on the legend legend. This is done by calling the IlvChartLegend::addLegendItem() method for each legend item associated with the current displayer.

Parameters
legendThe legend that will display the legend items associated with the current displayer.

Implemented in IlvMarkedPolylineChartDisplayer, IlvPieChartDisplayer, IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ setLegendText()

virtual void IlvAbstractChartDisplayer::setLegendText ( const char *  text,
IlUInt  index = 0 
)
pure virtual

Sets the text that will be used in a legend for the current displayer.

If the current displayer is a single displayer (that is, an object inherited from the IlvSingleChartDisplayer class), this method just sets the legend text stored inside the displayer. If the current displayer is a composite displayer (that is, an object inherited from the IlvCompositeChartDisplayer class), this method sets the legend text defined for the displayer at the index index in the collection of displayers that compose the current displayer.

Parameters
textThe text that will be used in a legend for the current displayer. The text passed as a parameter is copied.
indexIf the current displayer is a composite displayer, this parameter indicates the index of the displayer within the displayers that compose the current displayer. Otherwise, this parameter can be omitted.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ setMode()

virtual void IlvAbstractChartDisplayer::setMode ( IlvDrawMode  mode)
pure virtual

Sets the drawing mode.

Sets the drawing mode for the current object. The information is passed to all the palettes used by the current displayer to display data.

Parameters
modeThe new drawing mode for the current object.

Implemented in IlvPieChartDisplayer, IlvHiLoChartDisplayer, IlvCompositeChartDisplayer, IlvSingleChartDisplayer, and Ilv3dBarChartDisplayer.

◆ setName()

void IlvAbstractChartDisplayer::setName ( const char *  name)

Sets the name of the current displayer.

Parameters
nameThe new name of the current displayer. The name passed as a parameter is copied.

◆ setOrdinateInfo()

virtual void IlvAbstractChartDisplayer::setOrdinateInfo ( IlvCoordinateInfo ordinateInfo)
virtual

Sets the coordinate information associated with the ordinate scale considered to display data.

This method allows you to specify the ordinate scale that will be considered to display data for the current displayer. The coordinate information associated with this ordinate scale is set in the current displayer. In the case of a composite displayer, the coordinate information is propagated to all the child displayers.

Parameters
ordinateInfoThe new coordinate information associated with the ordinate scale that will be considered to display the data for the current displayer.
Note
This method is for internal use only and should not be directly used by the user. The coordinate information associated with the ordinate scale that will be considered to display data for the current displayer is automatically set when the displayer is added to a chart graphic. (See the IlvChartGraphic::addDisplayer() method.) Therefore, the coordinate information does not need to be set by hand.

Reimplemented in IlvCompositeChartDisplayer.

◆ setOverwrite()

virtual void IlvAbstractChartDisplayer::setOverwrite ( IlBoolean  o)
pure virtual

Sets the overwrite mode.

Modifies the way the drawing member functions of the current object operate when drawing on the root port. If the o parameter is set to IlFalse, the drawing operations are hidden by the windows stored on the top window. If the parameter is set to IlTrue, the drawing operations are performed on top of every window present on the screen, just as if the windows were part of the root window. The information is passed to all the palettes used by the current displayer to display data.

Parameters
oThe new value of the Boolean indicating the way the drawing member functions operate.

Implemented in IlvPieChartDisplayer, IlvHiLoChartDisplayer, IlvCompositeChartDisplayer, IlvSingleChartDisplayer, and Ilv3dBarChartDisplayer.

◆ setPalette()

virtual void IlvAbstractChartDisplayer::setPalette ( IlvPalette pal,
IlUInt  index = 0 
)
pure virtual

Sets a palette used by the current displayer to display data.

If the current displayer is a single displayer (that is, an object inherited from the IlvSingleChartDisplayer class), this method just sets the palette stored inside the displayer. If the current displayer is a composite displayer (that is, an object inherited from the IlvCompositeChartDisplayer class), this method sets the palette used by the displayer at the index index in the collection of displayers that compose the current displayer.

Parameters
palThe palette to be set.
indexIf the current displayer is a composite displayer, this parameter indicates the index of the displayer within the displayers composing the current displayer. Otherwise, this parameter can be omitted.

Implemented in Ilv3dBarChartDisplayer, IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ setParentDisplayer()

void IlvAbstractChartDisplayer::setParentDisplayer ( const IlvCompositeChartDisplayer displayer)

Sets the parent displayer.

This method is appropriate when the current displayer is used by a composite displayer.

Parameters
displayerThe pointer to the composite displayer that uses the current displayer.
Note
This method is used internally and should not be used directly by the user.

◆ setPointInfoCollection()

virtual void IlvAbstractChartDisplayer::setPointInfoCollection ( const IlvChartDataSet dataSet,
IlvPointInfoCollection ptInfoCollection 
)
pure virtual

Sets the point information collection that will be used to display a given data set.

This new point information collection has priority. It is the one that will be considered to display the data set dataSet, even if a point information collection has already been defined for the data set dataSet by using the IlvChartDataSet::setPointInfoCollection() method.

Parameters
dataSetThe data set that will be displayed by the current displayer.
ptInfoCollectionThe point information collection that will be used to display the data set dataSet.

Implemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.

◆ setVirtualDataSet()

void IlvAbstractChartDisplayer::setVirtualDataSet ( IlvCombinedChartDataSet vDataSet,
IlUInt  index = 0 
)

Sets a virtual data set used by the current displayer.

If a data set already exists at the index index, it is replaced by the new one. Otherwise, the new data set is added at the end.

Parameters
vDataSetThe new virtual data set.
indexThe index at which the new data set is set.
Note
This method is used internally and should not be used directly by the user since the creation and the handling of the virtual data sets for a given displayer are performed internally within the class.

◆ setVisible()

void IlvAbstractChartDisplayer::setVisible ( IlBoolean  visible)

Specifies whether the graphical representation is visible.

Parameters
visibleThe new value of the Boolean indicating whether the graphical representation displayed by the current displayer is visible.

◆ updateVirtualDataSets()

virtual void IlvAbstractChartDisplayer::updateVirtualDataSets ( )
protectedvirtual

Updates the virtual data sets.

This method does nothing at this level of the class hierarchy.

Note
This method is used internally and should not be used directly by the user. It is called in the IlvAbstractChartDisplayer::update() method to update the virtual data sets when the real data sets have been modified.

Reimplemented in IlvStackedChartDisplayer, IlvPieChartDisplayer, and IlvHiLoChartDisplayer.

◆ useVirtualDataSets()

virtual IlBoolean IlvAbstractChartDisplayer::useVirtualDataSets ( ) const
virtual

Indicates whether the current displayer uses virtual data sets.

Returns
IlTrue if the current displayer uses virtual data sets and IlFalse otherwise.

Reimplemented in IlvStackedChartDisplayer, IlvPieChartDisplayer, IlvHiLoOpenCloseChartDisplayer, and IlvHiLoChartDisplayer.

◆ write()

virtual void IlvAbstractChartDisplayer::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
fileThe file where the attributes of the current object are written.

Reimplemented in IlvCompositeChartDisplayer, and IlvSingleChartDisplayer.