This class implements the calculation of automatic axis limits. More...

#include <ScaleAutomatism.hxx>

Collaboration diagram for chart::ScaleAutomatism:

Public Member Functions
	ScaleAutomatism (const css::chart2::ScaleData &rSourceScale, const Date &rNullDate)

void	expandValueRange (double fMinimum, double fMaximum)
	Expands own value range with the passed minimum and maximum. More...

void	resetValueRange ()

void	setAutoScalingOptions (bool bExpandBorderToIncrementRhythm, bool bExpandIfValuesCloseToBorder, bool bExpandWideValuesToZero, bool bExpandNarrowValuesTowardZero)
	Sets additional auto scaling options. More...

void	setMaximumAutoMainIncrementCount (sal_Int32 nMaximumAutoMainIncrementCount)
	Sets the maximum allowed number of automatic main increments. More...

void	setAutomaticTimeResolution (sal_Int32 nTimeResolution)
	Sets the time resolution to be used in case it is not set explicitly within the scale. More...

void	calculateExplicitScaleAndIncrement (ExplicitScaleData &rExplicitScale, ExplicitIncrementData &rExplicitIncrement) const
	Fills the passed scale data and increment data according to the own settings. More...

const css::chart2::ScaleData &	getScale () const

const Date &	getNullDate () const

Private Member Functions
void	calculateExplicitIncrementAndScaleForCategory (ExplicitScaleData &rExplicitScale, ExplicitIncrementData &rExplicitIncrement, bool bAutoMinimum, bool bAutoMaximum) const
	Fills the passed scale data and increment data for category scaling. More...

void	calculateExplicitIncrementAndScaleForLogarithmic (ExplicitScaleData &rExplicitScale, ExplicitIncrementData &rExplicitIncrement, bool bAutoMinimum, bool bAutoMaximum) const
	Fills the passed scale data and increment data for logarithmic scaling. More...

void	calculateExplicitIncrementAndScaleForLinear (ExplicitScaleData &rExplicitScale, ExplicitIncrementData &rExplicitIncrement, bool bAutoMinimum, bool bAutoMaximum) const
	Fills the passed scale data and increment data for linear scaling. More...

void	calculateExplicitIncrementAndScaleForDateTimeAxis (ExplicitScaleData &rExplicitScale, ExplicitIncrementData &rExplicitIncrement, bool bAutoMinimum, bool bAutoMaximum) const
	Fills the passed scale data and increment data for date-time axis. More...

Private Attributes
css::chart2::ScaleData	m_aSourceScale

double	m_fValueMinimum

double	m_fValueMaximum
	Minimum of all source values. More...

sal_Int32	m_nMaximumAutoMainIncrementCount
	Maximum of all source values. More...

bool	m_bExpandBorderToIncrementRhythm
	Maximum number of automatic main increments. More...

bool	m_bExpandIfValuesCloseToBorder
	true = Expand to main increments. More...

bool	m_bExpandWideValuesToZero
	true = Expand if values are too close to the borders. More...

bool	m_bExpandNarrowValuesTowardZero
	true = Expand wide spread values to zero. More...

sal_Int32	m_nTimeResolution
	true = Expand narrow range toward zero (add half of range). More...

Date	m_aNullDate

Detailed Description

This class implements the calculation of automatic axis limits.

This class is used for calculating axis scales and increments in the form of instances of ExplicitScaleData and ExplicitIncrementData classes. When a ScaleAutomatism instance is created a ScaleData object is passed to the constructor. Objects of ScaleData type are initialized by the createCoordinateSystem method of some chart type (e.g. the PieChartType class) and belong to some Axis object, they can be accessed through the XAxis interface (XAxis::getScaleData).

Definition at line 41 of file ScaleAutomatism.hxx.

Constructor & Destructor Documentation

◆ ScaleAutomatism()

chart::ScaleAutomatism::ScaleAutomatism	(	const css::chart2::ScaleData &	rSourceScale,
		const Date &	rNullDate
	)

explicit

Definition at line 89 of file ScaleAutomatism.cxx.

References DAY, expandValueRange(), m_aSourceScale, and resetValueRange().

Member Function Documentation

◆ calculateExplicitIncrementAndScaleForCategory()

void chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForCategory	(	ExplicitScaleData &	rExplicitScale,
		ExplicitIncrementData &	rExplicitIncrement,
		bool	bAutoMinimum,
		bool	bAutoMaximum
	)		const

private

Fills the passed scale data and increment data for category scaling.

Definition at line 237 of file ScaleAutomatism.cxx.

