Class: QgsBasicNumericFormat

A numeric formatter which returns a simple text representation of a value.

Added in version 3.12.

Class Hierarchy

Base classes

QgsNumericFormat

Abstract base class for numeric formatters, which allow for formatting a numeric value for display.

Subclasses

QgsBearingNumericFormat	A numeric formatter which returns a text representation of a direction/bearing.
QgsCurrencyNumericFormat	A numeric formatter which returns a text representation of a currency value.
QgsGeographicCoordinateNumericFormat	A numeric formatter which returns a text representation of a geographic coordinate (latitude or longitude).
QgsPercentageNumericFormat	A numeric formatter which returns a text representation of a percentage value.
QgsScientificNumericFormat	A numeric formatter which returns a scientific notation representation of a value.

class qgis.core.QgsBasicNumericFormat

Bases: QgsNumericFormat

__init__()

Default constructor

__init__(a0: QgsBasicNumericFormat)

Parameters:

a0 (QgsBasicNumericFormat)

DecimalPlaces = 0

class RoundingType

Bases: int

SignificantFigures = 1

decimalSeparator(self) → str

Returns any override for the decimal separator character. If an invalid QChar is returned, then the QGIS locale separator is used instead.

See also

setDecimalSeparator()

Return type:

str

numberDecimalPlaces(self) → int

Returns the maximum number of decimal places to show.

See also

setNumberDecimalPlaces()

See also

showTrailingZeros()

Return type:

int

roundingType(self) → QgsBasicNumericFormat.RoundingType

Returns the rounding type, which controls the behavior of the numberDecimalPlaces() setting.

See also

setRoundingType()

Return type:

QgsBasicNumericFormat.RoundingType

virtual setConfiguration(self, configuration: Dict[str, Any], context: QgsReadWriteContext)

Sets the format’s configuration.

Parameters:

• configuration (Dict[str, Any])

• context (QgsReadWriteContext)

setDecimalSeparator(self, character: str)

Sets an override character for the decimal separator character. If an invalid QChar is set, then the QGIS locale separator is used instead.

See also

decimalSeparator()

Parameters:

character (str)

virtual setNumberDecimalPlaces(self, places: int)

Sets the maximum number of decimal places to show.

See also

numberDecimalPlaces()

See also

setShowTrailingZeros()

Parameters:

places (int)

setRoundingType(self, type: QgsBasicNumericFormat.RoundingType)

Sets the rounding type, which controls the behavior of the numberDecimalPlaces() setting.

See also

roundingType()

Parameters:

type (QgsBasicNumericFormat.RoundingType)

setShowPlusSign(self, show: bool)

Sets whether a leading plus sign will be shown for positive values.

See also

showPlusSign()

Parameters:

show (bool)

setShowThousandsSeparator(self, show: bool)

Sets whether the thousands grouping separator will be shown.

See also

showThousandsSeparator()

Parameters:

show (bool)

setShowTrailingZeros(self, show: bool)

Sets whether trailing zeros will be shown (up to the specified numberDecimalPlaces()).

See also

showTrailingZeros()

See also

setNumberDecimalPlaces()

Parameters:

show (bool)

setThousandsSeparator(self, character: str)

Sets an override character for the thousands separator character. If an invalid QChar is set, then the QGIS locale separator is used instead.

See also

thousandsSeparator()

Parameters:

character (str)

showPlusSign(self) → bool

Returns True if a leading plus sign will be shown for positive values.

See also

setShowPlusSign()

Return type:

bool

showThousandsSeparator(self) → bool

Returns True if the thousands grouping separator will be shown.

See also

setShowThousandsSeparator()

Return type:

bool

showTrailingZeros(self) → bool

Returns True if trailing zeros will be shown (up to the specified numberDecimalPlaces()).

See also

setShowTrailingZeros()

See also

numberDecimalPlaces()

Return type:

bool

thousandsSeparator(self) → str

Returns any override for the thousands separator character. If an invalid QChar is returned, then the QGIS locale separator is used instead.

See also

setThousandsSeparator()

Return type:

str