Quantum GIS API Documentation  master-693a1fe
QgsGraduatedSymbolRendererV2 Class Reference

#include <qgsgraduatedsymbolrendererv2.h>

+ Inheritance diagram for QgsGraduatedSymbolRendererV2:
+ Collaboration diagram for QgsGraduatedSymbolRendererV2:

List of all members.

Public Types

enum  Mode {
  EqualInterval, Quantile, Jenks, StdDev,
  Pretty, Custom
}

Public Member Functions

 QgsGraduatedSymbolRendererV2 (QString attrName=QString(), QgsRangeList ranges=QgsRangeList())
virtual ~QgsGraduatedSymbolRendererV2 ()
void addClass (QgsSymbolV2 *symbol)
virtual int capabilities ()
 returns bitwise OR-ed capabilities of the renderer
QString classAttribute () const
virtual QgsFeatureRendererV2clone ()
void deleteAllClasses ()
void deleteClass (int idx)
virtual QString dump ()
 for debugging
virtual QgsLegendSymbolList legendSymbolItems ()
 return a list of item text / symbol
virtual QgsLegendSymbologyList legendSymbologyItems (QSize iconSize)
 return a list of symbology items for the legend
Mode mode () const
void moveClass (int from, int to)
 Moves the category at index position from to index position to.
const QgsRangeListranges ()
QString rotationField () const
virtual QDomElement save (QDomDocument &doc)
 store renderer info to XML element
QgsSymbolV2::ScaleMethod scaleMethod () const
void setClassAttribute (QString attr)
void setMode (Mode mode)
void setRotationField (QString fieldName)
void setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod)
void setSizeScaleField (QString fieldName)
void setSourceColorRamp (QgsVectorColorRampV2 *ramp)
void setSourceSymbol (QgsSymbolV2 *sym)
QString sizeScaleField () const
void sortByLabel (Qt::SortOrder order=Qt::AscendingOrder)
void sortByValue (Qt::SortOrder order=Qt::AscendingOrder)
QgsVectorColorRampV2sourceColorRamp ()
QgsSymbolV2sourceSymbol ()
virtual void startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
virtual void stopRender (QgsRenderContext &context)
virtual QgsSymbolV2symbolForFeature (QgsFeature &feature)
 to be overridden
virtual QgsSymbolV2List symbols ()
 for symbol levels
virtual void toSld (QDomDocument &doc, QDomElement &element) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs
void updateColorRamp (QgsVectorColorRampV2 *ramp)
 Update the color ramp used.
bool updateRangeLabel (int rangeIndex, QString label)
bool updateRangeLowerValue (int rangeIndex, double value)
bool updateRangeSymbol (int rangeIndex, QgsSymbolV2 *symbol)
bool updateRangeUpperValue (int rangeIndex, double value)
void updateSymbols (QgsSymbolV2 *sym)
 Update the all symbols but leave breaks and colors.
virtual QList< QString > usedAttributes ()

Static Public Member Functions

static QgsFeatureRendererV2create (QDomElement &element)
 create renderer from XML element
static
QgsGraduatedSymbolRendererV2
createRenderer (QgsVectorLayer *vlayer, QString attrName, int classes, Mode mode, QgsSymbolV2 *symbol, QgsVectorColorRampV2 *ramp)

Protected Member Functions

QgsSymbolV2symbolForValue (double value)

Protected Attributes

QString mAttrName
int mAttrNum
 attribute index (derived from attribute name in startRender)
Mode mMode
QgsRangeList mRanges
QString mRotationField
int mRotationFieldIdx
QgsSymbolV2::ScaleMethod mScaleMethod
QString mSizeScaleField
int mSizeScaleFieldIdx
QgsVectorColorRampV2mSourceColorRamp
QgsSymbolV2mSourceSymbol
QMap< QgsSymbolV2
*, QgsSymbolV2 * > 
mTempSymbols
 temporary symbols, used for data-defined rotation and scaling

Detailed Description

Definition at line 59 of file qgsgraduatedsymbolrendererv2.h.


Member Enumeration Documentation

Enumerator:
EqualInterval 
Quantile 
Jenks 
StdDev 
Pretty 
Custom 

Definition at line 106 of file qgsgraduatedsymbolrendererv2.h.


Constructor & Destructor Documentation

QgsGraduatedSymbolRendererV2::QgsGraduatedSymbolRendererV2 ( QString  attrName = QString(),
QgsRangeList  ranges = QgsRangeList() 
)

Definition at line 154 of file qgsgraduatedsymbolrendererv2.cpp.

Referenced by clone(), create(), and createRenderer().


Member Function Documentation

virtual int QgsGraduatedSymbolRendererV2::capabilities ( ) [inline, virtual]

returns bitwise OR-ed capabilities of the renderer

Note:
added in 2.0

Reimplemented from QgsFeatureRendererV2.

Definition at line 82 of file qgsgraduatedsymbolrendererv2.h.

References QgsFeatureRendererV2::Filter.

QString QgsGraduatedSymbolRendererV2::dump ( ) [virtual]

for debugging

Reimplemented from QgsFeatureRendererV2.

Definition at line 339 of file qgsgraduatedsymbolrendererv2.cpp.

References mAttrName, and mRanges.

return a list of item text / symbol

Note:
: this method was added in version 1.5
not available in python bindings

Reimplemented from QgsFeatureRendererV2.

Definition at line 1068 of file qgsgraduatedsymbolrendererv2.cpp.

References classAttribute(), QgsRendererRangeV2::label(), mRanges, mRotationFieldIdx, mSizeScaleFieldIdx, mTempSymbols, and QgsRendererRangeV2::symbol().

void QgsGraduatedSymbolRendererV2::moveClass ( int  from,
int  to 
)

Moves the category at index position from to index position to.

Definition at line 1169 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

Referenced by QgsGraduatedSymbolRendererV2Model::dropMimeData().

void QgsGraduatedSymbolRendererV2::sortByLabel ( Qt::SortOrder  order = Qt::AscendingOrder)
void QgsGraduatedSymbolRendererV2::sortByValue ( Qt::SortOrder  order = Qt::AscendingOrder)

Implements QgsFeatureRendererV2.

Definition at line 261 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges, and mTempSymbols.

Definition at line 175 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

Referenced by symbolForFeature().

for symbol levels

Implements QgsFeatureRendererV2.

Definition at line 379 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

Referenced by save().

void QgsGraduatedSymbolRendererV2::toSld ( QDomDocument &  doc,
QDomElement &  element 
) const [virtual]

used from subclasses to create SLD Rule elements following SLD v1.1 specs

Note:
added in 1.9

Reimplemented from QgsFeatureRendererV2.

Definition at line 362 of file qgsgraduatedsymbolrendererv2.cpp.

References mAttrName, mRanges, mRotationField, and mSizeScaleField.

bool QgsGraduatedSymbolRendererV2::updateRangeLowerValue ( int  rangeIndex,
double  value 
)
bool QgsGraduatedSymbolRendererV2::updateRangeUpperValue ( int  rangeIndex,
double  value 
)

Member Data Documentation

attribute index (derived from attribute name in startRender)

Definition at line 182 of file qgsgraduatedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

Definition at line 174 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), and save().

temporary symbols, used for data-defined rotation and scaling

Definition at line 187 of file qgsgraduatedsymbolrendererv2.h.

Referenced by legendSymbolItems(), startRender(), stopRender(), and symbolForFeature().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines