Quantum GIS API Documentation  1.8
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
QgsGraduatedSymbolRendererV2 Class Reference

#include <qgsgraduatedsymbolrendererv2.h>

Inheritance diagram for QgsGraduatedSymbolRendererV2:
Inheritance graph
[legend]
Collaboration diagram for QgsGraduatedSymbolRendererV2:
Collaboration graph
[legend]

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 ()
virtual QgsSymbolV2symbolForFeature (QgsFeature &feature)
virtual void startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
virtual void stopRender (QgsRenderContext &context)
virtual QList< QString > usedAttributes ()
virtual QString dump ()
 for debugging
virtual QgsFeatureRendererV2clone ()
virtual void toSld (QDomDocument &doc, QDomElement &element) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs
virtual int capabilities ()
 returns bitwise OR-ed capabilities of the renderer
virtual QgsSymbolV2List symbols ()
 for symbol levels
QString classAttribute () const
void setClassAttribute (QString attr)
const QgsRangeListranges ()
bool updateRangeSymbol (int rangeIndex, QgsSymbolV2 *symbol)
bool updateRangeLabel (int rangeIndex, QString label)
bool updateRangeUpperValue (int rangeIndex, double value)
bool updateRangeLowerValue (int rangeIndex, double value)
void addClass (QgsSymbolV2 *symbol)
void deleteClass (int idx)
Mode mode () const
void setMode (Mode mode)
virtual QDomElement save (QDomDocument &doc)
 store renderer info to XML element
virtual QgsLegendSymbologyList legendSymbologyItems (QSize iconSize)
 return a list of symbology items for the legend
virtual QgsLegendSymbolList legendSymbolItems ()
 return a list of item text / symbol
QgsSymbolV2sourceSymbol ()
void setSourceSymbol (QgsSymbolV2 *sym)
QgsVectorColorRampV2sourceColorRamp ()
void setSourceColorRamp (QgsVectorColorRampV2 *ramp)
void updateColorRamp (QgsVectorColorRampV2 *ramp)
 Update the color ramp used.
void updateSymbols (QgsSymbolV2 *sym)
 Update the all symbols but leave breaks and colors.
void setRotationField (QString fieldName)
QString rotationField () const
void setSizeScaleField (QString fieldName)
QString sizeScaleField () const

Static Public Member Functions

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

Protected Member Functions

QgsSymbolV2symbolForValue (double value)

Protected Attributes

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

Detailed Description

Definition at line 56 of file qgsgraduatedsymbolrendererv2.h.


Member Enumeration Documentation

Enumerator:
EqualInterval 
Quantile 
Jenks 
StdDev 
Pretty 
Custom 

Definition at line 96 of file qgsgraduatedsymbolrendererv2.h.


Constructor & Destructor Documentation

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

Definition at line 133 of file qgsgraduatedsymbolrendererv2.cpp.

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

Definition at line 146 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges, mSourceColorRamp, and mSourceSymbol.


Member Function Documentation

Definition at line 1098 of file qgsgraduatedsymbolrendererv2.cpp.

References QgsSymbolV2::clone(), and mRanges.

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 79 of file qgsgraduatedsymbolrendererv2.h.

References QgsFeatureRendererV2::RotationField.

QgsFeatureRendererV2 * QgsGraduatedSymbolRendererV2::create ( QDomElement &  element) [static]
QgsGraduatedSymbolRendererV2 * QgsGraduatedSymbolRendererV2::createRenderer ( QgsVectorLayer vlayer,
QString  attrName,
int  classes,
Mode  mode,
QgsSymbolV2 symbol,
QgsVectorColorRampV2 ramp 
) [static]

Definition at line 1106 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

QString QgsGraduatedSymbolRendererV2::dump ( ) [virtual]

for debugging

Reimplemented from QgsFeatureRendererV2.

Definition at line 313 of file qgsgraduatedsymbolrendererv2.cpp.

References mAttrName, and mRanges.

return a list of item text / symbol

Note:
: this method was added in version 1.5

Reimplemented from QgsFeatureRendererV2.

