User Tools

Site Tools


api:dk11:java:tatukgis.jdk.tgis_csunits.asareal_double_boolean_string

TGIS_CSUnits.AsAreal method

DK11 for Java | tatukgis.jdk.TGIS_CSUnits.AsAreal | Constructors | Methods | Properties

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

Available also on: Delphi | .NET | ActiveX.

Syntax

// Java
public java.lang.String AsAreal(
  double _value,
  bool _prec,
  java.lang.String _format
);
// Oxygene
public
  function AsAreal(
    _value : Double;
    _prec : Boolean;
    _format : String
  ) : String;

Parameters

Name Type Description
_value double
Double
units in base metric
_prec bool
Boolean
if true then fixed decimal digits will be presented; if false then only significant digits (no trailing zeros) will be presented
_format java.lang.String
String
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
java.lang.String
String
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

2020/05/21 01:08

Page Tools