Workspace 6.21.5
Public Types | Public Member Functions | Public Attributes | List of all members
AxisSettings Class Reference

Stores axis-specific settings for a single axis (X or Y). More...

#include <DataAnalysis/Plot2D/axissettings.h>

Inheritance diagram for AxisSettings:
[legend]

Public Types

enum  ScaleType { Linear , Log10 , Log2 }
 Specifies what scale to use for the axis. More...
 
enum  TickLabelNumberFormat { Auto , Decimal , Scientific }
 Specifies the format to use for numeric tick mark labels. More...
 

Public Member Functions

 AxisSettings ()
 
 AxisSettings (const AxisSettings &axisSettings)
 
AxisSettingsclone () const override
 
- Public Member Functions inherited from ObjectGroup
 ~ObjectGroup () override
 
bool add (const QString &name, DataObject &obj)
 
bool canSerialize () const override
 
ObjectGroupclone () const override=0
 
bool empty () const
 
void ensureGroupHasData ()
 
void erase (int index)
 
DataObjectgetChild (const QString &name)
 
const DataObjectgetChild (const QString &name) const
 
DataObjectgetDataObject (int index)
 
const DataObjectgetDataObject (int index) const
 
int getIndex (const QString &name) const
 
const QString & getName (int index) const
 
virtual QString getPreferedWidget (const QString &name) const
 
bool hasData () const
 
bool haveName (const QString &name) const
 
bool insert (const QString &name, DataObject &obj, int index=-1)
 
bool load (const QJsonDocument &doc)
 
bool load (const SerializedItem &item) override
 
bool save (QJsonDocument &doc) const
 
bool save (SerializedItem &item) const override
 
unsigned size () const
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()=default
 
virtual Clonableclone () const =0
 
- Public Member Functions inherited from Serialize
virtual ~Serialize ()=default
 
virtual bool canSerialize () const =0
 
virtual bool load (const SerializedItem &item)=0
 
virtual bool save (SerializedItem &item) const =0
 

Public Attributes

DataExecution::TypedObject< bool > autoLimitBasedOnOtherAxisRange
 
DataExecution::TypedObject< bool > autoMaximum
 
DataExecution::TypedObject< bool > autoMinimum
 
DataExecution::TypedObject< double > axisMaximum
 
DataExecution::TypedObject< double > axisMinimum
 
DataExecution::TypedObject< QStringListcustomTickLabels
 
DataExecution::TypedObject< QString > label
 
DataExecution::TypedObject< int > numberMajorTicks
 
DataExecution::TypedObject< int > numberMinorTicks
 
DataExecution::TypedObject< ScaleTypescaleType
 
DataExecution::TypedObject< bool > showGridLines
 
DataExecution::TypedObject< bool > showMajorTicks
 
DataExecution::TypedObject< bool > showMinorTicks
 
DataExecution::TypedObject< bool > showTickLabels
 
DataExecution::TypedObject< TickLabelNumberFormattickLabelNumberFormat
 
DataExecution::TypedObject< int > tickLabelPrecision
 
DataExecution::TypedObject< bool > useTightAutoLimits
 

Additional Inherited Members

- Protected Member Functions inherited from ObjectGroup
 ObjectGroup ()
 
void clear ()
 
ObjectGroupoperator= (const ObjectGroup &rhs)
 
bool operator== (const ObjectGroup &rhs) const
 
void swap (ObjectGroup &rhs)
 

Detailed Description

See also
Plot

Member Enumeration Documentation

◆ ScaleType

enum ScaleType
Enumerator
Linear 

Standard linear scale.

Log10 

Standard base-10 logarithmic scale. Major axis ticks will always line up with powers of 10.

Log2 

Base-2 logarithmic scale. Major axis ticks will always line up with powers of 2.

◆ TickLabelNumberFormat

Enumerator
Auto 

The number format will be chosen on a number-by-number basis to minimise the length of the string. The format will be either floating point or scientific notation.

Decimal 

Numbers will be shown in fixed point notation.

Scientific 

Numbers will be shown in scientific (ie exponential) notation.

Constructor & Destructor Documentation

◆ AxisSettings() [1/2]

◆ AxisSettings() [2/2]

AxisSettings ( const AxisSettings axisSettings)

Member Function Documentation

◆ clone()

AxisSettings * clone ( ) const
overridevirtual
Returns
A clone of this object.
Note
Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

We redeclare this function only so that the more derived return type is available without casting.

Implements ObjectGroup.

Member Data Documentation

◆ autoLimitBasedOnOtherAxisRange

DataExecution::TypedObject<bool> autoLimitBasedOnOtherAxisRange

◆ autoMaximum

DataExecution::TypedObject<bool> autoMaximum

◆ autoMinimum

DataExecution::TypedObject<bool> autoMinimum

◆ axisMaximum

DataExecution::TypedObject<double> axisMaximum

◆ axisMinimum

DataExecution::TypedObject<double> axisMinimum

◆ customTickLabels

◆ label

◆ numberMajorTicks

DataExecution::TypedObject<int> numberMajorTicks

◆ numberMinorTicks

DataExecution::TypedObject<int> numberMinorTicks

◆ scaleType

◆ showGridLines

DataExecution::TypedObject<bool> showGridLines

◆ showMajorTicks

DataExecution::TypedObject<bool> showMajorTicks

◆ showMinorTicks

DataExecution::TypedObject<bool> showMinorTicks

◆ showTickLabels

DataExecution::TypedObject<bool> showTickLabels

◆ tickLabelNumberFormat

◆ tickLabelPrecision

DataExecution::TypedObject<int> tickLabelPrecision

◆ useTightAutoLimits

DataExecution::TypedObject<bool> useTightAutoLimits