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 QgsSymbolV2 * symbolForFeature (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 QgsFeatureRendererV2 * clone ()
virtual QgsSymbolV2List symbols ()
 for symbol levels
QString classAttribute () const
void setClassAttribute (QString attr)
const QgsRangeList & ranges ()
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
QgsSymbolV2 * sourceSymbol ()
void setSourceSymbol (QgsSymbolV2 *sym)
QgsVectorColorRampV2 * sourceColorRamp ()
void setSourceColorRamp (QgsVectorColorRampV2 *ramp)
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 QgsFeatureRendererV2 * create (QDomElement &element)
 create renderer from XML element

Protected Member Functions

QgsSymbolV2 * symbolForValue (double value)

Protected Attributes

QString mAttrName
QgsRangeList mRanges
Mode mMode
QgsSymbolV2 * mSourceSymbol
QgsVectorColorRampV2 * mSourceColorRamp
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 39 of file qgsgraduatedsymbolrendererv2.h.

Member Enumeration Documentation

enum QgsGraduatedSymbolRendererV2::Mode

Enumerator:
EqualInterval 
Quantile 
Jenks 
StdDev 
Pretty 
Custom 

Definition at line 73 of file qgsgraduatedsymbolrendererv2.h.

Constructor & Destructor Documentation

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

Definition at line 97 of file qgsgraduatedsymbolrendererv2.cpp.

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

QgsGraduatedSymbolRendererV2::~QgsGraduatedSymbolRendererV2 (  )  [virtual]

Definition at line 108 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges, mSourceColorRamp, and mSourceSymbol.

Member Function Documentation

QgsSymbolV2 * QgsGraduatedSymbolRendererV2::symbolForFeature ( QgsFeature &  feature  )  [virtual]

Implements QgsFeatureRendererV2.

Definition at line 126 of file qgsgraduatedsymbolrendererv2.cpp.

References QgsFeature::attributeMap(), QgsSymbolV2::Line, QgsSymbolV2::Marker, mAttrName, mAttrNum, mRotationFieldIdx, mSizeScaleFieldIdx, mTempSymbols, QgsDebugMsg, QgsMarkerSymbolV2::setAngle(), QgsMarkerSymbolV2::setSize(), QgsLineSymbolV2::setWidth(), symbolForValue(), and QgsSymbolV2::type().

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

Implements QgsFeatureRendererV2.

Definition at line 172 of file qgsgraduatedsymbolrendererv2.cpp.

References QgsSymbolV2::DataDefinedRotation, QgsSymbolV2::DataDefinedSizeScale, QgsVectorLayer::fieldNameIndex(), mAttrName, mAttrNum, mRanges, mRotationField, mRotationFieldIdx, mSizeScaleField, mSizeScaleFieldIdx, mTempSymbols, QgsSymbolV2::setRenderHints(), and QgsSymbolV2::startRender().

void QgsGraduatedSymbolRendererV2::stopRender ( QgsRenderContext &  context  )  [virtual]

Implements QgsFeatureRendererV2.

Definition at line 196 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges, and mTempSymbols.

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

Implements QgsFeatureRendererV2.

Definition at line 216 of file qgsgraduatedsymbolrendererv2.cpp.

References mAttrName, mRotationField, and mSizeScaleField.

QString QgsGraduatedSymbolRendererV2::dump (  )  [virtual]

for debugging

Reimplemented from QgsFeatureRendererV2.

Definition at line 259 of file qgsgraduatedsymbolrendererv2.cpp.

References mAttrName, and mRanges.

QgsFeatureRendererV2 * QgsGraduatedSymbolRendererV2::clone (  )  [virtual]

Implements QgsFeatureRendererV2.

Definition at line 267 of file qgsgraduatedsymbolrendererv2.cpp.

References QgsVectorColorRampV2::clone(), QgsSymbolV2::clone(), mAttrName, mMode, mRanges, mSourceColorRamp, mSourceSymbol, QgsGraduatedSymbolRendererV2(), rotationField(), setMode(), setRotationField(), setSizeScaleField(), setSourceColorRamp(), setSourceSymbol(), QgsFeatureRendererV2::setUsingSymbolLevels(), sizeScaleField(), and QgsFeatureRendererV2::usingSymbolLevels().

QgsSymbolV2List QgsGraduatedSymbolRendererV2::symbols (  )  [virtual]

for symbol levels

Implements QgsFeatureRendererV2.

Definition at line 281 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

Referenced by save().

QString QgsGraduatedSymbolRendererV2::classAttribute (  )  const [inline]

Definition at line 60 of file qgsgraduatedsymbolrendererv2.h.

Referenced by legendSymbolItems(), legendSymbologyItems(), QgsRuleBasedRendererV2::refineRuleRanges(), and QgsSymbologyV2Conversion::rendererV2toV1().

void QgsGraduatedSymbolRendererV2::setClassAttribute ( QString  attr  )  [inline]

Definition at line 61 of file qgsgraduatedsymbolrendererv2.h.

const QgsRangeList& QgsGraduatedSymbolRendererV2::ranges (  )  [inline]

Definition at line 63 of file qgsgraduatedsymbolrendererv2.h.

Referenced by create(), createRenderer(), legendSymbologyItems(), QgsRuleBasedRendererV2::refineRuleRanges(), and QgsSymbologyV2Conversion::rendererV2toV1().

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

Definition at line 227 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

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

Definition at line 235 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

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

Definition at line 243 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

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

Definition at line 251 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

void QgsGraduatedSymbolRendererV2::addClass ( QgsSymbolV2 *  symbol  ) 

Definition at line 997 of file qgsgraduatedsymbolrendererv2.cpp.

References QgsSymbolV2::clone(), and mRanges.

void QgsGraduatedSymbolRendererV2::deleteClass ( int  idx  ) 

Definition at line 1005 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

Mode QgsGraduatedSymbolRendererV2::mode (  )  const [inline]

Definition at line 83 of file qgsgraduatedsymbolrendererv2.h.

Referenced by QgsSymbologyV2Conversion::rendererV2toV1().

void QgsGraduatedSymbolRendererV2::setMode ( Mode  mode  )  [inline]

Definition at line 84 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), create(), createRenderer(), and QgsSymbologyV2Conversion::rendererV1toV2().

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

