/************************************************************************ * This file has been generated automatically from * * * * src/core/symbology-ng/qgsgraduatedsymbolrenderer.h * * * * Do not edit manually ! Edit header and run scripts/sipify.pl again * ************************************************************************/ class QgsRendererRange { %TypeHeaderCode #include "qgsgraduatedsymbolrenderer.h" %End public: QgsRendererRange(); QgsRendererRange( double lowerValue, double upperValue, QgsSymbol *symbol /Transfer/, const QString &label, bool render = true ); QgsRendererRange( const QgsRendererRange &range ); bool operator<( const QgsRendererRange &other ) const; %Docstring :rtype: bool %End double lowerValue() const; %Docstring :rtype: float %End double upperValue() const; %Docstring :rtype: float %End QgsSymbol *symbol() const; %Docstring :rtype: QgsSymbol %End QString label() const; %Docstring :rtype: str %End void setSymbol( QgsSymbol *s /Transfer/ ); void setLabel( const QString &label ); void setLowerValue( double lowerValue ); void setUpperValue( double upperValue ); bool renderState() const; %Docstring :rtype: bool %End void setRenderState( bool render ); QString dump() const; %Docstring :rtype: str %End void toSld( QDomDocument &doc, QDomElement &element, QgsStringMap props, bool firstRange = false ) const; %Docstring Creates a DOM element representing the range in SLD format. \param doc DOM document \param element destination DOM element \param props graduated renderer properties \param firstRange set to true if the range is the first range, where the lower value uses a <= test rather than a < test. %End protected: void swap( QgsRendererRange &other ); }; typedef QList QgsRangeList; class QgsRendererRangeLabelFormat { %Docstring .. versionadded:: 2.6 %End %TypeHeaderCode #include "qgsgraduatedsymbolrenderer.h" %End public: QgsRendererRangeLabelFormat(); QgsRendererRangeLabelFormat( const QString &format, int precision = 4, bool trimTrailingZeroes = false ); bool operator==( const QgsRendererRangeLabelFormat &other ) const; bool operator!=( const QgsRendererRangeLabelFormat &other ) const; %Docstring :rtype: bool %End QString format() const; %Docstring :rtype: str %End void setFormat( const QString &format ); int precision() const; %Docstring :rtype: int %End void setPrecision( int precision ); bool trimTrailingZeroes() const; %Docstring :rtype: bool %End void setTrimTrailingZeroes( bool trimTrailingZeroes ); QString labelForRange( double lower, double upper ) const /PyName=labelForLowerUpper/; %Docstring .. note:: labelForLowerUpper in Python bindings :rtype: str %End QString labelForRange( const QgsRendererRange &range ) const; %Docstring :rtype: str %End QString formatNumber( double value ) const; %Docstring :rtype: str %End void setFromDomElement( QDomElement &element ); void saveToDomElement( QDomElement &element ); static const int MAX_PRECISION; static const int MIN_PRECISION; protected: }; class QgsGraduatedSymbolRenderer : QgsFeatureRenderer { %TypeHeaderCode #include "qgsgraduatedsymbolrenderer.h" %End public: QgsGraduatedSymbolRenderer( const QString &attrName = QString(), const QgsRangeList &ranges = QgsRangeList() ); virtual ~QgsGraduatedSymbolRenderer(); virtual QgsSymbol *symbolForFeature( QgsFeature &feature, QgsRenderContext &context ); virtual QgsSymbol *originalSymbolForFeature( QgsFeature &feature, QgsRenderContext &context ); virtual void startRender( QgsRenderContext &context, const QgsFields &fields ); virtual void stopRender( QgsRenderContext &context ); virtual QSet usedAttributes( const QgsRenderContext &context ) const; virtual QString dump() const; virtual QgsGraduatedSymbolRenderer *clone() const /Factory/; virtual void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props = QgsStringMap() ) const; virtual QgsFeatureRenderer::Capabilities capabilities(); virtual QgsSymbolList symbols( QgsRenderContext &context ); QString classAttribute() const; %Docstring :rtype: str %End void setClassAttribute( const QString &attr ); const QgsRangeList &ranges() const; %Docstring :rtype: QgsRangeList %End bool updateRangeSymbol( int rangeIndex, QgsSymbol *symbol /Transfer/ ); %Docstring :rtype: bool %End bool updateRangeLabel( int rangeIndex, const QString &label ); %Docstring :rtype: bool %End bool updateRangeUpperValue( int rangeIndex, double value ); %Docstring :rtype: bool %End bool updateRangeLowerValue( int rangeIndex, double value ); %Docstring :rtype: bool %End bool updateRangeRenderState( int rangeIndex, bool render ); %Docstring .. versionadded:: 2.5 :rtype: bool %End void addClass( QgsSymbol *symbol ); void addClass( const QgsRendererRange &range ) /PyName=addClassRange/; %Docstring .. note:: available in Python bindings as addClassRange %End void addClass( double lower, double upper ) /PyName=addClassLowerUpper/; %Docstring .. note:: available in Python bindings as addClassLowerUpper %End void addBreak( double breakValue, bool updateSymbols = true ); %Docstring Add a breakpoint by splitting existing classes so that the specified value becomes a break between two classes. \param breakValue position to insert break \param updateSymbols set to true to reapply ramp colors to the new symbol ranges .. versionadded:: 2.9 %End void deleteClass( int idx ); void deleteAllClasses(); void moveClass( int from, int to ); %Docstring Moves the category at index position from to index position to. %End bool rangesOverlap() const; %Docstring Tests whether classes assigned to the renderer have ranges which overlap. :return: true if ranges overlap .. versionadded:: 2.10 :rtype: bool %End bool rangesHaveGaps() const; %Docstring Tests whether classes assigned to the renderer have gaps between the ranges. :return: true if ranges have gaps .. versionadded:: 2.10 :rtype: bool %End void sortByValue( Qt::SortOrder order = Qt::AscendingOrder ); void sortByLabel( Qt::SortOrder order = Qt::AscendingOrder ); enum Mode { EqualInterval, Quantile, Jenks, StdDev, Pretty, Custom }; Mode mode() const; %Docstring :rtype: Mode %End void setMode( Mode mode ); void updateClasses( QgsVectorLayer *vlayer, Mode mode, int nclasses ); %Docstring .. versionadded:: 2.6 %End const QgsRendererRangeLabelFormat &labelFormat() const; %Docstring .. versionadded:: 2.6 :rtype: QgsRendererRangeLabelFormat %End void setLabelFormat( const QgsRendererRangeLabelFormat &labelFormat, bool updateRanges = false ); %Docstring .. versionadded:: 2.6 %End void calculateLabelPrecision( bool updateRanges = true ); %Docstring .. versionadded:: 2.6 %End static QgsGraduatedSymbolRenderer *createRenderer( QgsVectorLayer *vlayer, const QString &attrName, int classes, Mode mode, QgsSymbol *symbol /Transfer/, QgsColorRamp *ramp /Transfer/, const QgsRendererRangeLabelFormat &legendFormat = QgsRendererRangeLabelFormat() ); %Docstring Creates a new graduated renderer. \param vlayer vector layer \param attrName attribute to classify \param classes number of classes \param mode classification mode \param symbol base symbol \param ramp color ramp for classes \param legendFormat :return: new QgsGraduatedSymbolRenderer object :rtype: QgsGraduatedSymbolRenderer %End static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) /Factory/; %Docstring create renderer from XML element :rtype: QgsFeatureRenderer %End virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ); virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize ); virtual QgsLegendSymbolListV2 legendSymbolItemsV2() const; virtual QSet< QString > legendKeysForFeature( QgsFeature &feature, QgsRenderContext &context ); QgsSymbol *sourceSymbol(); %Docstring Returns the renderer's source symbol, which is the base symbol used for the each classes' symbol before applying the classes' color. .. seealso:: setSourceSymbol() .. seealso:: sourceColorRamp() :rtype: QgsSymbol %End void setSourceSymbol( QgsSymbol *sym /Transfer/ ); %Docstring Sets the source symbol for the renderer, which is the base symbol used for the each classes' symbol before applying the classes' color. \param sym source symbol, ownership is transferred to the renderer .. seealso:: sourceSymbol() .. seealso:: setSourceColorRamp() %End QgsColorRamp *sourceColorRamp(); %Docstring Returns the source color ramp, from which each classes' color is derived. .. seealso:: setSourceColorRamp() .. seealso:: sourceSymbol() :rtype: QgsColorRamp %End void setSourceColorRamp( QgsColorRamp *ramp /Transfer/ ); %Docstring Sets the source color ramp. \param ramp color ramp. Ownership is transferred to the renderer %End void updateColorRamp( QgsColorRamp *ramp /Transfer/ = 0 ); %Docstring Update the color ramp used. Also updates all symbols colors. Doesn't alter current breaks. \param ramp color ramp. Ownership is transferred to the renderer %End void updateSymbols( QgsSymbol *sym ); %Docstring Update all the symbols but leave breaks and colors. This method also sets the source symbol for the renderer. \param sym source symbol to use for classes. Ownership is not transferred. .. seealso:: setSourceSymbol() %End void setSymbolSizes( double minSize, double maxSize ); %Docstring .. versionadded:: 2.10 %End double minSymbolSize() const; %Docstring .. versionadded:: 2.10 :rtype: float %End double maxSymbolSize() const; %Docstring .. versionadded:: 2.10 :rtype: float %End enum GraduatedMethod { GraduatedColor, GraduatedSize }; GraduatedMethod graduatedMethod() const; %Docstring .. versionadded:: 2.10 :rtype: GraduatedMethod %End void setGraduatedMethod( GraduatedMethod method ); %Docstring .. versionadded:: 2.10 %End virtual bool legendSymbolItemsCheckable() const; virtual bool legendSymbolItemChecked( const QString &key ); virtual void checkLegendSymbolItem( const QString &key, bool state = true ); virtual void setLegendSymbolItem( const QString &key, QgsSymbol *symbol /Transfer/ ); virtual QString legendClassificationAttribute() const; static QgsGraduatedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) /Factory/; %Docstring :return: a new renderer if the conversion was possible, otherwise 0. :rtype: QgsGraduatedSymbolRenderer %End protected: QgsSymbol *symbolForValue( double value ); %Docstring attribute index (derived from attribute name in startRender) :rtype: QgsSymbol %End QString legendKeyForValue( double value ) const; %Docstring Returns the matching legend key for a value. :rtype: str %End private: QgsGraduatedSymbolRenderer( const QgsGraduatedSymbolRenderer & ); QgsGraduatedSymbolRenderer &operator=( const QgsGraduatedSymbolRenderer & ); %Docstring :rtype: QgsGraduatedSymbolRenderer %End }; /************************************************************************ * This file has been generated automatically from * * * * src/core/symbology-ng/qgsgraduatedsymbolrenderer.h * * * * Do not edit manually ! Edit header and run scripts/sipify.pl again * ************************************************************************/