arcgis-maps-kotlin/com.arcgismaps.geometry/LinearUnit

LinearUnit

class LinearUnit : MeasurementUnit

Defines a linear unit of measurement. The linear unit class is derived from the unit class.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(areaUnit: AreaUnit)

Creates a linear unit given an area unit. Creates a unit given an area unit.

constructor(unitId: LinearUnitId)

Creates a unit given its known id.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val linearUnitId: LinearUnitId

The LinearUnitId of the given Linear unit. If an error occurs then LinearUnitId.Other is returned.

Inherited properties

Link copied to clipboard
val abbreviation: String

The abbreviation of the unit. The abbreviation for a specific unit.

Link copied to clipboard
val displayName: String

The display name of the unit. The display name for a specific unit.

Link copied to clipboard
val name: String

The name of the unit. The name for a specific unit.

Link copied to clipboard
val pluralDisplayName: String

The display name of the unit. The display name for a specific unit.

Link copied to clipboard
val wkid: Int

The well-known ID for the unit, or 0 for a custom unit.

Functions

Link copied to clipboard
fun convertFrom(fromUnit: LinearUnit, value: Double): Double

Converts a value in another UOM into this UOM.

Link copied to clipboard
fun convertTo(toUnit: LinearUnit, value: Double): Double

Converts a value in this UOM into another UOM.

Link copied to clipboard
fun fromMeters(value: Double): Double

Converts a meter value to this UOM.

Link copied to clipboard
fun toMeters(value: Double): Double

Converts a value in this UOM to meters.

Inherited functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int