Definition at line 672 of file qgsgraduatedsymbolrendererv2.cpp.

References _calcEqualIntervalBreaks(), _calcJenksBreaks(), _calcPrettyBreaks(), _calcQuantileBreaks(), _calcStdDevBreaks(), QgsFeature::attributeMap(), QgsVectorColorRampV2::clone(), QgsSymbolV2::clone(), QgsVectorColorRampV2::color(), QgsVectorLayer::dataProvider(), EqualInterval, QgsVectorLayer::fieldNameIndex(), Jenks, MathUtils::lower(), QgsVectorDataProvider::maximumValue(), QgsVectorDataProvider::minimumValue(), QgsVectorDataProvider::nextFeature(), Pretty, QgsDebugMsg, QgsGraduatedSymbolRendererV2(), Quantile, ranges(), QgsVectorDataProvider::select(), QgsSymbolV2::setColor(), setMode(), setSourceColorRamp(), setSourceSymbol(), and StdDev.

QgsFeatureRendererV2 * QgsGraduatedSymbolRendererV2::create ( QDomElement &  element  )  [static]

create renderer from XML element

Definition at line 772 of file qgsgraduatedsymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::clearSymbolMap(), EqualInterval, Jenks, QgsSymbolLayerV2Utils::loadColorRamp(), QgsSymbolLayerV2Utils::loadSymbols(), Pretty, QgsGraduatedSymbolRendererV2(), Quantile, ranges(), setMode(), setRotationField(), setSizeScaleField(), setSourceColorRamp(), setSourceSymbol(), and StdDev.

Referenced by QgsRendererV2Registry::QgsRendererV2Registry().

QDomElement QgsGraduatedSymbolRendererV2::save ( QDomDocument &  doc  )  [virtual]

store renderer info to XML element

Reimplemented from QgsFeatureRendererV2.

Definition at line 858 of file qgsgraduatedsymbolrendererv2.cpp.

References EqualInterval, Jenks, QgsRendererRangeV2::label(), QgsRendererRangeV2::lowerValue(), mAttrName, mMode, mRanges, mRotationField, mSizeScaleField, mSourceColorRamp, mSourceSymbol, QgsFeatureRendererV2::mUsingSymbolLevels, Pretty, Quantile, RENDERER_TAG_NAME, QgsSymbolLayerV2Utils::saveColorRamp(), QgsSymbolLayerV2Utils::saveSymbols(), StdDev, QgsRendererRangeV2::symbol(), symbols(), and QgsRendererRangeV2::upperValue().

QgsLegendSymbologyList QgsGraduatedSymbolRendererV2::legendSymbologyItems ( QSize  iconSize  )  [virtual]

return a list of symbology items for the legend

Reimplemented from QgsFeatureRendererV2.

Definition at line 937 of file qgsgraduatedsymbolrendererv2.cpp.

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

QgsLegendSymbolList QgsGraduatedSymbolRendererV2::legendSymbolItems (  )  [virtual]

