Options
All
  • Public
  • Public/Protected
  • All
Menu

A reference defines a coordinate system. It minimally defines a set of Axes.

Hierarchy

  • CoordinateReference

Overview

Constructors

Private constructor

Accessors

axisInformation

  • get axisInformation(): { axis: Axis; name: Name }[]
  • Returns an array of axis information object literals that are associated with the coordinate system. Each object contains two properties: the name property refers to the Axis name, the axis property contains an Axis instance containing all the axis' metadata.

    The order of the elements in the array is preserved and can be used to disambiguate the meaning of coordinate tuples, for example (lon,lat) versus (lat,lon) coordinate ordering.

    Note that this information is only relevant when decoding / encoding coordinates in a specific order (for example, when implementing a Codec or when encoding coordinates in a URL). When accessing coordinates through the LuciadRIA's Point.x/y/z, you will never have to take the axis information into account. For example, when using geodetic (lon-lat) coordinates, Point.x will always return the points longitude, regardless what the axes information indicates.

    Returns { axis: Axis; name: Name }[]

    the axis information object literals associated with the coordinate system.

coordinateType

  • The type of coordinate used with this reference.

    Returns CoordinateType

identifier

  • get identifier(): string
  • The identifier of this reference.

    Returns string

name

  • get name(): string
  • The name of this reference.

    Returns string

referenceType

Methods

equals

  • Compares two references for equality.

    Parameters

    • otherReference: CoordinateReference | null

      The other coordinate reference this reference is compared with.

    Returns boolean

    true if the references are equal, false otherwise.

getAxis

  • Retrieves Axis information by a given name. Axis names are defined in the Axis.Name enumeration.

    Parameters

    • axisName: Name

      The name of the axis you want to retrieve

    Returns Axis

    The axis with the corresponding name

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method