QGIS API Documentation 3.39.0-Master (be2050b798e)
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsRendererRange Class Reference

#include <qgsrendererrange.h>

Public Member Functions

 QgsRendererRange ()=default
 Constructor for QgsRendererRange.
 
 QgsRendererRange (const QgsClassificationRange &range, QgsSymbol *symbol, bool render=true, const QString &uuid=QString())
 Creates a renderer symbol range.
 
 QgsRendererRange (const QgsRendererRange &range)
 
 QgsRendererRange (double lowerValue, double upperValue, QgsSymbol *symbol, const QString &label, bool render=true, const QString &uuid=QString())
 Creates a renderer symbol range.
 
 ~QgsRendererRange ()
 
QString dump () const
 Dumps a string representation of the range.
 
QString label () const
 Returns the label used for the range.
 
double lowerValue () const
 Returns the lower bound of the range.
 
bool operator< (const QgsRendererRange &other) const
 
QgsRendererRangeoperator= (QgsRendererRange range)
 
bool renderState () const
 Returns true if the range should be rendered.
 
void setLabel (const QString &label)
 Sets the label used for the range.
 
void setLowerValue (double lowerValue)
 Sets the lower bound of the range.
 
void setRenderState (bool render)
 Sets whether the range should be rendered.
 
void setSymbol (QgsSymbol *s)
 Sets the symbol used for the range.
 
void setUpperValue (double upperValue)
 Sets the upper bound of the range.
 
QgsSymbolsymbol () const
 Returns the symbol used for the range.
 
void toSld (QDomDocument &doc, QDomElement &element, QVariantMap props, bool firstRange=false) const
 Creates a DOM element representing the range in SLD format.
 
double upperValue () const
 Returns the upper bound of the range.
 
QString uuid () const
 Returns the unique identifier for this range.
 

Protected Member Functions

void swap (QgsRendererRange &other)
 

Protected Attributes

QString mLabel
 
double mLowerValue = 0
 
bool mRender = true
 
std::unique_ptr< QgsSymbolmSymbol
 
double mUpperValue = 0
 
QString mUuid
 

Detailed Description

Definition at line 36 of file qgsrendererrange.h.

Constructor & Destructor Documentation

◆ QgsRendererRange() [1/4]

QgsRendererRange::QgsRendererRange ( )
default

Constructor for QgsRendererRange.

◆ ~QgsRendererRange()

QgsRendererRange::~QgsRendererRange ( )
default

◆ QgsRendererRange() [2/4]

QgsRendererRange::QgsRendererRange ( const QgsClassificationRange range,
QgsSymbol symbol,
bool  render = true,
const QString &  uuid = QString() 
)

Creates a renderer symbol range.

Parameters
rangeThe classification range
symbolThe symbol for this renderer range
renderIf true, it will be renderered
uuidOptional parameter to manually set the UUID key identifier for the this range (since QGIS 3.34).

Definition at line 24 of file qgsrendererrange.cpp.

◆ QgsRendererRange() [3/4]

QgsRendererRange::QgsRendererRange ( double  lowerValue,
double  upperValue,
QgsSymbol symbol,
const QString &  label,
bool  render = true,
const QString &  uuid = QString() 
)

Creates a renderer symbol range.

Parameters
lowerValueThe lower bound of the range
upperValueThe upper bound of the range
symbolThe symbol for this renderer range
labelThe label used for the range
renderIf true, it will be renderered
uuidOptional parameter to manually set the UUID key identifier for the this range (since QGIS 3.34).

Definition at line 34 of file qgsrendererrange.cpp.

◆ QgsRendererRange() [4/4]

QgsRendererRange::QgsRendererRange ( const QgsRendererRange range)

Definition at line 44 of file qgsrendererrange.cpp.

Member Function Documentation

◆ dump()

QString QgsRendererRange::dump ( ) const

Dumps a string representation of the range.

Definition at line 135 of file qgsrendererrange.cpp.

◆ label()

QString QgsRendererRange::label ( ) const

