SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmmvis::plot::SeriesStyleObject Class Reference

#include <seriesstyleobject.h>

Inheritance diagram for openswmmvis::plot::SeriesStyleObject:
Collaboration diagram for openswmmvis::plot::SeriesStyleObject:

Public Types

enum class  MarkerShapeQ : int {
  Circle = static_cast<int>(MarkerShape::Circle) ,
  Square = static_cast<int>(MarkerShape::Square) ,
  Triangle = static_cast<int>(MarkerShape::Triangle) ,
  Diamond = static_cast<int>(MarkerShape::Diamond) ,
  Cross = static_cast<int>(MarkerShape::Cross) ,
  Plus = static_cast<int>(MarkerShape::Plus)
}
 A Q_ENUM-registered mirror of MarkerShape so QPropertyModel can render a combo-box for it. Q_ENUM requires the enum to live in a QObject, hence this duplicate. Values are kept in sync 1:1. More...
 
enum class  LabelFormatModeQ : int {
  Decimals = static_cast<int>(NumberFormatMode::Decimals) ,
  SignificantFigures = static_cast<int>(NumberFormatMode::SignificantFigures)
}
 Q_ENUM mirror of NumberFormatMode so QPropertyModel can render a combo-box for the point-label number format. Values track NumberFormatMode 1:1. More...
 

Public Slots

void setColor (const QColor &c)
 
void setOpacity (qreal v)
 
void setLegendName (const QString &s)
 
void setLegendOverride (const QString &s)
 
void setShowLine (bool on)
 
void setLineWidth (qreal v)
 
void setDash (Qt::PenStyle s)
 
void setCapStyle (Qt::PenCapStyle s)
 
void setJoinStyle (Qt::PenJoinStyle s)
 
void setShowMarkers (bool on)
 
void setShape (MarkerShapeQ s)
 
void setMarkerSize (qreal v)
 
void setMarkerFillColor (const QColor &c)
 
void setMarkerBorderColor (const QColor &c)
 
void setMarkerBorderWidth (qreal v)
 
void setShowPointLabels (bool on)
 
void setPointLabelFont (const QFont &f)
 
void setPointLabelColor (const QColor &c)
 
void setPointLabelFormatMode (LabelFormatModeQ m)
 
void setPointLabelPrecision (int n)
 
void setPointLabelFormat (const QString &spec)
 
void setShowAreaFill (bool on)
 
void setAreaFillColor (const QColor &c)
 

Signals

void colorChanged (const QColor &)
 
void opacityChanged (qreal)
 
void legendNameChanged (const QString &)
 
void legendOverrideChanged (const QString &)
 
void showLineChanged (bool)
 
void lineWidthChanged (qreal)
 
void dashChanged (Qt::PenStyle)
 
void capStyleChanged (Qt::PenCapStyle)
 
void joinStyleChanged (Qt::PenJoinStyle)
 
void showMarkersChanged (bool)
 
void shapeChanged (MarkerShapeQ)
 
void markerSizeChanged (qreal)
 
void markerFillColorChanged (const QColor &)
 
void markerBorderColorChanged (const QColor &)
 
void markerBorderWidthChanged (qreal)
 
void showPointLabelsChanged (bool)
 
void pointLabelFontChanged (const QFont &)
 
void pointLabelColorChanged (const QColor &)
 
void pointLabelFormatModeChanged (LabelFormatModeQ)
 
void pointLabelPrecisionChanged (int)
 
void pointLabelFormatChanged (const QString &)
 
void showAreaFillChanged (bool)
 
void areaFillColorChanged (const QColor &)
 
void styleChanged (const openswmmvis::plot::SeriesStyle &s)
 Aggregate change signal — fires after every per-field setter. Hosts subscribe to this once to live-update the chart.
 

Public Member Functions

 SeriesStyleObject (QObject *parent=nullptr)
 
 SeriesStyleObject (const SeriesStyle &initial, QObject *parent=nullptr)
 
 ~SeriesStyleObject () override=default
 
SeriesStyle style () const noexcept
 Snapshot of the current style.
 
void setStyle (const SeriesStyle &s)
 Replace every field at once. Emits per-field NOTIFYs that actually differ from the previous values, then the aggregate styleChanged() signal once.
 
QString legendOverride () const
 Spec-level legend override (mirrors SeriesSpec::legendOverride).
 
