Class: QgsUnitTypes¶

Helper functions for various unit types.

Enums

`AngleUnit`	Units of angles.
`AreaUnit`	Units of area
`DistanceUnit`	Units of distance
`DistanceUnitType`	Types of distance units
`LayoutUnit`	Layout measurement units
`LayoutUnitType`	Types of layout units
`RenderUnit`	Rendering size units
`SystemOfMeasurement`	Systems of unit measurement.
`TemporalUnit`	Temporal units.
`UnitType`	Unit types.
`VolumeUnit`	Units of volume.

Static Methods

`areaToDistanceUnit`	Converts an area unit to its corresponding distance unit, e.g., square meters to meters
`decodeAngleUnit`	Decodes an angular unit from a string.
`decodeAreaUnit`	Decodes an areal unit from a string.
`decodeDistanceUnit`	Decodes a distance unit from a string.
`decodeLayoutUnit`	Decodes a layout unit from a string.
`decodeRenderUnit`	Decodes a render unit from a string.
`decodeTemporalUnit`	Decodes a temporal unit from a string.
`decodeUnitType`	Decodes a unit type from a string.
`decodeVolumeUnit`	Decodes a volume unit from a string.
`distanceToAreaUnit`	Converts a distance unit to its corresponding area unit, e.g., meters to square meters
`distanceToVolumeUnit`	Converts a distance unit to its corresponding volume unit, e.g., meters to cubic meters
`encodeUnit`	Encodes a distance unit to a string.
`encodeUnitType`	Encodes a unit type to a string.
`formatAngle`	Returns an angle formatted as a friendly string.
`formatArea`	Returns an area formatted as a friendly string.
`formatDistance`	Returns an distance formatted as a friendly string.
`fromUnitToUnitFactor`	Returns the conversion factor between the specified distance units.
`scaledArea`	Will convert an area with a given unit to an area value which is nice to display.
`scaledDistance`	Will convert a distance with a given unit to a distance value which is nice to display.
`stringToAreaUnit`	Converts a translated string to an areal unit.
`stringToDistanceUnit`	Converts a translated string to a distance unit.
`stringToTemporalUnit`	Converts a translated string to a temporal unit.
`stringToVolumeUnit`	Converts a translated string to a volume unit.
`toAbbreviatedString`	Returns a translated abbreviation representing a distance unit.
`toString`	Returns a translated string representing a distance unit.
`unitType`	Returns the type for a distance unit.
`volumeToDistanceUnit`	Converts a volume unit to its corresponding distance unit, e.g., cubic meters to meters

class qgis.core.QgsUnitTypes[source]¶

Bases: object

class AngleUnit(*values)¶

Bases: IntEnum

Units of angles.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.AngleUnit.

Added in version 3.30.

Degrees: Degrees

Available as QgsUnitTypes.AngleDegrees in older QGIS releases.
Radians: Square kilometers

Available as QgsUnitTypes.AngleRadians in older QGIS releases.
Gon: Gon/gradian

Available as QgsUnitTypes.AngleGon in older QGIS releases.
MinutesOfArc: Minutes of arc

Available as QgsUnitTypes.AngleMinutesOfArc in older QGIS releases.
SecondsOfArc: Seconds of arc

Available as QgsUnitTypes.AngleSecondsOfArc in older QGIS releases.
Turn: Turn/revolutions

Available as QgsUnitTypes.AngleTurn in older QGIS releases.
MilliradiansSI: Angular milliradians (SI definition, 1/1000 of radian)

Available as QgsUnitTypes.AngleMilliradiansSI in older QGIS releases.
MilNATO: Angular mil (NATO definition, 6400 mil = 2PI radians)

Available as QgsUnitTypes.AngleMilNATO in older QGIS releases.
Unknown: Unknown angle unit

Available as QgsUnitTypes.AngleUnknownUnit in older QGIS releases.

class AreaUnit(*values)¶

Bases: IntEnum

Units of area

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.AreaUnit.

Added in version 3.30.

SquareMeters: Square meters

Available as QgsUnitTypes.AreaSquareMeters in older QGIS releases.
SquareKilometers: Square kilometers

Available as QgsUnitTypes.AreaSquareKilometers in older QGIS releases.
SquareFeet: Square feet