Returns the label used for the range.

See also
setLabel()

Definition at line 100 of file qgsrendererrange.cpp.

◆ lowerValue()

double QgsRendererRange::lowerValue ( ) const

Returns the lower bound of the range.

See also
setLowerValue()
upperValue()

Definition at line 85 of file qgsrendererrange.cpp.

◆ operator<()

bool QgsRendererRange::operator< ( const QgsRendererRange other) const

Definition at line 63 of file qgsrendererrange.cpp.

◆ operator=()

QgsRendererRange & QgsRendererRange::operator= ( QgsRendererRange  range)

Definition at line 57 of file qgsrendererrange.cpp.

◆ renderState()

bool QgsRendererRange::renderState ( ) const

Returns true if the range should be rendered.

See also
setRenderState()

Definition at line 125 of file qgsrendererrange.cpp.

◆ setLabel()

void QgsRendererRange::setLabel ( const QString &  label)

Sets the label used for the range.

See also
label()

Definition at line 110 of file qgsrendererrange.cpp.

◆ setLowerValue()

void QgsRendererRange::setLowerValue ( double  lowerValue)

Sets the lower bound of the range.

See also
lowerValue()
setUpperValue()

Definition at line 120 of file qgsrendererrange.cpp.

◆ setRenderState()

void QgsRendererRange::setRenderState ( bool  render)

Sets whether the range should be rendered.

See also
renderState()

Definition at line 130 of file qgsrendererrange.cpp.

◆ setSymbol()

void QgsRendererRange::setSymbol ( QgsSymbol s)

Sets the symbol used for the range.

Ownership of the symbol is transferred.

See also
symbol()

Definition at line 105 of file qgsrendererrange.cpp.

◆ setUpperValue()

void QgsRendererRange::setUpperValue ( double  upperValue)

Sets the upper bound of the range.

See also
upperValue()
setLowerValue()

Definition at line 115 of file qgsrendererrange.cpp.

◆ swap()

void QgsRendererRange::swap ( QgsRendererRange other)
protected

Definition at line 71 of file qgsrendererrange.cpp.

◆ symbol()

QgsSymbol * QgsRendererRange::symbol ( ) const

Returns the symbol used for the range.

See also
setSymbol()

Definition at line 95 of file qgsrendererrange.cpp.

◆ toSld()

void QgsRendererRange::toSld ( QDomDocument &  doc,
QDomElement &  element,
QVariantMap  props,
bool  firstRange = false 
) const

Creates a DOM element representing the range in SLD format.

Parameters
docDOM document
elementdestination DOM element
propsgraduated renderer properties
firstRangeset to true if the range is the first range, where the lower value uses a <= test rather than a < test.

Definition at line 140 of file qgsrendererrange.cpp.

◆ upperValue()

double QgsRendererRange::upperValue ( ) const

Returns the upper bound of the range.

See also
setUpperValue()
lowerValue()

Definition at line 90 of file qgsrendererrange.cpp.

◆ uuid()

QString QgsRendererRange::uuid ( ) const

Returns the unique identifier for this range.

Since
QGIS 3.34

Definition at line 80 of file qgsrendererrange.cpp.

Member Data Documentation

◆ mLabel

QString QgsRendererRange::mLabel
protected

Definition at line 199 of file qgsrendererrange.h.

◆ mLowerValue

double QgsRendererRange::mLowerValue = 0
protected

Definition at line 197 of file qgsrendererrange.h.

◆ mRender

bool QgsRendererRange::mRender = true
protected

Definition at line 200 of file qgsrendererrange.h.

◆ mSymbol

std::unique_ptr<QgsSymbol> QgsRendererRange::mSymbol
protected

Definition at line 198 of file qgsrendererrange.h.

◆ mUpperValue

double QgsRendererRange::mUpperValue = 0
protected

Definition at line 197 of file qgsrendererrange.h.

◆ mUuid

QString QgsRendererRange::mUuid
protected

Definition at line 201 of file qgsrendererrange.h.


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