QGIS API Documentation  3.23.0-Master (dd0cd13a00)
Public Member Functions | List of all members
QgsInterpolatedLineWidth Class Reference

Represents a width than can vary depending on values. More...

#include <qgsinterpolatedlinerenderer.h>

Public Member Functions

double fixedStrokeWidth () const
 Returns the fixed width. More...
 
bool ignoreOutOfRange () const
 Returns whether the variable width ignores out of range value. More...
 
bool isVariableWidth () const
 Returns whether the width is variable. More...
 
double maximumValue () const
 Returns the maximum value used to defined the variable width. More...
 
double maximumWidth () const
 Returns the maximum width used to defined the variable width. More...
 
double minimumValue () const
 Returns the minimum value used to defined the variable width. More...
 
double minimumWidth () const
 Returns the minimum width used to defined the variable width. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context)
 Reads configuration from the given DOM element. More...
 
void setFixedStrokeWidth (double fixedWidth)
 Sets the fixed width. More...
 
void setIgnoreOutOfRange (bool ignoreOutOfRange)
 Sets whether the variable width ignores out of range value. More...
 
void setIsVariableWidth (bool isVariableWidth)
 Returns whether the width is variable. More...
 
void setMaximumValue (double maximumValue)
 Sets the maximum value used to defined the variable width. More...
 
void setMaximumWidth (double maximumWidth)
 Sets the maximum width used to defined the variable width. More...
 
void setMinimumValue (double minimumValue)
 Sets the minimum value used to defined the variable width. More...
 
void setMinimumWidth (double minimumWidth)
 Sets the minimum width used to defined the variable width. More...
 
void setUseAbsoluteValue (bool useAbsoluteValue)
 Sets whether absolute value are used as input. More...
 
double strokeWidth (double value) const
 Returns the variable width depending on value, if not varying returns the fixed width. More...
 
bool useAbsoluteValue () const
 Returns whether absolute value are used as input. More...
 
QDomElement writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const
 Writes configuration to a new DOM element. More...
 

Detailed Description

Represents a width than can vary depending on values.

Since
QGIS 3.14

Definition at line 126 of file qgsinterpolatedlinerenderer.h.

Member Function Documentation

◆ fixedStrokeWidth()

double QgsInterpolatedLineWidth::fixedStrokeWidth ( ) const

Returns the fixed width.

Definition at line 396 of file qgsinterpolatedlinerenderer.cpp.

◆ ignoreOutOfRange()

bool QgsInterpolatedLineWidth::ignoreOutOfRange ( ) const

Returns whether the variable width ignores out of range value.

Definition at line 401 of file qgsinterpolatedlinerenderer.cpp.

◆ isVariableWidth()

bool QgsInterpolatedLineWidth::isVariableWidth ( ) const

Returns whether the width is variable.

Definition at line 411 of file qgsinterpolatedlinerenderer.cpp.

◆ maximumValue()

double QgsInterpolatedLineWidth::maximumValue ( ) const

Returns the maximum value used to defined the variable width.

Definition at line 293 of file qgsinterpolatedlinerenderer.cpp.

◆ maximumWidth()

double QgsInterpolatedLineWidth::maximumWidth ( ) const

Returns the maximum width used to defined the variable width.

Definition at line 315 of file qgsinterpolatedlinerenderer.cpp.

◆ minimumValue()

double QgsInterpolatedLineWidth::minimumValue ( ) const

Returns the minimum value used to defined the variable width.

Definition at line 282 of file qgsinterpolatedlinerenderer.cpp.

◆ minimumWidth()

double QgsInterpolatedLineWidth::minimumWidth ( ) const

Returns the minimum width used to defined the variable width.

Definition at line 304 of file qgsinterpolatedlinerenderer.cpp.

◆ readXml()

void QgsInterpolatedLineWidth::readXml ( const QDomElement &  elem,
const QgsReadWriteContext context 
)

Reads configuration from the given DOM element.

Definition at line 374 of file qgsinterpolatedlinerenderer.cpp.

◆ setFixedStrokeWidth()

void QgsInterpolatedLineWidth::setFixedStrokeWidth ( double  fixedWidth)

Sets the fixed width.

Definition at line 421 of file qgsinterpolatedlinerenderer.cpp.

◆ setIgnoreOutOfRange()

void QgsInterpolatedLineWidth::setIgnoreOutOfRange ( bool  ignoreOutOfRange)

Sets whether the variable width ignores out of range value.

Definition at line 406 of file qgsinterpolatedlinerenderer.cpp.

◆ setIsVariableWidth()

void QgsInterpolatedLineWidth::setIsVariableWidth ( bool  isVariableWidth)

Returns whether the width is variable.

Definition at line 416 of file qgsinterpolatedlinerenderer.cpp.

◆ setMaximumValue()

void QgsInterpolatedLineWidth::setMaximumValue ( double  maximumValue)

Sets the maximum value used to defined the variable width.

Definition at line 298 of file qgsinterpolatedlinerenderer.cpp.

◆ setMaximumWidth()

void QgsInterpolatedLineWidth::setMaximumWidth ( double  maximumWidth)

Sets the maximum width used to defined the variable width.

Definition at line 320 of file qgsinterpolatedlinerenderer.cpp.

◆ setMinimumValue()

void QgsInterpolatedLineWidth::setMinimumValue ( double  minimumValue)

Sets the minimum value used to defined the variable width.

Definition at line 287 of file qgsinterpolatedlinerenderer.cpp.

◆ setMinimumWidth()

void QgsInterpolatedLineWidth::setMinimumWidth ( double  minimumWidth)

Sets the minimum width used to defined the variable width.

Definition at line 309 of file qgsinterpolatedlinerenderer.cpp.

◆ setUseAbsoluteValue()

void QgsInterpolatedLineWidth::setUseAbsoluteValue ( bool  useAbsoluteValue)

Sets whether absolute value are used as input.

Definition at line 391 of file qgsinterpolatedlinerenderer.cpp.

◆ strokeWidth()

double QgsInterpolatedLineWidth::strokeWidth ( double  value) const

Returns the variable width depending on value, if not varying returns the fixed width.

Definition at line 326 of file qgsinterpolatedlinerenderer.cpp.

◆ useAbsoluteValue()

bool QgsInterpolatedLineWidth::useAbsoluteValue ( ) const

Returns whether absolute value are used as input.

Definition at line 386 of file qgsinterpolatedlinerenderer.cpp.

◆ writeXml()

QDomElement QgsInterpolatedLineWidth::writeXml ( QDomDocument &  doc,
const QgsReadWriteContext context 
) const

Writes configuration to a new DOM element.

Definition at line 358 of file qgsinterpolatedlinerenderer.cpp.


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