Available as QgsUnitTypes.AreaSquareFeet in older QGIS releases.
SquareYards: Square yards

Available as QgsUnitTypes.AreaSquareYards in older QGIS releases.
SquareMiles: Square miles

Available as QgsUnitTypes.AreaSquareMiles in older QGIS releases.
Hectares: Hectares

Available as QgsUnitTypes.AreaHectares in older QGIS releases.
Acres: Acres

Available as QgsUnitTypes.AreaAcres in older QGIS releases.
SquareNauticalMiles: Square nautical miles

Available as QgsUnitTypes.AreaSquareNauticalMiles in older QGIS releases.
SquareDegrees: Square degrees, for planar geographic CRS area measurements

Available as QgsUnitTypes.AreaSquareDegrees in older QGIS releases.
SquareCentimeters: Square centimeters

Available as QgsUnitTypes.AreaSquareCentimeters in older QGIS releases.
SquareMillimeters: Square millimeters

Available as QgsUnitTypes.AreaSquareMillimeters in older QGIS releases.
SquareInches: Square inches

Added in version 3.32.
Unknown: Unknown areal unit

Available as QgsUnitTypes.AreaUnknownUnit in older QGIS releases.

class AreaValue¶

Bases: object

A combination of area value and unit.

unit: AreaUnit¶: The value part of the distance. For 3.7 square meters, this will be QgsUnitTypes.AreaSquareMeters.

value: float¶: The value part of the distance. For 3.7 square meters, this will be 3.7.

class DistanceUnit(*values)¶

Bases: IntEnum

Units of distance

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.DistanceUnit.

Added in version 3.30.

Meters: Meters

Available as QgsUnitTypes.DistanceMeters in older QGIS releases.
Kilometers: Kilometers

Available as QgsUnitTypes.DistanceKilometers in older QGIS releases.
Feet: Imperial feet

Available as QgsUnitTypes.DistanceFeet in older QGIS releases.
NauticalMiles: Nautical miles

Available as QgsUnitTypes.DistanceNauticalMiles in older QGIS releases.
Yards: Imperial yards

Available as QgsUnitTypes.DistanceYards in older QGIS releases.
Miles: Terrestrial miles

Available as QgsUnitTypes.DistanceMiles in older QGIS releases.
Degrees: Degrees, for planar geographic CRS distance measurements

Available as QgsUnitTypes.DistanceDegrees in older QGIS releases.
Centimeters: Centimeters

Available as QgsUnitTypes.DistanceCentimeters in older QGIS releases.
Millimeters: Millimeters

Available as QgsUnitTypes.DistanceMillimeters in older QGIS releases.
Inches: Inches

Added in version 3.32.
ChainsInternational: International chains

Added in version 3.40.
ChainsBritishBenoit1895A: British chains (Benoit 1895 A)

Added in version 3.40.
ChainsBritishBenoit1895B: British chains (Benoit 1895 B)

Added in version 3.40.
ChainsBritishSears1922Truncated: British chains (Sears 1922 truncated)

Added in version 3.40.
ChainsBritishSears1922: British chains (Sears 1922)

Added in version 3.40.
ChainsClarkes: Clarke’s chains

Added in version 3.40.
ChainsUSSurvey: US Survey chains

Added in version 3.40.
FeetBritish1865: British feet (1865)

Added in version 3.40.
FeetBritish1936: British feet (1936)

Added in version 3.40.
FeetBritishBenoit1895A: British feet (Benoit 1895 A)

Added in version 3.40.
FeetBritishBenoit1895B: British feet (Benoit 1895 B)

Added in version 3.40.
FeetBritishSears1922Truncated: British feet (Sears 1922 truncated)

Added in version 3.40.
FeetBritishSears1922: British feet (Sears 1922)

Added in version 3.40.
FeetClarkes: Clarke’s feet

Added in version 3.40.
FeetGoldCoast: Gold Coast feet

Added in version 3.40.
FeetIndian: Indian (geodetic) feet

Added in version 3.40.
FeetIndian1937: Indian feet (1937)

Added in version 3.40.
FeetIndian1962: Indian feet (1962)