References chart::ExplicitIncrementData::BaseValue, chart::ExplicitIncrementData::Distance, chart::EquidistantTickFactory::getMaximumAtIncrement(), chart::EquidistantTickFactory::getMinimumAtIncrement(), chart::ExplicitSubIncrement::IntervalCount, m_aSourceScale, m_bExpandBorderToIncrementRhythm, chart::ExplicitScaleData::m_bShiftedCategoryPosition, chart::ExplicitScaleData::Maximum, chart::MAXIMUM_MANUAL_INCREMENT_COUNT, chart::ExplicitScaleData::Minimum, chart::ExplicitSubIncrement::PostEquidistant, chart::ExplicitIncrementData::PostEquidistant, chart::ExplicitScaleData::Scaling, and chart::ExplicitIncrementData::SubIncrements.

Referenced by calculateExplicitScaleAndIncrement().

◆ calculateExplicitIncrementAndScaleForDateTimeAxis()

void chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForDateTimeAxis	(	ExplicitScaleData &	rExplicitScale,
		ExplicitIncrementData &	rExplicitIncrement,
		bool	bAutoMinimum,
		bool	bAutoMaximum
	)		const

private

Fills the passed scale data and increment data for date-time axis.

Definition at line 545 of file ScaleAutomatism.cxx.

References Date::AddDays(), DAY, chart::DateHelper::GetDateSomeMonthsAway(), chart::DateHelper::GetDateSomeYearsAway(), chart::DateHelper::IsLessThanOneMonthAway(), chart::DateHelper::IsLessThanOneYearAway(), m_aNullDate, m_aSourceScale, chart::ExplicitScaleData::m_bShiftedCategoryPosition, m_nMaximumAutoMainIncrementCount, m_nTimeResolution, chart::ExplicitIncrementData::MajorTimeInterval, chart::ExplicitScaleData::Maximum, chart::MAXIMUM_MANUAL_INCREMENT_COUNT, chart::ExplicitScaleData::Minimum, chart::ExplicitIncrementData::MinorTimeInterval, MONTH, chart::ExplicitIncrementData::PostEquidistant, chart::ExplicitScaleData::Scaling, Date::SetDay(), Date::SetMonth(), chart::ExplicitScaleData::TimeResolution, and YEAR.

Referenced by calculateExplicitScaleAndIncrement().

◆ calculateExplicitIncrementAndScaleForLinear()

void chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLinear	(	ExplicitScaleData &	rExplicitScale,
		ExplicitIncrementData &	rExplicitIncrement,
		bool	bAutoMinimum,
		bool	bAutoMaximum
	)		const

private

Fills the passed scale data and increment data for linear scaling.

Definition at line 737 of file ScaleAutomatism.cxx.

References chart::ExplicitIncrementData::BaseValue, chart::ExplicitIncrementData::Distance, chart::EquidistantTickFactory::getMaximumAtIncrement(), chart::EquidistantTickFactory::getMinimumAtIncrement(), chart::ExplicitSubIncrement::IntervalCount, m_aSourceScale, m_bExpandBorderToIncrementRhythm, m_bExpandIfValuesCloseToBorder, m_bExpandNarrowValuesTowardZero, m_bExpandWideValuesToZero, m_nMaximumAutoMainIncrementCount, chart::ExplicitScaleData::Maximum, chart::MAXIMUM_MANUAL_INCREMENT_COUNT, chart::ExplicitScaleData::Minimum, chart::ExplicitSubIncrement::PostEquidistant, chart::ExplicitIncrementData::PostEquidistant, and chart::ExplicitIncrementData::SubIncrements.

Referenced by calculateExplicitScaleAndIncrement().

◆ calculateExplicitIncrementAndScaleForLogarithmic()

void chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLogarithmic	(	ExplicitScaleData &	rExplicitScale,
		ExplicitIncrementData &	rExplicitIncrement,
		bool	bAutoMinimum,
		bool	bAutoMaximum
	)		const

private

Fills the passed scale data and increment data for logarithmic scaling.

Definition at line 294 of file ScaleAutomatism.cxx.

References chart::ExplicitIncrementData::BaseValue, chart::AxisHelper::createLogarithmicScaling(), chart::ExplicitIncrementData::Distance, chart::EquidistantTickFactory::getMaximumAtIncrement(), chart::EquidistantTickFactory::getMinimumAtIncrement(), chart::ExplicitSubIncrement::IntervalCount, m_aSourceScale, m_bExpandBorderToIncrementRhythm, m_bExpandNarrowValuesTowardZero, m_nMaximumAutoMainIncrementCount, chart::ExplicitScaleData::Maximum, chart::MAXIMUM_MANUAL_INCREMENT_COUNT, chart::ExplicitScaleData::Minimum, chart::ExplicitSubIncrement::PostEquidistant, chart::ExplicitIncrementData::PostEquidistant, chart::ExplicitScaleData::Scaling, and chart::ExplicitIncrementData::SubIncrements.

