rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvChartPointsFilter Class Reference

Utility class for displaying data points. More...

#include <ilviews/charts/display.h>

Inheritance diagram for IlvChartPointsFilter:
IlvChartDisplayerPoints

List of all members.

Public Member Functions

 IlvChartPointsFilter (const IlvChartGraphic *chart, const IlvSingleChartDisplayer *displayer, IlvDim clusterSize=2)
 Constructor.
IlvDim getClusterSize () const
 Returns the minimum distance between two consecutive displayed points.
virtual IlBoolean init (IlUInt count, const IlvDoublePoint *dataPoints, const IlUInt *dataPtIdxes, const IlvCoordInterval &abscissaRange, IlBoolean shiftOfCycleLength, const IlvTransformer *t)
 Initializes the current object with a set of data points to project.
void setClusterSize (IlvDim size)
 Sets the minimum distance between two consecutive displayed points.

Detailed Description

Utility class for displaying data points.

Library: ilvcharts

This class is a subclass of IlvChartDisplayerPoints that allows you to filter the points to display.

See also:
IlvChartDisplayerPoints.

Constructor & Destructor Documentation

IlvChartPointsFilter::IlvChartPointsFilter ( const IlvChartGraphic chart,
const IlvSingleChartDisplayer displayer,
IlvDim  clusterSize = 2 
)

Constructor.

Initializes a new IlvChartPointsFilter instance.

Parameters:
chart The associated chart.
displayer The associated displayer.
clusterSize The minimum distance between two consecutive displayed points.

Member Function Documentation

IlvDim IlvChartPointsFilter::getClusterSize (  )  const

Returns the minimum distance between two consecutive displayed points.

Returns:
The minimum distance between two consecutive displayed points.
virtual IlBoolean IlvChartPointsFilter::init ( IlUInt  count,
const IlvDoublePoint dataPoints,
const IlUInt dataPtIdxes,
const IlvCoordInterval abscissaRange,
IlBoolean  shiftOfCycleLength,
const IlvTransformer t 
) [virtual]

Initializes the current object with a set of data points to project.

This method performs the projection of the data points dataPoints and stores in the current object the resulting points and their corresponding data point indexes given by dataPtIdxes.

Parameters:
count The number of data points.
dataPoints The data points to project.
dataPtIdxes The indexes of the data points in the data set.
abscissaRange The range of the abscissa coordinate that is currently used by the chart.
shiftOfCycleLength A Boolean value indicating whether the data points are shifted by the cycle length.
t The transformer applied to the chart graphic.

Reimplemented from IlvChartDisplayerPoints.

void IlvChartPointsFilter::setClusterSize ( IlvDim  size  ) 

Sets the minimum distance between two consecutive displayed points.

Parameters:
The new minimum distance between two consecutive displayed points.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.