Class: QgsUnitTypes¶
Helper functions for various unit types.
Enums
Units of angles. |
|
Units of area |
|
Units of distance |
|
Types of distance units |
|
Layout measurement units |
|
Types of layout units |
|
Rendering size units |
|
Systems of unit measurement. |
|
Temporal units. |
|
Unit types. |
|
Units of volume. |
Static Methods
Converts an area unit to its corresponding distance unit, e.g., square meters to meters |
|
Decodes an angular unit from a string. |
|
Decodes an areal unit from a string. |
|
Decodes a distance unit from a string. |
|
Decodes a layout unit from a string. |
|
Decodes a render unit from a string. |
|
Decodes a temporal unit from a string. |
|
Decodes a unit type from a string. |
|
Decodes a volume unit from a string. |
|
Converts a distance unit to its corresponding area unit, e.g., meters to square meters |
|
Converts a distance unit to its corresponding volume unit, e.g., meters to cubic meters |
|
Encodes a distance unit to a string. |
|
Encodes a unit type to a string. |
|
Returns an angle formatted as a friendly string. |
|
Returns an area formatted as a friendly string. |
|
Returns an distance formatted as a friendly string. |
|
Returns the conversion factor between the specified distance units. |
|
Will convert an area with a given unit to an area value which is nice to display. |
|
Will convert a distance with a given unit to a distance value which is nice to display. |
|
Converts a translated string to an areal unit. |
|
Converts a translated string to a distance unit. |
|
Converts a translated string to a temporal unit. |
|
Converts a translated string to a volume unit. |
|
Returns a translated abbreviation representing a distance unit. |
|
Returns a translated string representing a distance unit. |
|
Returns the type for a distance unit. |
|
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
: DegreesAvailable as
QgsUnitTypes.AngleDegrees
in older QGIS releases.Radians
: Square kilometersAvailable as
QgsUnitTypes.AngleRadians
in older QGIS releases.Gon
: Gon/gradianAvailable as
QgsUnitTypes.AngleGon
in older QGIS releases.MinutesOfArc
: Minutes of arcAvailable as
QgsUnitTypes.AngleMinutesOfArc
in older QGIS releases.SecondsOfArc
: Seconds of arcAvailable as
QgsUnitTypes.AngleSecondsOfArc
in older QGIS releases.Turn
: Turn/revolutionsAvailable 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 unitAvailable 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 metersAvailable as
QgsUnitTypes.AreaSquareMeters
in older QGIS releases.SquareKilometers
: Square kilometersAvailable as
QgsUnitTypes.AreaSquareKilometers
in older QGIS releases.SquareFeet
: Square feetAvailable as
QgsUnitTypes.AreaSquareFeet
in older QGIS releases.SquareYards
: Square yardsAvailable as
QgsUnitTypes.AreaSquareYards
in older QGIS releases.SquareMiles
: Square milesAvailable as
QgsUnitTypes.AreaSquareMiles
in older QGIS releases.Hectares
: HectaresAvailable as
QgsUnitTypes.AreaHectares
in older QGIS releases.Acres
: AcresAvailable as
QgsUnitTypes.AreaAcres
in older QGIS releases.SquareNauticalMiles
: Square nautical milesAvailable as
QgsUnitTypes.AreaSquareNauticalMiles
in older QGIS releases.SquareDegrees
: Square degrees, for planar geographic CRS area measurementsAvailable as
QgsUnitTypes.AreaSquareDegrees
in older QGIS releases.SquareCentimeters
: Square centimetersAvailable as
QgsUnitTypes.AreaSquareCentimeters
in older QGIS releases.SquareMillimeters
: Square millimetersAvailable as
QgsUnitTypes.AreaSquareMillimeters
in older QGIS releases.SquareInches
: Square inchesAdded in version 3.32.
Unknown
: Unknown areal unitAvailable 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
: MetersAvailable as
QgsUnitTypes.DistanceMeters
in older QGIS releases.Kilometers
: KilometersAvailable as
QgsUnitTypes.DistanceKilometers
in older QGIS releases.Feet
: Imperial feetAvailable as
QgsUnitTypes.DistanceFeet
in older QGIS releases.NauticalMiles
: Nautical milesAvailable as
QgsUnitTypes.DistanceNauticalMiles
in older QGIS releases.Yards
: Imperial yardsAvailable as
QgsUnitTypes.DistanceYards
in older QGIS releases.Miles
: Terrestrial milesAvailable as
QgsUnitTypes.DistanceMiles
in older QGIS releases.Degrees
: Degrees, for planar geographic CRS distance measurementsAvailable as
QgsUnitTypes.DistanceDegrees
in older QGIS releases.Centimeters
: CentimetersAvailable as
QgsUnitTypes.DistanceCentimeters
in older QGIS releases.Millimeters
: MillimetersAvailable as
QgsUnitTypes.DistanceMillimeters
in older QGIS releases.Inches
: InchesAdded in version 3.32.
ChainsInternational
: International chainsAdded 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 chainsAdded in version 3.40.
ChainsUSSurvey
: US Survey chainsAdded 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 feetAdded in version 3.40.
FeetGoldCoast
: Gold Coast feetAdded in version 3.40.
FeetIndian
: Indian (geodetic) feetAdded 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 feetAdded in version 3.40.
LinksInternational
: International linksAdded 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 linksAdded in version 3.40.
LinksUSSurvey
: US Survey linksAdded 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 yardsAdded in version 3.40.
YardsIndian
: Indian yardsAdded 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 milesAdded in version 3.40.
Fathoms
: FathomsAdded in version 3.40.
MetersGermanLegal
: German legal meterAdded in version 3.40.
Unknown
: Unknown distance unitAvailable 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 unitGeographic
: Unit is a geographic (e.g., degree based) unitUnknown
: Unknown unit typeAvailable 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
: MillimetersAvailable as
QgsUnitTypes.LayoutMillimeters
in older QGIS releases.Centimeters
: CentimetersAvailable as
QgsUnitTypes.LayoutCentimeters
in older QGIS releases.Meters
: MetersAvailable as
QgsUnitTypes.LayoutMeters
in older QGIS releases.Inches
: InchesAvailable as
QgsUnitTypes.LayoutInches
in older QGIS releases.Feet
: FeetAvailable as
QgsUnitTypes.LayoutFeet
in older QGIS releases.Points
: Typographic pointsAvailable as
QgsUnitTypes.LayoutPoints
in older QGIS releases.Picas
: Typographic picasAvailable as
QgsUnitTypes.LayoutPicas
in older QGIS releases.Pixels
: PixelsAvailable 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 unitAvailable as
QgsUnitTypes.LayoutPaperUnits
in older QGIS releases.ScreenUnits
: Unit is a screen based measurement unitAvailable 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
: MillimetersAvailable as
QgsUnitTypes.RenderMillimeters
in older QGIS releases.MapUnits
: Map unitsAvailable as
QgsUnitTypes.RenderMapUnits
in older QGIS releases.Pixels
: PixelsAvailable 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
: InchesAvailable as
QgsUnitTypes.RenderInches
in older QGIS releases.Unknown
: Mixed or unknown unitsAvailable as
QgsUnitTypes.RenderUnknownUnit
in older QGIS releases.MetersInMapUnits
: Meters value as Map unitsAvailable 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 measurementAvailable as
QgsUnitTypes.UnknownSystem
in older QGIS releases.Metric
: International System of Units (SI)Available as
QgsUnitTypes.MetricSystem
in older QGIS releases.Imperial
: British ImperialAvailable as
QgsUnitTypes.ImperialSystem
in older QGIS releases.USCS
: United States customary systemAvailable 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
: MillisecondsAvailable as
QgsUnitTypes.TemporalMilliseconds
in older QGIS releases.Seconds
: SecondsAvailable as
QgsUnitTypes.TemporalSeconds
in older QGIS releases.Minutes
: MinutesAvailable as
QgsUnitTypes.TemporalMinutes
in older QGIS releases.Hours
: HoursAvailable as
QgsUnitTypes.TemporalHours
in older QGIS releases.Days
: DaysAvailable as
QgsUnitTypes.TemporalDays
in older QGIS releases.Weeks
: WeeksAvailable as
QgsUnitTypes.TemporalWeeks
in older QGIS releases.Months
: MonthsAvailable as
QgsUnitTypes.TemporalMonths
in older QGIS releases.Years
: YearsAvailable as
QgsUnitTypes.TemporalYears
in older QGIS releases.Decades
: DecadesAvailable as
QgsUnitTypes.TemporalDecades
in older QGIS releases.Centuries
: CenturiesAvailable as
QgsUnitTypes.TemporalCenturies
in older QGIS releases.IrregularStep
: Special ‘irregular step’ time unit, used for temporal data which uses irregular, non-real-world unit stepsAdded in version 3.20.
Available as
QgsUnitTypes.TemporalIrregularStep
in older QGIS releases.Unknown
: Unknown time unitAvailable 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 unitAvailable as
QgsUnitTypes.TypeDistance
in older QGIS releases.Area
: Area unitAvailable as
QgsUnitTypes.TypeArea
in older QGIS releases.Volume
: Volume unitAvailable as
QgsUnitTypes.TypeVolume
in older QGIS releases.Unknown
: Unknown unit typeAvailable as
QgsUnitTypes.TypeUnknown
in older QGIS releases.Temporal
: Temporal unitAvailable 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 metersAvailable as
QgsUnitTypes.VolumeCubicMeters
in older QGIS releases.CubicFeet
: Cubic feetAvailable as
QgsUnitTypes.VolumeCubicFeet
in older QGIS releases.CubicYards
: Cubic yardsAvailable as
QgsUnitTypes.VolumeCubicYards
in older QGIS releases.Barrel
: BarrelsAvailable as
QgsUnitTypes.VolumeBarrel
in older QGIS releases.CubicDecimeter
: Cubic decimetersAvailable as
QgsUnitTypes.VolumeCubicDecimeter
in older QGIS releases.Liters
: LitresAvailable as
QgsUnitTypes.VolumeLiters
in older QGIS releases.GallonUS
: US GallonsAvailable as
QgsUnitTypes.VolumeGallonUS
in older QGIS releases.CubicInch
: Cubic inchesAvailable as
QgsUnitTypes.VolumeCubicInch
in older QGIS releases.CubicCentimeter
: Cubic CentimetersAvailable as
QgsUnitTypes.VolumeCubicCentimeter
in older QGIS releases.CubicDegrees
: Cubic degrees, for planar geographic CRS volume measurementsAvailable as
QgsUnitTypes.VolumeCubicDegrees
in older QGIS releases.Unknown
: Unknown volume unitAvailable 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:
- 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
- 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
- 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
- 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
- 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
- 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
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
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
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:
- 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:
- 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
- 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
- static encodeUnit(unit: Qgis.TemporalUnit) str [source]
Encodes a temporal
unit
to a string.- Return type:
str
- Returns:
encoded string
See also
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
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
- 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
- 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
- static encodeUnitType(type: Qgis.UnitType) str [source]¶
Encodes a unit
type
to a string.- Return type:
str
- Returns:
encoded string
See also
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
- 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
- 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 givenunit
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 withkeepBaseUnit
. The value will also be rounded todecimals
(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:
- static scaledDistance(distance: float, unit: Qgis.DistanceUnit, decimals: int, keepBaseUnit: bool = False) QgsUnitTypes.DistanceValue [source]¶
Will convert a
distance
with a givenunit
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 withkeepBaseUnit
. The value will also be rounded todecimals
(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:
- 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
- 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
- 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
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
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
- 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
- Return type:
str
- static toAbbreviatedString(unit: Qgis.TemporalUnit) str [source]
Returns a translated abbreviation representing a temporal
unit
.See also
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
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
- 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
- Return type:
str
- static toString(unit: Qgis.TemporalUnit) str [source]
Returns a translated string representing a temporal
unit
.See also
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
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:
- static unitType(unit: Qgis.AreaUnit) Qgis.DistanceUnitType [source]
Returns the type for an areal unit.
- Parameters:
unit (Qgis.AreaUnit)
- Return type:
- 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:
- static unitType(units: Qgis.LayoutUnit) Qgis.LayoutUnitType [source]
Returns the type for a unit of measurement.
- Parameters:
units (Qgis.LayoutUnit)
- Return type:
- 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:
- Returns:
matching distance unit
Added in version 3.10.