Rogue Wave Views
Charts Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvLogScaleStepsUpdater Class Reference

Class for computing the graduations of a scale. More...

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvLogScaleStepsUpdater:
IlvScaleStepsUpdater IlvNamedProperty IlvValueInterface

Public Member Functions

 IlvLogScaleStepsUpdater (IlvSingleScaleDisplayer *scale)
 Constructor. More...
 
virtual IlBoolean checkRange (IlvCoordInterval &range) const
 Checks whether an interval is valid with respect to the step definition. More...
 
virtual char * computeStepLabel (IlDouble value) const
 Computes and returns the label displayed for a given data value. More...
 
virtual void getStepSubStepValues (const IlvProjectorArea &area, IlUInt &stepsCount, IlDouble *&stepValues, IlUInt &subStepsCount, IlDouble *&subStepValues) const
 Computes and returns the step and substep values for the associated scale. More...
 
- Public Member Functions inherited from IlvScaleStepsUpdater
IlvCoordinateInfogetCoordinateInfo () const
 Deprecated More...
 
IlvSingleScaleDisplayergetScale () const
 Returns the scale associated with the current scale steps updater. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvScaleStepsUpdater
static IlvScaleStepsUpdaterGet (const IlvSingleScaleDisplayer *scale)
 Returns the scale steps updater set on a given scale. More...
 
static IlvScaleStepsUpdaterRemove (IlvSingleScaleDisplayer *scale)
 Removes the scale steps updater set on a given scale. More...
 
static IlvScaleStepsUpdaterSet (IlvSingleScaleDisplayer *scale, IlvScaleStepsUpdater *updater)
 Sets a scale steps updater on a given scale. More...
 
- Protected Member Functions inherited from IlvScaleStepsUpdater
 IlvScaleStepsUpdater (IlvSingleScaleDisplayer *scale)
 Constructor. More...
 

Detailed Description

Class for computing the graduations of a scale.

Library: ilvcharts

IlvLogScaleStepsUpdater is a subclass of IlvScaleStepsUpdater that computes logarithmic graduations.

Warning
This class must be used to compute the steps for a given scale only when a logarithmic transformation is set on the coordinate represented by the scale.
See also
IlvScaleStepsUpdater, IlvSingleScaleDisplayer.

Constructor & Destructor Documentation

§ IlvLogScaleStepsUpdater()

IlvLogScaleStepsUpdater::IlvLogScaleStepsUpdater ( IlvSingleScaleDisplayer scale)

Constructor.

Initializes a new IlvLogScaleStepsUpdater object.

Member Function Documentation

§ checkRange()

virtual IlBoolean IlvLogScaleStepsUpdater::checkRange ( IlvCoordInterval range) const
virtual

Checks whether an interval is valid with respect to the step definition.

Called whenever the range of the coordinate associated with the current scale is modified. With this method, you can modify the interval range so that it becomes consistent with the steps definition. The default implementation simply returns IlTrue.

Parameters
rangeThe range to check.
Returns
IlFalse if the range was not correct and had to be modified, and IlTrue otherwise.

Reimplemented from IlvScaleStepsUpdater.

§ computeStepLabel()

virtual char* IlvLogScaleStepsUpdater::computeStepLabel ( IlDouble  value) const
virtual

Computes and returns the label displayed for a given data value.

Parameters
valueThe data value for which the label to be displayed is computed.

Reimplemented from IlvScaleStepsUpdater.

§ getStepSubStepValues()

virtual void IlvLogScaleStepsUpdater::getStepSubStepValues ( const IlvProjectorArea &  area,
IlUInt stepsCount,
IlDouble *&  stepValues,
IlUInt subStepsCount,
IlDouble *&  subStepValues 
) const
virtual

Computes and returns the step and substep values for the associated scale.

Parameters
areaThe data area definition. This data area definition can be retrieved with the IlvChartGraphic::getProjectorArea() method.
stepsCountReturns the number of major steps.
stepValuesReturns the values associated with the major steps.
subStepsCountReturns the number of minor steps.
subStepValuesReturns the values associated with the minor steps.

Implements IlvScaleStepsUpdater.


© Copyright 2018, 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.