LibreOffice Module chart2 (master) 1
Public Member Functions | Public Attributes | List of all members
chart::ExplicitIncrementData Struct Reference

describes how tickmarks are positioned on the scale of an axis. More...

#include <ExplicitScaleValues.hxx>

Public Member Functions

 ExplicitIncrementData ()
 

Public Attributes

css::chart::TimeInterval MajorTimeInterval
 the following two members are only for date-time axis More...
 
css::chart::TimeInterval MinorTimeInterval
 
double Distance
 the other members are for not date-time axis More...
 
bool PostEquidistant
 <member>PostEquidistant</member> rules whether the member <member>Distance</member> describes a distance before or after the scaling is applied. More...
 
double BaseValue
 The <member>BaseValue</member> gives a starting point on the scale to which all further main tickmarks are relatively positioned. More...
 
std::vector< ExplicitSubIncrementSubIncrements
 <member>SubIncrements</member> describes the positioning of further sub tickmarks on the scale of an axis. More...
 

Detailed Description

describes how tickmarks are positioned on the scale of an axis.

Definition at line 76 of file ExplicitScaleValues.hxx.

Constructor & Destructor Documentation

◆ ExplicitIncrementData()

chart::ExplicitIncrementData::ExplicitIncrementData ( )

Definition at line 80 of file ScaleAutomatism.cxx.

References DAY, and Distance.

Member Data Documentation

◆ BaseValue

double chart::ExplicitIncrementData::BaseValue

The <member>BaseValue</member> gives a starting point on the scale to which all further main tickmarks are relatively positioned.

The <member>BaseValue</member> is always a value on the scale before a possible scaling is applied. If the given value is not valid in the associated scaling the minimum of the scaling is assumed, if there is no minimum any other obvious value will be assumed.

E.g.: assume a scale from 0 to 6 with identical scaling. Further assume this Increment to have Distance==2 and PostEquidistant==false. Setting BaseValue=0 would lead to main tickmarks 0; 2; 4; 6; Setting BaseValue=1,3 would lead to main tickmarks 1,3; 3,3; 5,3; Setting BaseValue=-0,7 would also lead to main tickmarks 1,3; 3,3; 5,3; And setting BaseValue to 2, -2, 4, -4 etc. in this example leads to the same result as BaseValue=0.

Definition at line 138 of file ExplicitScaleValues.hxx.

Referenced by chart::SeriesPlotterContainer::AdaptScaleOfYAxisWithoutAttachedSeries(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForCategory(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLinear(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLogarithmic(), chart::EquidistantTickFactory::getAllTicksShifted(), chart::EquidistantTickFactory::getMaximumAtIncrement(), and chart::EquidistantTickFactory::getMinimumAtIncrement().

◆ Distance

double chart::ExplicitIncrementData::Distance

the other members are for not date-time axis

<member>Distance</member> describes the distance between two neighboring main tickmarks on a <type>Scale</type> of an axis. All neighboring main tickmarks have the same constant distance.

If the Scale has a <type>XScaling</type> the <member>Distance</member> may be measured in two different ways - that is - before or after the scaling is applied.

On a logarithmic scale for example the distance between two main tickmarks is typically measured after the scaling is applied: Distance = log(tick2)-log(tick1) ( log(1000)-log(100)==log(100)-log(10)==log(10)-log(1)==1==Distance ). The resulting tickmarks will always look equidistant on the screen. The other possibility is to have a Distance = tick2-tick1 measured constant before a scaling is applied, which may lead to non equidistant tickmarks on the screen.

<member>PostEquidistant</member> rules whether the <member>Distance</member> is meant to be a value before or after scaling.

Definition at line 108 of file ExplicitScaleValues.hxx.

Referenced by chart::SeriesPlotterContainer::AdaptScaleOfYAxisWithoutAttachedSeries(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForCategory(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLinear(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLogarithmic(), chart::EquidistantTickFactory::EquidistantTickFactory(), chart::EquidistantTickFactory::getAllTicksShifted(), chart::InsertErrorBarsDialog::getAxisMinorStepWidthForErrorBarDecimals(), chart::EquidistantTickFactory::getMajorTick(), chart::EquidistantTickFactory::getMaximumAtIncrement(), chart::EquidistantTickFactory::getMaxTickCount(), and chart::EquidistantTickFactory::getMinimumAtIncrement().

◆ MajorTimeInterval

css::chart::TimeInterval chart::ExplicitIncrementData::MajorTimeInterval

the following two members are only for date-time axis

Definition at line 82 of file ExplicitScaleValues.hxx.

Referenced by chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForDateTimeAxis(), and chart::DateTickFactory::getAllTicks().

◆ MinorTimeInterval

css::chart::TimeInterval chart::ExplicitIncrementData::MinorTimeInterval

◆ PostEquidistant

bool chart::ExplicitIncrementData::PostEquidistant

<member>PostEquidistant</member> rules whether the member <member>Distance</member> describes a distance before or after the scaling is applied.

If <member>PostEquidistant</member> equals <TRUE> <member>Distance</member> is given in values after <type>XScaling</type> is applied, thus resulting main tickmarks will always look equidistant on the screen. If <member>PostEquidistant</member> equals <FALSE> <member>Distance</member> is given in values before <type>XScaling</type> is applied.

Definition at line 120 of file ExplicitScaleValues.hxx.

Referenced by chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForCategory(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForDateTimeAxis(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLinear(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLogarithmic(), chart::EquidistantTickFactory::EquidistantTickFactory(), chart::EquidistantTickFactory::getMajorTick(), and chart::EquidistantTickFactory::getMaxTickCount().

◆ SubIncrements

std::vector<ExplicitSubIncrement> chart::ExplicitIncrementData::SubIncrements

<member>SubIncrements</member> describes the positioning of further sub tickmarks on the scale of an axis.

The first SubIncrement in this sequence determines how the distance between two neighboring main tickmarks is divided for positioning of further sub tickmarks. Every following SubIncrement determines the positions of subsequent tickmarks in relation to their parent tickmarks given by the preceding SubIncrement.

Definition at line 149 of file ExplicitScaleValues.hxx.

Referenced by chart::SeriesPlotterContainer::AdaptScaleOfYAxisWithoutAttachedSeries(), chart::EquidistantTickFactory::addSubTicks(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForCategory(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLinear(), chart::ScaleAutomatism::calculateExplicitIncrementAndScaleForLogarithmic(), chart::EquidistantTickFactory::getAllTicks(), chart::InsertErrorBarsDialog::getAxisMinorStepWidthForErrorBarDecimals(), chart::EquidistantTickIter::getIntervalCount(), chart::EquidistantTickFactory::getMaxTickCount(), chart::EquidistantTickFactory::getMinorTick(), and chart::EquidistantTickFactory::getTickDepth().


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