Referenced by calculateExplicitScaleAndIncrement().

◆ calculateExplicitScaleAndIncrement()

void chart::ScaleAutomatism::calculateExplicitScaleAndIncrement	(	ExplicitScaleData &	rExplicitScale,
		ExplicitIncrementData &	rExplicitIncrement
	)		const

Fills the passed scale data and increment data according to the own settings.

It performs the initialization of the passed explicit scale and explicit increment parameters, mainly the initialization is achieved by using the ScaleData object as data source. However other parameters which affect the behavior of this method can be set through the setAutoScalingOptions and the expandValueRange methods.

Definition at line 158 of file ScaleAutomatism.cxx.

◆ expandValueRange()

void chart::ScaleAutomatism::expandValueRange	(	double	fMinimum,
		double	fMaximum
	)

Expands own value range with the passed minimum and maximum.

It allows to set up the m_fValueMinimum and the m_fValueMaximum parameters which are used by the calculateExplicitScaleAndIncrement method for initializing the Minimum and Maximum properties of the explicit scale when the same properties of the ScaleData object are undefined (that is empty uno::Any objects).

Definition at line 114 of file ScaleAutomatism.cxx.

References m_fValueMaximum, m_fValueMinimum, and resetValueRange().

Referenced by chart::VCoordinateSystem::prepareAutomaticAxisScaling(), and ScaleAutomatism().

◆ getNullDate()

const Date & chart::ScaleAutomatism::getNullDate ( ) const

inline

Definition at line 100 of file ScaleAutomatism.hxx.

References m_aNullDate.

Referenced by chart::VCoordinateSystem::prepareAutomaticAxisScaling().

◆ getScale()

const css::chart2::ScaleData & chart::ScaleAutomatism::getScale ( ) const

inline

Definition at line 99 of file ScaleAutomatism.hxx.

References m_aSourceScale.

Referenced by chart::VCoordinateSystem::prepareAutomaticAxisScaling().

◆ resetValueRange()

void chart::ScaleAutomatism::resetValueRange ( )

Definition at line 108 of file ScaleAutomatism.cxx.

References m_fValueMaximum, and m_fValueMinimum.

Referenced by expandValueRange(), and ScaleAutomatism().

◆ setAutomaticTimeResolution()

void chart::ScaleAutomatism::setAutomaticTimeResolution ( sal_Int32 nTimeResolution )

Sets the time resolution to be used in case it is not set explicitly within the scale.

Definition at line 153 of file ScaleAutomatism.cxx.

References m_nTimeResolution.

Referenced by chart::VCoordinateSystem::prepareAutomaticAxisScaling().

◆ setAutoScalingOptions()

void chart::ScaleAutomatism::setAutoScalingOptions	(	bool	bExpandBorderToIncrementRhythm,
		bool	bExpandIfValuesCloseToBorder,
		bool	bExpandWideValuesToZero,
		bool	bExpandNarrowValuesTowardZero
	)

Sets additional auto scaling options.

Parameters

bExpandBorderToIncrementRhythm	If true, expands automatic borders to the fixed or calculated increment rhythm.
bExpandIfValuesCloseToBorder	If true, expands automatic borders if values are too close (closer than 1/21 of visible area).
bExpandWideValuesToZero	If true, expands automatic border to zero, if source values are positive only or negative only, and if the absolute values are wide spread (at least one value is less than 5/6 of absolute maximum), or if all values are equal.
bExpandNarrowValuesTowardZero	If true, expands automatic border toward zero (50% of the visible range), if source values are positive only or negative only, and if the absolute values are close to the absolute maximum (no value is less than 5/6 of absolute maximum).

Definition at line 127 of file ScaleAutomatism.cxx.

References m_aSourceScale, m_bExpandBorderToIncrementRhythm, m_bExpandIfValuesCloseToBorder, m_bExpandNarrowValuesTowardZero, and m_bExpandWideValuesToZero.

Referenced by chart::VCoordinateSystem::prepareAutomaticAxisScaling().

◆ setMaximumAutoMainIncrementCount()

void chart::ScaleAutomatism::setMaximumAutoMainIncrementCount ( sal_Int32 nMaximumAutoMainIncrementCount )

Sets the maximum allowed number of automatic main increments.

@descr The number of main increments may be limited e.g. by the length of the axis and the font size of the axis caption text.