Added in version 3.40.
FeetIndian1975: Indian feet (1975)

Added in version 3.40.
FeetUSSurvey: US Survey feet

Added in version 3.40.
LinksInternational: International links

Added in version 3.40.
LinksBritishBenoit1895A: British links (Benoit 1895 A)

Added in version 3.40.
LinksBritishBenoit1895B: British links (Benoit 1895 B)

Added in version 3.40.
LinksBritishSears1922Truncated: British links (Sears 1922 truncated)

Added in version 3.40.
LinksBritishSears1922: British links (Sears 1922)

Added in version 3.40.
LinksClarkes: Clarke’s links

Added in version 3.40.
LinksUSSurvey: US Survey links

Added in version 3.40.
YardsBritishBenoit1895A: British yards (Benoit 1895 A)

Added in version 3.40.
YardsBritishBenoit1895B: British yards (Benoit 1895 B)

Added in version 3.40.
YardsBritishSears1922Truncated: British yards (Sears 1922 truncated)

Added in version 3.40.
YardsBritishSears1922: British yards (Sears 1922)

Added in version 3.40.
YardsClarkes: Clarke’s yards

Added in version 3.40.
YardsIndian: Indian yards

Added in version 3.40.
YardsIndian1937: Indian yards (1937)

Added in version 3.40.
YardsIndian1962: Indian yards (1962)

Added in version 3.40.
YardsIndian1975: Indian yards (1975)

Added in version 3.40.
MilesUSSurvey: US Survey miles

Added in version 3.40.
Fathoms: Fathoms

Added in version 3.40.
MetersGermanLegal: German legal meter

Added in version 3.40.
Unknown: Unknown distance unit

Available as QgsUnitTypes.DistanceUnknownUnit in older QGIS releases.

class DistanceUnitType(*values)¶

Bases: IntEnum

Types of distance units

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.DistanceUnitType.

Added in version 3.30.

Standard: Unit is a standard measurement unit
Geographic: Unit is a geographic (e.g., degree based) unit
Unknown: Unknown unit type

Available as QgsUnitTypes.UnknownType in older QGIS releases.

class DistanceValue¶

Bases: object

A combination of distance value and unit.

unit: DistanceUnit¶: The value part of the distance. For 3.7 meters, this will be QgsUnitTypes.DistanceMeters.

value: float¶: The value part of the distance. For 3.7 meters, this will be 3.7.

class LayoutUnit(*values)¶

Bases: IntEnum

Layout measurement units

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.LayoutUnit.

Added in version 3.30.

Millimeters: Millimeters

Available as QgsUnitTypes.LayoutMillimeters in older QGIS releases.
Centimeters: Centimeters

Available as QgsUnitTypes.LayoutCentimeters in older QGIS releases.
Meters: Meters

Available as QgsUnitTypes.LayoutMeters in older QGIS releases.
Inches: Inches

Available as QgsUnitTypes.LayoutInches in older QGIS releases.
Feet: Feet

Available as QgsUnitTypes.LayoutFeet in older QGIS releases.
Points: Typographic points

Available as QgsUnitTypes.LayoutPoints in older QGIS releases.
Picas: Typographic picas

Available as QgsUnitTypes.LayoutPicas in older QGIS releases.
Pixels: Pixels

Available as QgsUnitTypes.LayoutPixels in older QGIS releases.

class LayoutUnitType(*values)¶

Bases: IntEnum

Types of layout units

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.LayoutUnitType.

Added in version 3.30.

PaperUnits: Unit is a paper based measurement unit

Available as QgsUnitTypes.LayoutPaperUnits in older QGIS releases.
ScreenUnits: Unit is a screen based measurement unit

Available as QgsUnitTypes.LayoutScreenUnits in older QGIS releases.

class RenderUnit(*values)¶

Bases: IntEnum

Rendering size units

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.RenderUnit.

Added in version 3.30.

Millimeters: Millimeters

Available as QgsUnitTypes.RenderMillimeters in older QGIS releases.
MapUnits: Map units

Available as QgsUnitTypes.RenderMapUnits in older QGIS releases.
Pixels: Pixels

Available as QgsUnitTypes.RenderPixels in older QGIS releases.
Percentage: Percentage of another measurement (e.g., canvas size, feature size)