Definition at line 1032 of file qgsgraduatedsymbolrendererv2.cpp.

References classAttribute(), and mRanges.

return a list of symbology items for the legend

Reimplemented from QgsFeatureRendererV2.

Definition at line 1011 of file qgsgraduatedsymbolrendererv2.cpp.

References classAttribute(), QgsRendererRangeV2::label(), ranges(), QgsRendererRangeV2::symbol(), and QgsSymbolLayerV2Utils::symbolPreviewPixmap().

QString QgsGraduatedSymbolRendererV2::rotationField ( ) const [inline, virtual]
Note:
added in 1.6

Reimplemented from QgsFeatureRendererV2.

Definition at line 147 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone().

QDomElement QgsGraduatedSymbolRendererV2::save ( QDomDocument &  doc) [virtual]
void QgsGraduatedSymbolRendererV2::setClassAttribute ( QString  attr) [inline]

Definition at line 84 of file qgsgraduatedsymbolrendererv2.h.

void QgsGraduatedSymbolRendererV2::setRotationField ( QString  fieldName) [inline, virtual]
Note:
added in 1.6

Reimplemented from QgsFeatureRendererV2.

Definition at line 145 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), and create().

void QgsGraduatedSymbolRendererV2::setSizeScaleField ( QString  fieldName) [inline]
Note:
added in 1.6

Definition at line 150 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), and create().

Definition at line 1065 of file qgsgraduatedsymbolrendererv2.cpp.

References mSourceColorRamp.

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

Definition at line 1055 of file qgsgraduatedsymbolrendererv2.cpp.

References mSourceSymbol.

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

Note:
added in 1.6

Definition at line 152 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone().

Definition at line 1061 of file qgsgraduatedsymbolrendererv2.cpp.

References mSourceColorRamp.

Definition at line 1051 of file qgsgraduatedsymbolrendererv2.cpp.

References mSourceSymbol.

void QgsGraduatedSymbolRendererV2::startRender ( QgsRenderContext context,
const QgsVectorLayer vlayer 
) [virtual]

Implements QgsFeatureRendererV2.

Definition at line 235 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges, and mTempSymbols.

Definition at line 153 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

Referenced by symbolForFeature().

for symbol levels

Implements QgsFeatureRendererV2.

Definition at line 352 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 335 of file qgsgraduatedsymbolrendererv2.cpp.

References mAttrName, mRanges, mRotationField, and mSizeScaleField.

Update the color ramp used.

Also updates all symbols colors. Doesn't alter current breaks.

Definition at line 1071 of file qgsgraduatedsymbolrendererv2.cpp.

References QgsSymbolV2::clone(), QgsVectorColorRampV2::color(), mRanges, QgsSymbolV2::setColor(), setSourceColorRamp(), QgsRendererRangeV2::symbol(), and updateRangeSymbol().

bool QgsGraduatedSymbolRendererV2::updateRangeLabel ( int  rangeIndex,
QString  label 
)

Definition at line 289 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

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

Definition at line 305 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

bool QgsGraduatedSymbolRendererV2::updateRangeSymbol ( int  rangeIndex,
QgsSymbolV2 symbol 
)

Definition at line 281 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

Referenced by updateColorRamp(), and updateSymbols().

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

Definition at line 297 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

QList< QString > QgsGraduatedSymbolRendererV2::usedAttributes ( ) [virtual]

Member Data Documentation

attribute index (derived from attribute name in startRender)

Definition at line 164 of file qgsgraduatedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

Definition at line 157 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), and save().

Definition at line 160 of file qgsgraduatedsymbolrendererv2.h.

Referenced by save(), startRender(), toSld(), and usedAttributes().

Definition at line 165 of file qgsgraduatedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

Definition at line 161 of file qgsgraduatedsymbolrendererv2.h.

Referenced by save(), startRender(), toSld(), and usedAttributes().

Definition at line 165 of file qgsgraduatedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

temporary symbols, used for data-defined rotation and scaling

Definition at line 169 of file qgsgraduatedsymbolrendererv2.h.

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


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