Definition at line 143 of file ScaleAutomatism.cxx.

References chart::lcl_getMaximumAutoIncrementCount(), m_aSourceScale, and m_nMaximumAutoMainIncrementCount.

Referenced by chart::VCoordinateSystem::prepareAutomaticAxisScaling().

Member Data Documentation

◆ m_aNullDate

Date chart::ScaleAutomatism::m_aNullDate

private

Definition at line 139 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitIncrementAndScaleForDateTimeAxis(), calculateExplicitScaleAndIncrement(), and getNullDate().

◆ m_aSourceScale

css::chart2::ScaleData chart::ScaleAutomatism::m_aSourceScale

private

Definition at line 128 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitIncrementAndScaleForCategory(), calculateExplicitIncrementAndScaleForDateTimeAxis(), calculateExplicitIncrementAndScaleForLinear(), calculateExplicitIncrementAndScaleForLogarithmic(), calculateExplicitScaleAndIncrement(), getScale(), ScaleAutomatism(), setAutoScalingOptions(), and setMaximumAutoMainIncrementCount().

◆ m_bExpandBorderToIncrementRhythm

bool chart::ScaleAutomatism::m_bExpandBorderToIncrementRhythm

private

Maximum number of automatic main increments.

Definition at line 133 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitIncrementAndScaleForCategory(), calculateExplicitIncrementAndScaleForLinear(), calculateExplicitIncrementAndScaleForLogarithmic(), and setAutoScalingOptions().

◆ m_bExpandIfValuesCloseToBorder

bool chart::ScaleAutomatism::m_bExpandIfValuesCloseToBorder

private

true = Expand to main increments.

Definition at line 134 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitIncrementAndScaleForLinear(), and setAutoScalingOptions().

◆ m_bExpandNarrowValuesTowardZero

bool chart::ScaleAutomatism::m_bExpandNarrowValuesTowardZero

private

true = Expand wide spread values to zero.

Definition at line 136 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitIncrementAndScaleForLinear(), calculateExplicitIncrementAndScaleForLogarithmic(), and setAutoScalingOptions().

◆ m_bExpandWideValuesToZero

bool chart::ScaleAutomatism::m_bExpandWideValuesToZero

private

true = Expand if values are too close to the borders.

Definition at line 135 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitIncrementAndScaleForLinear(), and setAutoScalingOptions().

◆ m_fValueMaximum

double chart::ScaleAutomatism::m_fValueMaximum

private

Minimum of all source values.

Definition at line 131 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitScaleAndIncrement(), expandValueRange(), and resetValueRange().

◆ m_fValueMinimum

double chart::ScaleAutomatism::m_fValueMinimum

private

Definition at line 130 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitScaleAndIncrement(), expandValueRange(), and resetValueRange().

◆ m_nMaximumAutoMainIncrementCount

sal_Int32 chart::ScaleAutomatism::m_nMaximumAutoMainIncrementCount

private

Maximum of all source values.

Definition at line 132 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitIncrementAndScaleForDateTimeAxis(), calculateExplicitIncrementAndScaleForLinear(), calculateExplicitIncrementAndScaleForLogarithmic(), and setMaximumAutoMainIncrementCount().

◆ m_nTimeResolution

sal_Int32 chart::ScaleAutomatism::m_nTimeResolution

private

true = Expand narrow range toward zero (add half of range).

Definition at line 137 of file ScaleAutomatism.hxx.

Referenced by calculateExplicitIncrementAndScaleForDateTimeAxis(), and setAutomaticTimeResolution().

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ScaleAutomatism()

Member Function Documentation

◆ calculateExplicitIncrementAndScaleForCategory()

◆ calculateExplicitIncrementAndScaleForDateTimeAxis()

◆ calculateExplicitIncrementAndScaleForLinear()

◆ calculateExplicitIncrementAndScaleForLogarithmic()

◆ calculateExplicitScaleAndIncrement()

◆ expandValueRange()

◆ getNullDate()

◆ getScale()

◆ resetValueRange()

◆ setAutomaticTimeResolution()

◆ setAutoScalingOptions()

◆ setMaximumAutoMainIncrementCount()

Member Data Documentation

◆ m_aNullDate

◆ m_aSourceScale

◆ m_bExpandBorderToIncrementRhythm

◆ m_bExpandIfValuesCloseToBorder

◆ m_bExpandNarrowValuesTowardZero

◆ m_bExpandWideValuesToZero

◆ m_fValueMaximum

◆ m_fValueMinimum

◆ m_nMaximumAutoMainIncrementCount

◆ m_nTimeResolution