Available as QgsUnitTypes.RenderPercentage in older QGIS releases.
Points: Points (e.g., for font sizes)

Available as QgsUnitTypes.RenderPoints in older QGIS releases.
Inches: Inches

Available as QgsUnitTypes.RenderInches in older QGIS releases.
Unknown: Mixed or unknown units

Available as QgsUnitTypes.RenderUnknownUnit in older QGIS releases.
MetersInMapUnits: Meters value as Map units

Available as QgsUnitTypes.RenderMetersInMapUnits in older QGIS releases.

class SystemOfMeasurement(*values)¶

Bases: IntEnum

Systems of unit measurement.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.SystemOfMeasurement.

Added in version 3.30.

Unknown: Unknown system of measurement

Available as QgsUnitTypes.UnknownSystem in older QGIS releases.
Metric: International System of Units (SI)

Available as QgsUnitTypes.MetricSystem in older QGIS releases.
Imperial: British Imperial

Available as QgsUnitTypes.ImperialSystem in older QGIS releases.
USCS: United States customary system

Available as QgsUnitTypes.USCSSystem in older QGIS releases.

class TemporalUnit(*values)¶

Bases: IntEnum

Temporal units.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.TemporalUnit.

Added in version 3.30.

Milliseconds: Milliseconds

Available as QgsUnitTypes.TemporalMilliseconds in older QGIS releases.
Seconds: Seconds

Available as QgsUnitTypes.TemporalSeconds in older QGIS releases.
Minutes: Minutes

Available as QgsUnitTypes.TemporalMinutes in older QGIS releases.
Hours: Hours

Available as QgsUnitTypes.TemporalHours in older QGIS releases.
Days: Days

Available as QgsUnitTypes.TemporalDays in older QGIS releases.
Weeks: Weeks

Available as QgsUnitTypes.TemporalWeeks in older QGIS releases.
Months: Months

Available as QgsUnitTypes.TemporalMonths in older QGIS releases.
Years: Years

Available as QgsUnitTypes.TemporalYears in older QGIS releases.
Decades: Decades

Available as QgsUnitTypes.TemporalDecades in older QGIS releases.
Centuries: Centuries

Available as QgsUnitTypes.TemporalCenturies in older QGIS releases.
IrregularStep: Special ‘irregular step’ time unit, used for temporal data which uses irregular, non-real-world unit steps

Added in version 3.20.

Available as QgsUnitTypes.TemporalIrregularStep in older QGIS releases.
Unknown: Unknown time unit

Available as QgsUnitTypes.TemporalUnknownUnit in older QGIS releases.

class UnitType(*values)¶

Bases: IntEnum

Unit types.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.UnitType.

Added in version 3.30.

Distance: Distance unit

Available as QgsUnitTypes.TypeDistance in older QGIS releases.
Area: Area unit

Available as QgsUnitTypes.TypeArea in older QGIS releases.
Volume: Volume unit

Available as QgsUnitTypes.TypeVolume in older QGIS releases.
Unknown: Unknown unit type

Available as QgsUnitTypes.TypeUnknown in older QGIS releases.
Temporal: Temporal unit

Available as QgsUnitTypes.TypeTemporal in older QGIS releases.

class VolumeUnit(*values)¶

Bases: IntEnum

Units of volume.

Note

Prior to QGIS 3.30 this was available as QgsUnitTypes.VolumeUnit.

Added in version 3.30.

CubicMeters: Cubic meters

Available as QgsUnitTypes.VolumeCubicMeters in older QGIS releases.
CubicFeet: Cubic feet

Available as QgsUnitTypes.VolumeCubicFeet in older QGIS releases.
CubicYards: Cubic yards

Available as QgsUnitTypes.VolumeCubicYards in older QGIS releases.
Barrel: Barrels

Available as QgsUnitTypes.VolumeBarrel in older QGIS releases.
CubicDecimeter: Cubic decimeters

Available as QgsUnitTypes.VolumeCubicDecimeter in older QGIS releases.
Liters: Litres

Available as QgsUnitTypes.VolumeLiters in older QGIS releases.
GallonUS: US Gallons