return a list of item text / symbol

Note:
: this method was added in version 1.5

Reimplemented from QgsFeatureRendererV2.

Definition at line 958 of file qgsgraduatedsymbolrendererv2.cpp.

References classAttribute(), and mRanges.

QgsSymbolV2 * QgsGraduatedSymbolRendererV2::sourceSymbol (  ) 

Definition at line 977 of file qgsgraduatedsymbolrendererv2.cpp.

References mSourceSymbol.

void QgsGraduatedSymbolRendererV2::setSourceSymbol ( QgsSymbolV2 *  sym  ) 

Definition at line 981 of file qgsgraduatedsymbolrendererv2.cpp.

References mSourceSymbol.

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

QgsVectorColorRampV2 * QgsGraduatedSymbolRendererV2::sourceColorRamp (  ) 

Definition at line 987 of file qgsgraduatedsymbolrendererv2.cpp.

References mSourceColorRamp.

void QgsGraduatedSymbolRendererV2::setSourceColorRamp ( QgsVectorColorRampV2 *  ramp  ) 

Definition at line 991 of file qgsgraduatedsymbolrendererv2.cpp.

References mSourceColorRamp.

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

void QgsGraduatedSymbolRendererV2::setRotationField ( QString  fieldName  )  [inline]

Note:
added in 1.6

Definition at line 114 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), and create().

QString QgsGraduatedSymbolRendererV2::rotationField (  )  const [inline]

Note:
added in 1.6

Definition at line 116 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone().

void QgsGraduatedSymbolRendererV2::setSizeScaleField ( QString  fieldName  )  [inline]

Note:
added in 1.6

Definition at line 119 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), and create().

QString QgsGraduatedSymbolRendererV2::sizeScaleField (  )  const [inline]

Note:
added in 1.6

Definition at line 121 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone().

QgsSymbolV2 * QgsGraduatedSymbolRendererV2::symbolForValue ( double  value  )  [protected]

Definition at line 115 of file qgsgraduatedsymbolrendererv2.cpp.

References mRanges.

Referenced by symbolForFeature().

Member Data Documentation

QString QgsGraduatedSymbolRendererV2::mAttrName [protected]

Definition at line 124 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), dump(), save(), startRender(), symbolForFeature(), and usedAttributes().

QgsRangeList QgsGraduatedSymbolRendererV2::mRanges [protected]

Definition at line 125 of file qgsgraduatedsymbolrendererv2.h.

Referenced by addClass(), clone(), deleteClass(), dump(), legendSymbolItems(), save(), startRender(), stopRender(), symbolForValue(), symbols(), updateRangeLabel(), updateRangeLowerValue(), updateRangeSymbol(), updateRangeUpperValue(), and ~QgsGraduatedSymbolRendererV2().

Mode QgsGraduatedSymbolRendererV2::mMode [protected]

Definition at line 126 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), and save().

QgsSymbolV2* QgsGraduatedSymbolRendererV2::mSourceSymbol [protected]

Definition at line 127 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), save(), setSourceSymbol(), sourceSymbol(), and ~QgsGraduatedSymbolRendererV2().

QgsVectorColorRampV2* QgsGraduatedSymbolRendererV2::mSourceColorRamp [protected]

Definition at line 128 of file qgsgraduatedsymbolrendererv2.h.

Referenced by clone(), save(), setSourceColorRamp(), sourceColorRamp(), and ~QgsGraduatedSymbolRendererV2().

QString QgsGraduatedSymbolRendererV2::mRotationField [protected]

Definition at line 129 of file qgsgraduatedsymbolrendererv2.h.

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

QString QgsGraduatedSymbolRendererV2::mSizeScaleField [protected]

Definition at line 130 of file qgsgraduatedsymbolrendererv2.h.

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

int QgsGraduatedSymbolRendererV2::mAttrNum [protected]

attribute index (derived from attribute name in startRender)

Definition at line 133 of file qgsgraduatedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

int QgsGraduatedSymbolRendererV2::mRotationFieldIdx [protected]

Definition at line 134 of file qgsgraduatedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

int QgsGraduatedSymbolRendererV2::mSizeScaleFieldIdx [protected]

Definition at line 134 of file qgsgraduatedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

QMap<QgsSymbolV2*, QgsSymbolV2*> QgsGraduatedSymbolRendererV2::mTempSymbols [protected]

temporary symbols, used for data-defined rotation and scaling

Definition at line 138 of file qgsgraduatedsymbolrendererv2.h.

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

The documentation for this class was generated from the following files:
Generated on Sat Feb 4 19:17:35 2012 for Quantum GIS API Documentation by  doxygen 1.5.6