User Tools

Site Tools


api:dk11:python:tatukgis.pdk.tgis_csunits.asareal_double_boolean_string

TGIS_CSUnits.AsAreal method

DK11 for Python | tatukgis.pdk.TGIS_CSUnits.AsAreal | Constructors | Methods | Properties

Convert units as areal to string representation with proper units symbol.

Available also on: Delphi | .NET | Java | ActiveX.

Syntax

# Python
def AsAreal(
  self,
  _value: float,
  _prec: bool,
  _format: str
) -> str: 

Parameters

Name Type Description
_value float units in base metric
_prec bool if true then fixed decimal digits will be presented; if false then only significant digits (no trailing zeros) will be presented
_format str hint of how to present linear symbols: for example by providing 'sq. %s' linear symbols will be presented as '1 sq. km'

Result

Type Description
str Units converted to string.

Remarks

Linear units will be autoconverted to areal.
Units of returned string will be autoselected to choose the most adequate is unit is a type of TGIS_CSUnitsType.Auto.

References

2023/08/09 01:53

Page Tools