Available as QgsUnitTypes.VolumeGallonUS in older QGIS releases.
CubicInch: Cubic inches

Available as QgsUnitTypes.VolumeCubicInch in older QGIS releases.
CubicCentimeter: Cubic Centimeters

Available as QgsUnitTypes.VolumeCubicCentimeter in older QGIS releases.
CubicDegrees: Cubic degrees, for planar geographic CRS volume measurements

Available as QgsUnitTypes.VolumeCubicDegrees in older QGIS releases.
Unknown: Unknown volume unit

Available as QgsUnitTypes.VolumeUnknownUnit in older QGIS releases.

static areaToDistanceUnit(areaUnit: Qgis.AreaUnit) → Qgis.DistanceUnit[source]¶

Converts an area unit to its corresponding distance unit, e.g., square meters to meters

Parameters:: areaUnit (Qgis.AreaUnit) – area unit to convert
Return type:: Qgis.DistanceUnit
Returns:: matching distance unit

Added in version 3.10.

static decodeAngleUnit(string: str | None)[source]¶

Decodes an angular unit from a string.

Parameters:

string (Optional[str]) -> (Qgis.AngleUnit) – string to decode

Returns:

decoded units
ok: boolean, True if string was converted successfully

See also

encodeUnit()

static decodeAreaUnit(string: str | None)[source]¶

Decodes an areal unit from a string.

Parameters:

string (Optional[str]) -> (Qgis.AreaUnit) – string to decode

Returns:

decoded units
ok: boolean, True if string was converted successfully

See also

encodeUnit()

static decodeDistanceUnit(string: str | None)[source]¶

Decodes a distance unit from a string.

Parameters:

string (Optional[str]) -> (Qgis.DistanceUnit) – string to decode

Returns:

decoded units
ok: boolean, True if string was converted successfully

See also

encodeUnit()

static decodeLayoutUnit(string: str | None)[source]¶

Decodes a layout unit from a string.

Parameters:

string (Optional[str]) -> (Qgis.LayoutUnit) – string to decode

Returns:

decoded units
ok: boolean, True if string was converted successfully

See also

encodeUnit()

static decodeRenderUnit(string: str | None)[source]¶

Decodes a render unit from a string.

Parameters:

string (Optional[str]) -> (Qgis.RenderUnit) – string to decode

Returns:

decoded units
ok: boolean, True if string was converted successfully

See also

encodeUnit()

static decodeTemporalUnit(string: str | None)[source]¶

Decodes a temporal unit from a string.

Parameters:

string (Optional[str]) -> (Qgis.TemporalUnit) – string to decode

Returns:

decoded units
ok: boolean, True if string was converted successfully

See also

encodeUnit()

Added in version 3.14.

static decodeUnitType(string: str | None)[source]¶

Decodes a unit type from a string.

Parameters:

string (Optional[str]) -> (Qgis.UnitType) – string to decode

Returns:

decoded unit type
ok: boolean, True if string was converted successfully

See also

encodeUnitType()

Added in version 3.10.

static decodeVolumeUnit(string: str | None)[source]¶

Decodes a volume unit from a string.

Parameters:

string (Optional[str]) -> (Qgis.VolumeUnit) – string to decode

Returns:

decoded units
ok: boolean, True if string was converted successfully

See also

encodeUnit()

Added in version 3.10.

static distanceToAreaUnit(distanceUnit: Qgis.DistanceUnit) → Qgis.AreaUnit[source]¶

Converts a distance unit to its corresponding area unit, e.g., meters to square meters

Parameters:: distanceUnit (Qgis.DistanceUnit) – distance unit to convert
Return type:: Qgis.AreaUnit
Returns:: matching areal unit

static distanceToVolumeUnit(distanceUnit: Qgis.DistanceUnit) → Qgis.VolumeUnit[source]¶

Converts a distance unit to its corresponding volume unit, e.g., meters to cubic meters

Parameters:: distanceUnit (Qgis.DistanceUnit) – distance unit to convert
Return type:: Qgis.VolumeUnit
Returns:: matching volume unit

Added in version 3.10.

static encodeUnit(unit: Qgis.DistanceUnit) → str[source]¶

Encodes a distance unit to a string.