Q_INVOKABLE QString displayLabelFor (const QString &propertyName) const
 Human-friendly, group-prefixed label for the QPropertyModel tree. Returns labels like "Line — Width", "Marker — Fill Colour". Returns an empty string for unknown property names so the default generated name is used. Mirrors ChartProperties::displayLabelFor.
 
QColor color () const noexcept
 
qreal opacity () const noexcept
 
QString legendName () const
 
bool showLine () const noexcept
 
qreal lineWidth () const noexcept
 
Qt::PenStyle dash () const noexcept
 
Qt::PenCapStyle capStyle () const noexcept
 
Qt::PenJoinStyle joinStyle () const noexcept
 
bool showMarkers () const noexcept
 
MarkerShapeQ shape () const noexcept
 
qreal markerSize () const noexcept
 
QColor markerFillColor () const noexcept
 
QColor markerBorderColor () const noexcept
 
qreal markerBorderWidth () const noexcept
 
bool showPointLabels () const noexcept
 
QFont pointLabelFont () const noexcept
 
QColor pointLabelColor () const noexcept
 
LabelFormatModeQ pointLabelFormatMode () const noexcept
 
int pointLabelPrecision () const noexcept
 
QString pointLabelFormat () const
 
bool showAreaFill () const noexcept
 
QColor areaFillColor () const noexcept
 

Properties

QColor color
 
qreal opacity
 
QString legendName
 
QString legendOverride
 
bool showLine
 
qreal lineWidth
 
Qt::PenStyle dash
 
Qt::PenCapStyle capStyle
 
Qt::PenJoinStyle joinStyle
 
bool showMarkers
 
MarkerShapeQ shape
 
qreal markerSize
 
QColor markerFillColor
 
QColor markerBorderColor
 
qreal markerBorderWidth
 
bool showPointLabels
 
QFont pointLabelFont
 
QColor pointLabelColor
 
LabelFormatModeQ pointLabelFormatMode
 
int pointLabelPrecision
 
QString pointLabelFormat
 
bool showAreaFill
 
QColor areaFillColor
 

Member Enumeration Documentation

◆ LabelFormatModeQ

Q_ENUM mirror of NumberFormatMode so QPropertyModel can render a combo-box for the point-label number format. Values track NumberFormatMode 1:1.

Enumerator
Decimals 
SignificantFigures 

◆ MarkerShapeQ

A Q_ENUM-registered mirror of MarkerShape so QPropertyModel can render a combo-box for it. Q_ENUM requires the enum to live in a QObject, hence this duplicate. Values are kept in sync 1:1.

Enumerator
Circle 
Square 
Triangle 
Diamond 
Cross 
Plus 

Constructor & Destructor Documentation

◆ SeriesStyleObject() [1/2]

openswmmvis::plot::SeriesStyleObject::SeriesStyleObject ( QObject *  parent = nullptr)
explicit

◆ SeriesStyleObject() [2/2]

openswmmvis::plot::SeriesStyleObject::SeriesStyleObject ( const SeriesStyle initial,
QObject *  parent = nullptr 
)
explicit

◆ ~SeriesStyleObject()

openswmmvis::plot::SeriesStyleObject::~SeriesStyleObject ( )
overridedefault

Member Function Documentation

◆ areaFillColor()

QColor openswmmvis::plot::SeriesStyleObject::areaFillColor ( ) const
inlinenoexcept

◆ areaFillColorChanged

void openswmmvis::plot::SeriesStyleObject::areaFillColorChanged ( const QColor &  )
signal

◆ capStyle()

Qt::PenCapStyle openswmmvis::plot::SeriesStyleObject::capStyle ( ) const
inlinenoexcept

◆ capStyleChanged

void openswmmvis::plot::SeriesStyleObject::capStyleChanged ( Qt::PenCapStyle  )
signal

◆ color()

QColor openswmmvis::plot::SeriesStyleObject::color ( ) const
inlinenoexcept

◆ colorChanged

void openswmmvis::plot::SeriesStyleObject::colorChanged ( const QColor &  )
signal

◆ dash()

Qt::PenStyle openswmmvis::plot::SeriesStyleObject::dash ( ) const
inlinenoexcept

◆ dashChanged

void openswmmvis::plot::SeriesStyleObject::dashChanged ( Qt::PenStyle  )
signal

◆ displayLabelFor()

QString openswmmvis::plot::SeriesStyleObject::displayLabelFor ( const QString &  propertyName) const

