Pointerra 3D Viewer JavaScript API
Options
All
  • Public
  • Public/Protected
  • All
Menu

api.geospatial

Hierarchy

  • GeospatialAPI

Index

Methods

Methods

clampLongitude

  • clampLongitude(longitudeRadians: number): number

  • Parameters

    • longitudeRadians: number

    Returns number

fromDisplayValue

  • fromDisplayValue(val: number): number

  • Returns the passed in value (in display units) converted to meters

    Parameters

    • val: number

    Returns number

getDisplayUnits

  • getDisplayUnits(): any

  • Returns any

getDistanceMeasurementUnits

  • get the current display units for distance measurements

    Returns DisplayUnits

setDistanceMeasurementUnits

  • Change the display units for distance measurements.

    api.geospatial.setDistanceMeasurementUnits('Centimeters')

    Parameters

    • unitType: DisplayUnits

      (as a string) - method will do nothing if you pass in an invalid unit type

    Returns void

toAreaDisplayUnits

  • toAreaDisplayUnits(meters: number, displayUnits?: DisplayUnits, decimalPlacesOffset?: number): { displayString: string; units: string; value: number; valueText: string }

  • Parameters

    • meters: number
    • Default value displayUnits: DisplayUnits = null
    • Default value decimalPlacesOffset: number = 0

    Returns { displayString: string; units: string; value: number; valueText: string }

    • displayString: string
    • units: string
    • value: number
    • valueText: string

toDegrees

  • toDegrees(val: number): number

  • Parameters

    • val: number

      radians value to convert

    Returns number

toDisplayUnits

  • toDisplayUnits(meters: number, decimalPlacesOffset?: number): { displayString: string; units: string; value: number; valueText: string }

  • Parameters

    • meters: number
    • Default value decimalPlacesOffset: number = 0

    Returns { displayString: string; units: string; value: number; valueText: string }

    • displayString: string
    • units: string
    • value: number
    • valueText: string

toRadians

  • toRadians(val: number): number

  • Parameters

    • val: number

      decimal degrees value to convert

    Returns number

toVolumeDisplayUnits

  • toVolumeDisplayUnits(meters: number, displayUnits?: DisplayUnits, decimalPlacesOffset?: number): { displayString: string; units: string; value: number; valueText: string }

  • Parameters

    • meters: number
    • Default value displayUnits: DisplayUnits = null
    • Default value decimalPlacesOffset: number = 0

    Returns { displayString: string; units: string; value: number; valueText: string }

    • displayString: string
    • units: string
    • value: number
    • valueText: string

transformProjectToWgs84

  • Transform a project coordinate, or array of coordinates, into WGS84 latitude/longitude/height

    Parameters

    Returns Promise<IGeographicPoint | IGeographicPoint[]>

    returned coordinates will be in decimal degrees (height in meters)

transformWgs84ToProject

  • Transform a WGS84 coordinate, or array of coordinates, into the project coordinate system

    let coord = await api.geospatial.transformWgs84ToProject({
    latitude: 45,
    longitude: 100,
    height: 10
})
if (coord) {
    if (coord.isGeographic) {
        // coord will have latitude, longitude and height props
    } else {
        // coord will have x, y, z props
    }
}

    Parameters

    Returns Promise<any>

    Check the isGeographic property of the returned object to determine if the return value is an IGeographicPoint or an ICartesianPoint