Parameters:: unit (Qgis.DistanceUnit) – unit to encode
Return type:: str
Returns:: encoded string

See also

decodeDistanceUnit()

static encodeUnit(unit: Qgis.AreaUnit) → str[source]

Encodes an areal unit to a string.

Parameters:: unit (Qgis.AreaUnit) – unit to encode
Return type:: str
Returns:: encoded string

See also

decodeAreaUnit()

static encodeUnit(unit: Qgis.TemporalUnit) → str[source]

Encodes a temporal unit to a string.

Return type:: str
Returns:: encoded string

See also

decodeTemporalUnit()

Added in version 3.14.

Parameters:: unit (Qgis.TemporalUnit)

static encodeUnit(unit: Qgis.VolumeUnit) → str[source]

Encodes a volume unit to a string.

Return type:: str
Returns:: encoded string

See also

decodeVolumeUnit()

Added in version 3.10.

Parameters:: unit (Qgis.VolumeUnit)

static encodeUnit(unit: Qgis.AngleUnit) → str[source]

Encodes an angular unit to a string.

Parameters:: unit (Qgis.AngleUnit) – unit to encode
Return type:: str
Returns:: encoded string

See also

decodeAngleUnit()

static encodeUnit(unit: Qgis.RenderUnit) → str[source]

Encodes a render unit to a string.

Parameters:: unit (Qgis.RenderUnit) – unit to encode
Return type:: str
Returns:: encoded string

See also

decodeRenderUnit()

static encodeUnit(unit: Qgis.LayoutUnit) → str[source]

Encodes a layout unit to a string.

Parameters:: unit (Qgis.LayoutUnit) – unit to encode
Return type:: str
Returns:: encoded string

See also

decodeLayoutUnit()

static encodeUnitType(type: Qgis.UnitType) → str[source]¶

Encodes a unit type to a string.

Return type:: str
Returns:: encoded string

See also

decodeUnitType()

Added in version 3.10.

Parameters:: type (Qgis.UnitType)

static formatAngle(angle: float, decimals: int, unit: Qgis.AngleUnit) → str[source]¶

Returns an angle formatted as a friendly string.

Parameters:

angle (float) – angle to format
decimals (int) – number of decimal places to show. A value of -1 indicates that an appropriate number of decimal places should automatically be selected.
unit (Qgis.AngleUnit) – unit of angle

Return type:

str

Returns:

formatted angle string

static formatArea(area: float, decimals: int, unit: Qgis.AreaUnit, keepBaseUnit: bool = False) → str[source]¶

Returns an area formatted as a friendly string.

Parameters:

area (float) – area to format
decimals (int) – number of decimal places to show
unit (Qgis.AreaUnit) – unit of area
keepBaseUnit (bool = False) – set to False to allow conversion of large areas to more suitable units, e.g., square meters to square kilometers

Return type:

str

Returns:

formatted area string

See also

formatDistance()

static formatDistance(distance: float, decimals: int, unit: Qgis.DistanceUnit, keepBaseUnit: bool = False) → str[source]¶

Returns an distance formatted as a friendly string.

Parameters:

distance (float) – distance to format
decimals (int) – number of decimal places to show
unit (Qgis.DistanceUnit) – unit of distance
keepBaseUnit (bool = False) – set to False to allow conversion of large distances to more suitable units, e.g., meters to kilometers

Return type:

str

Returns:

formatted distance string

See also

formatArea()

static fromUnitToUnitFactor(fromUnit: Qgis.DistanceUnit, toUnit: Qgis.DistanceUnit) → float[source]¶

Returns the conversion factor between the specified distance units.

Parameters:

fromUnit (Qgis.DistanceUnit) – distance unit to convert from
toUnit (Qgis.DistanceUnit) – distance unit to convert to

Return type:

float

Returns:

multiplication factor to convert between units

static fromUnitToUnitFactor(fromUnit: Qgis.AreaUnit, toUnit: Qgis.AreaUnit) → float[source]

Returns the conversion factor between the specified areal units.

Parameters:

fromUnit (Qgis.AreaUnit) – area unit to convert from
toUnit (Qgis.AreaUnit) – area unit to convert to

Return type:

float

Returns:

multiplication factor to convert between units

static fromUnitToUnitFactor(fromUnit: Qgis.TemporalUnit, toUnit: Qgis.TemporalUnit) → float[source]

Returns the conversion factor between the specified temporal units.

Note

Conversion to or from month units assumes a 30 day month length.

Note

Conversion to or from year based units assumes a 365.25 day year length.

Parameters:

fromUnit (Qgis.TemporalUnit) – temporal unit to convert from
toUnit (Qgis.TemporalUnit) – temporal unit to convert to

Return type:

float

Returns:

multiplication factor to convert between units

Added in version 3.14.

static fromUnitToUnitFactor(fromUnit: Qgis.VolumeUnit, toUnit: Qgis.VolumeUnit) → float[source]

Returns the conversion factor between the specified volume units.

Parameters:

fromUnit (Qgis.VolumeUnit) – volume unit to convert from
toUnit (Qgis.VolumeUnit) – volume unit to convert to

Return type:

float

Returns:

multiplication factor to convert between units

Added in version 3.10.

static fromUnitToUnitFactor(fromUnit: Qgis.AngleUnit, toUnit: Qgis.AngleUnit) → float[source]

Returns the conversion factor between the specified angular units.

Parameters:

fromUnit (Qgis.AngleUnit) – angle unit to convert from
toUnit (Qgis.AngleUnit) – angle unit to convert to

Return type:

float

Returns:

multiplication factor to convert between units

static scaledArea(area: float, unit: Qgis.AreaUnit, decimals: int, keepBaseUnit: bool = False) → QgsUnitTypes.AreaValue[source]¶

Will convert an area with a given unit to an area value which is nice to display. It will convert between different units (e.g. from square meters to square kilometers) if appropriate, unless forced otherwise with keepBaseUnit. The value will also be rounded to decimals (be prepared that the returned value is still a double so it will require further formatting when converting to a string).

Parameters:

area (float)
unit (Qgis.AreaUnit)
decimals (int)
keepBaseUnit (bool = False)

Return type:

QgsUnitTypes.AreaValue

static scaledDistance(distance: float, unit: Qgis.DistanceUnit, decimals: int, keepBaseUnit: bool = False) → QgsUnitTypes.DistanceValue[source]¶

Will convert a distance with a given unit to a distance value which is nice to display. It will convert between different units (e.g. from meters to kilometers or millimeters) if appropriate, unless forced otherwise with keepBaseUnit. The value will also be rounded to decimals (be prepared that the returned value is still a double so it will require further formatting when converting to a string).

Parameters:

distance (float)
unit (Qgis.DistanceUnit)
decimals (int)
keepBaseUnit (bool = False)

Return type:

QgsUnitTypes.DistanceValue

static stringToAreaUnit(string: str | None)[source]¶

Converts a translated string to an areal unit.

Parameters:

string (Optional[str]) -> (Qgis.AreaUnit) – string representing an areal unit

Returns:

the area unit
ok: boolean, True if string was converted successfully

See also

toString()

static stringToDistanceUnit(string: str | None)[source]¶

Converts a translated string to a distance unit.

Parameters:

string (Optional[str]) -> (Qgis.DistanceUnit) – string representing a distance unit

Returns:

the distance unit
ok: boolean, True if string was converted successfully

See also

toString()

static stringToTemporalUnit(string: str | None)[source]¶

Converts a translated string to a temporal unit.

Parameters:

string (Optional[str]) -> (Qgis.TemporalUnit) – string representing a volume unit

Returns:

the temporal unit
ok: boolean, True if string was converted successfully

See also

toString()

Added in version 3.14.

static stringToVolumeUnit(string: str | None)[source]¶

Converts a translated string to a volume unit.

Parameters:

string (Optional[str]) -> (Qgis.VolumeUnit) – string representing a volume unit

Returns:

the volume unit
ok: boolean, True if string was converted successfully

See also

toString()

Added in version 3.10.

static toAbbreviatedString(unit: Qgis.DistanceUnit) → str[source]¶

Returns a translated abbreviation representing a distance unit.

Parameters:: unit (Qgis.DistanceUnit) – unit to convert to string

See also

stringToDistanceUnit()