Human-friendly, group-prefixed label for the QPropertyModel tree. Returns labels like "Line — Width", "Marker — Fill Colour". Returns an empty string for unknown property names so the default generated name is used. Mirrors ChartProperties::displayLabelFor.

◆ joinStyle()

Qt::PenJoinStyle openswmmvis::plot::SeriesStyleObject::joinStyle ( ) const
inlinenoexcept

◆ joinStyleChanged

void openswmmvis::plot::SeriesStyleObject::joinStyleChanged ( Qt::PenJoinStyle  )
signal

◆ legendName()

QString openswmmvis::plot::SeriesStyleObject::legendName ( ) const
inline

◆ legendNameChanged

void openswmmvis::plot::SeriesStyleObject::legendNameChanged ( const QString &  )
signal

◆ legendOverride()

QString openswmmvis::plot::SeriesStyleObject::legendOverride ( ) const
inline

Spec-level legend override (mirrors SeriesSpec::legendOverride).

Distinct from the style-level legendName above:

  • legendName lives in SeriesStyle (per-style, JSON-persisted).
  • legendOverride lives in SeriesSpec (per-series instance, used by the Comparison Plot dialog as the canonical "what to call this series").

Stored on this object so the QPropertyModel-backed editor can edit it alongside the style fields; not part of m_style, so it never enters style() and never fires styleChanged(). Hosts read it via legendOverride() and subscribe to legendOverrideChanged().

◆ legendOverrideChanged

void openswmmvis::plot::SeriesStyleObject::legendOverrideChanged ( const QString &  )
signal
Here is the caller graph for this function:

◆ lineWidth()

qreal openswmmvis::plot::SeriesStyleObject::lineWidth ( ) const
inlinenoexcept

◆ lineWidthChanged

void openswmmvis::plot::SeriesStyleObject::lineWidthChanged ( qreal  )
signal

◆ markerBorderColor()

QColor openswmmvis::plot::SeriesStyleObject::markerBorderColor ( ) const
inlinenoexcept

◆ markerBorderColorChanged

void openswmmvis::plot::SeriesStyleObject::markerBorderColorChanged ( const QColor &  )
signal

◆ markerBorderWidth()

qreal openswmmvis::plot::SeriesStyleObject::markerBorderWidth ( ) const
inlinenoexcept

◆ markerBorderWidthChanged

void openswmmvis::plot::SeriesStyleObject::markerBorderWidthChanged ( qreal  )
signal

◆ markerFillColor()

QColor openswmmvis::plot::SeriesStyleObject::markerFillColor ( ) const
inlinenoexcept

◆ markerFillColorChanged

void openswmmvis::plot::SeriesStyleObject::markerFillColorChanged ( const QColor &  )
signal

◆ markerSize()

qreal openswmmvis::plot::SeriesStyleObject::markerSize ( ) const
inlinenoexcept

◆ markerSizeChanged

void openswmmvis::plot::SeriesStyleObject::markerSizeChanged ( qreal  )
signal

◆ opacity()

qreal openswmmvis::plot::SeriesStyleObject::opacity ( ) const
inlinenoexcept

◆ opacityChanged

void openswmmvis::plot::SeriesStyleObject::opacityChanged ( qreal  )
signal

◆ pointLabelColor()

QColor openswmmvis::plot::SeriesStyleObject::pointLabelColor ( ) const
inlinenoexcept

◆ pointLabelColorChanged

void openswmmvis::plot::SeriesStyleObject::pointLabelColorChanged ( const QColor &  )
signal

◆ pointLabelFont()

QFont openswmmvis::plot::SeriesStyleObject::pointLabelFont ( ) const
inlinenoexcept

◆ pointLabelFontChanged

void openswmmvis::plot::SeriesStyleObject::pointLabelFontChanged ( const QFont &  )
signal

◆ pointLabelFormat()

QString openswmmvis::plot::SeriesStyleObject::pointLabelFormat ( ) const
inline

◆ pointLabelFormatChanged

void openswmmvis::plot::SeriesStyleObject::pointLabelFormatChanged ( const QString &  )
signal

◆ pointLabelFormatMode()

LabelFormatModeQ openswmmvis::plot::SeriesStyleObject::pointLabelFormatMode ( ) const
inlinenoexcept

◆ pointLabelFormatModeChanged

void openswmmvis::plot::SeriesStyleObject::pointLabelFormatModeChanged ( LabelFormatModeQ  )
signal
Here is the caller graph for this function:

