Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DistanceUnit

An object that represents a unit of distance.

Hierarchy

  • DistanceUnit

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DistanceUnit(name: string, type: string): DistanceUnit

  • Initializes a new instance of the DistanceUnit class.

    Parameters

    • name: string

      The display name of the DistanceUnit.

    • type: string

      A string constant representing the official unit type. See DistanceUnitType for a list of supported units.

    Returns DistanceUnit

Properties

name

name: string

The display name of the {@link geocortex.essentials.DistanceUnit}.

type

type: string

The unit type. One of the available {@link geocortex.essentials.DistanceUnitType}s.

Methods

isLinear

  • isLinear(): boolean

  • Returns true if this distance unit is a known linear (vs. angular) distance unit.

    Returns boolean