Return type:: str

static toAbbreviatedString(unit: Qgis.AreaUnit) → str[source]

Returns a translated abbreviation representing an areal unit.

Parameters:: unit (Qgis.AreaUnit) – unit to convert to string

See also

stringToAreaUnit()

Return type:: str

static toAbbreviatedString(unit: Qgis.TemporalUnit) → str[source]

Returns a translated abbreviation representing a temporal unit.

See also

stringToTemporalUnit()

Added in version 3.14.

Parameters:: unit (Qgis.TemporalUnit)
Return type:: str

static toAbbreviatedString(unit: Qgis.VolumeUnit) → str[source]

Returns a translated abbreviation representing a volume unit.

See also

stringToVolumeUnit()

Added in version 3.10.

Parameters:: unit (Qgis.VolumeUnit)
Return type:: str

static toAbbreviatedString(unit: Qgis.RenderUnit) → str[source]

Returns a translated abbreviation representing a render unit.

Parameters:: unit (Qgis.RenderUnit) – unit to convert to string

Added in version 3.8.

Return type:: str

static toAbbreviatedString(unit: Qgis.LayoutUnit) → str[source]

Returns a translated abbreviation representing a layout unit (e.g. “mm”).

Parameters:: unit (Qgis.LayoutUnit)
Return type:: str

static toString(unit: Qgis.DistanceUnit) → str[source]¶

Returns a translated string representing a distance unit.

Parameters:: unit (Qgis.DistanceUnit) – unit to convert to string

See also

stringToDistanceUnit()

Return type:: str

static toString(unit: Qgis.AreaUnit) → str[source]

Returns a translated string representing an areal unit.

Parameters:: unit (Qgis.AreaUnit) – unit to convert to string

See also

stringToAreaUnit()

Return type:: str

static toString(unit: Qgis.TemporalUnit) → str[source]

Returns a translated string representing a temporal unit.

See also

stringToTemporalUnit()

Added in version 3.14.

Parameters:: unit (Qgis.TemporalUnit)
Return type:: str

static toString(unit: Qgis.VolumeUnit) → str[source]

Returns a translated string representing a volume unit.

See also

stringToVolumeUnit()

Added in version 3.10.

Parameters:: unit (Qgis.VolumeUnit)
Return type:: str

static toString(unit: Qgis.AngleUnit) → str[source]

Returns a translated string representing an angular unit.

Parameters:: unit (Qgis.AngleUnit) – unit to convert to string
Return type:: str

static toString(unit: Qgis.RenderUnit) → str[source]

Returns a translated string representing a render unit.

Parameters:: unit (Qgis.RenderUnit)
Return type:: str

static toString(unit: Qgis.LayoutUnit) → str[source]

Returns a translated string representing a layout unit.

Parameters:: unit (Qgis.LayoutUnit)
Return type:: str

static unitType(unit: Qgis.DistanceUnit) → Qgis.DistanceUnitType[source]¶

Returns the type for a distance unit.

Parameters:: unit (Qgis.DistanceUnit)
Return type:: Qgis.DistanceUnitType

static unitType(unit: Qgis.AreaUnit) → Qgis.DistanceUnitType[source]

Returns the type for an areal unit.

Parameters:: unit (Qgis.AreaUnit)
Return type:: Qgis.DistanceUnitType

static unitType(unit: Qgis.VolumeUnit) → Qgis.DistanceUnitType[source]

Returns the type for an volume unit.

Added in version 3.10.

Parameters:: unit (Qgis.VolumeUnit)
Return type:: Qgis.DistanceUnitType

static unitType(units: Qgis.LayoutUnit) → Qgis.LayoutUnitType[source]

Returns the type for a unit of measurement.

Parameters:: units (Qgis.LayoutUnit)
Return type:: Qgis.LayoutUnitType

static volumeToDistanceUnit(volumeUnit: Qgis.VolumeUnit) → Qgis.DistanceUnit[source]¶

Converts a volume unit to its corresponding distance unit, e.g., cubic meters to meters

Parameters:: volumeUnit (Qgis.VolumeUnit) – volume unit to convert
Return type:: Qgis.DistanceUnit
Returns:: matching distance unit

Added in version 3.10.