◆ pointLabelPrecision()

int openswmmvis::plot::SeriesStyleObject::pointLabelPrecision ( ) const
inlinenoexcept

◆ pointLabelPrecisionChanged

void openswmmvis::plot::SeriesStyleObject::pointLabelPrecisionChanged ( int  )
signal

◆ setAreaFillColor

void openswmmvis::plot::SeriesStyleObject::setAreaFillColor ( const QColor &  c)
slot
Here is the caller graph for this function:

◆ setCapStyle

void openswmmvis::plot::SeriesStyleObject::setCapStyle ( Qt::PenCapStyle  s)
slot
Here is the caller graph for this function:

◆ setColor

void openswmmvis::plot::SeriesStyleObject::setColor ( const QColor &  c)
slot
Here is the caller graph for this function:

◆ setDash

void openswmmvis::plot::SeriesStyleObject::setDash ( Qt::PenStyle  s)
slot
Here is the caller graph for this function:

◆ setJoinStyle

void openswmmvis::plot::SeriesStyleObject::setJoinStyle ( Qt::PenJoinStyle  s)
slot
Here is the caller graph for this function:

◆ setLegendName

void openswmmvis::plot::SeriesStyleObject::setLegendName ( const QString &  s)
slot
Here is the caller graph for this function:

◆ setLegendOverride

void openswmmvis::plot::SeriesStyleObject::setLegendOverride ( const QString &  s)
slot
Here is the caller graph for this function:

◆ setLineWidth

void openswmmvis::plot::SeriesStyleObject::setLineWidth ( qreal  v)
slot
Here is the caller graph for this function:

◆ setMarkerBorderColor

void openswmmvis::plot::SeriesStyleObject::setMarkerBorderColor ( const QColor &  c)
slot
Here is the caller graph for this function:

◆ setMarkerBorderWidth

void openswmmvis::plot::SeriesStyleObject::setMarkerBorderWidth ( qreal  v)
slot
Here is the caller graph for this function:

◆ setMarkerFillColor

void openswmmvis::plot::SeriesStyleObject::setMarkerFillColor ( const QColor &  c)
slot
Here is the caller graph for this function:

◆ setMarkerSize

void openswmmvis::plot::SeriesStyleObject::setMarkerSize ( qreal  v)
slot
Here is the caller graph for this function:

◆ setOpacity

void openswmmvis::plot::SeriesStyleObject::setOpacity ( qreal  v)
slot
Here is the caller graph for this function:

◆ setPointLabelColor

void openswmmvis::plot::SeriesStyleObject::setPointLabelColor ( const QColor &  c)
slot
Here is the caller graph for this function:

◆ setPointLabelFont

void openswmmvis::plot::SeriesStyleObject::setPointLabelFont ( const QFont &  f)
slot
Here is the caller graph for this function:

◆ setPointLabelFormat

void openswmmvis::plot::SeriesStyleObject::setPointLabelFormat ( const QString &  spec)
slot
Here is the caller graph for this function:

◆ setPointLabelFormatMode

void openswmmvis::plot::SeriesStyleObject::setPointLabelFormatMode ( LabelFormatModeQ  m)
slot
Here is the call graph for this function:
Here is the caller graph for this function:

◆ setPointLabelPrecision

void openswmmvis::plot::SeriesStyleObject::setPointLabelPrecision ( int  n)
slot
Here is the caller graph for this function:

◆ setShape

void openswmmvis::plot::SeriesStyleObject::setShape ( MarkerShapeQ  s)
slot
Here is the call graph for this function:
Here is the caller graph for this function:

◆ setShowAreaFill

void openswmmvis::plot::SeriesStyleObject::setShowAreaFill ( bool  on)
slot
Here is the caller graph for this function:

◆ setShowLine

void openswmmvis::plot::SeriesStyleObject::setShowLine ( bool  on)
slot
Here is the caller graph for this function:

◆ setShowMarkers

void openswmmvis::plot::SeriesStyleObject::setShowMarkers ( bool  on)
slot
Here is the caller graph for this function:

◆ setShowPointLabels

void openswmmvis::plot::SeriesStyleObject::setShowPointLabels ( bool  on)
slot
Here is the caller graph for this function:

◆ setStyle()

void openswmmvis::plot::SeriesStyleObject::setStyle ( const SeriesStyle s)

Replace every field at once. Emits per-field NOTIFYs that actually differ from the previous values, then the aggregate styleChanged() signal once.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ shape()

MarkerShapeQ openswmmvis::plot::SeriesStyleObject::shape ( ) const
inlinenoexcept

◆ shapeChanged

void openswmmvis::plot::SeriesStyleObject::shapeChanged ( MarkerShapeQ  )
signal
Here is the caller graph for this function:

◆ showAreaFill()

bool openswmmvis::plot::SeriesStyleObject::showAreaFill ( ) const
inlinenoexcept

◆ showAreaFillChanged

void openswmmvis::plot::SeriesStyleObject::showAreaFillChanged ( bool  )
signal

◆ showLine()

bool openswmmvis::plot::SeriesStyleObject::showLine ( ) const
inlinenoexcept

◆ showLineChanged

void openswmmvis::plot::SeriesStyleObject::showLineChanged ( bool  )
signal

◆ showMarkers()

bool openswmmvis::plot::SeriesStyleObject::showMarkers ( ) const
inlinenoexcept

◆ showMarkersChanged

void openswmmvis::plot::SeriesStyleObject::showMarkersChanged ( bool  )
signal

◆ showPointLabels()

bool openswmmvis::plot::SeriesStyleObject::showPointLabels ( ) const
inlinenoexcept

◆ showPointLabelsChanged

void openswmmvis::plot::SeriesStyleObject::showPointLabelsChanged ( bool  )
signal

◆ style()

SeriesStyle openswmmvis::plot::SeriesStyleObject::style ( ) const
inlinenoexcept

Snapshot of the current style.

Here is the caller graph for this function:

◆ styleChanged

void openswmmvis::plot::SeriesStyleObject::styleChanged ( const openswmmvis::plot::SeriesStyle s)
signal

Aggregate change signal — fires after every per-field setter. Hosts subscribe to this once to live-update the chart.

Here is the caller graph for this function:

Property Documentation

◆ areaFillColor

QColor openswmmvis::plot::SeriesStyleObject::areaFillColor
readwrite

◆ capStyle

Qt::PenCapStyle openswmmvis::plot::SeriesStyleObject::capStyle
readwrite

◆ color

QColor openswmmvis::plot::SeriesStyleObject::color
readwrite

◆ dash

Qt::PenStyle openswmmvis::plot::SeriesStyleObject::dash
readwrite

◆ joinStyle

Qt::PenJoinStyle openswmmvis::plot::SeriesStyleObject::joinStyle
readwrite

◆ legendName

QString openswmmvis::plot::SeriesStyleObject::legendName
readwrite

◆ legendOverride

QString openswmmvis::plot::SeriesStyleObject::legendOverride
readwrite

◆ lineWidth

qreal openswmmvis::plot::SeriesStyleObject::lineWidth
readwrite

◆ markerBorderColor

QColor openswmmvis::plot::SeriesStyleObject::markerBorderColor
readwrite

◆ markerBorderWidth

qreal openswmmvis::plot::SeriesStyleObject::markerBorderWidth
readwrite

◆ markerFillColor

QColor openswmmvis::plot::SeriesStyleObject::markerFillColor
readwrite

◆ markerSize

qreal openswmmvis::plot::SeriesStyleObject::markerSize
readwrite

◆ opacity

qreal openswmmvis::plot::SeriesStyleObject::opacity
readwrite

◆ pointLabelColor

QColor openswmmvis::plot::SeriesStyleObject::pointLabelColor
readwrite

◆ pointLabelFont

QFont openswmmvis::plot::SeriesStyleObject::pointLabelFont
readwrite

◆ pointLabelFormat

QString openswmmvis::plot::SeriesStyleObject::pointLabelFormat
readwrite

◆ pointLabelFormatMode

LabelFormatModeQ openswmmvis::plot::SeriesStyleObject::pointLabelFormatMode
readwrite

◆ pointLabelPrecision

int openswmmvis::plot::SeriesStyleObject::pointLabelPrecision
readwrite

◆ shape

MarkerShapeQ openswmmvis::plot::SeriesStyleObject::shape
readwrite

◆ showAreaFill

bool openswmmvis::plot::SeriesStyleObject::showAreaFill
readwrite

◆ showLine

bool openswmmvis::plot::SeriesStyleObject::showLine
readwrite

◆ showMarkers

bool openswmmvis::plot::SeriesStyleObject::showMarkers
readwrite

◆ showPointLabels

bool openswmmvis::plot::SeriesStyleObject::showPointLabels
readwrite

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