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

api.measurements

This API gives access ot the measurements that are associated with a session. Saved measurements are automatically loaded when a point cloud is loaded into the viewer.

Most methods and events will require, or return, an ID for each measurement. The ID is auto-generated when the measurement is created and will be retained across sessions if saved.

Hierarchy

  • MeasurementAPI

Index

Properties

Methods

Object literals

Properties

added

added: EventEmitter = new EventEmitter()

pointAdded

pointAdded: EventEmitter = new EventEmitter()

pointChanged

pointChanged: EventEmitter = new EventEmitter()

pointDeleted

pointDeleted: EventEmitter = new EventEmitter()

Methods

count

  • count(): number

  • Total number of measurements in the current session. This includes temporary and saved measurements, and also includes both 3D and scanview created measurements.

    Returns number

delete

  • delete(id: string): void

  • Parameters

    • id: string

    Returns void

exportKmlString

  • exportKmlString(filename?: string): Promise<boolean>

  • Parameters

    • Optional filename: string

    Returns Promise<boolean>

exportToCsv

  • exportToCsv(options: { filename?: any; includeHeader?: any; includeWgs84?: any }): Promise<boolean>

  • Parameters

    • options: { filename?: any; includeHeader?: any; includeWgs84?: any }
      • Optional filename?: any
      • Optional includeHeader?: any
      • Optional includeWgs84?: any

    Returns Promise<boolean>

getAll

  • getAll(): any

  • Returns any

getCsvString

  • getCsvString(includeHeader?: boolean, includeWgs84?: boolean): Promise<string>

  • Parameters

    • Default value includeHeader: boolean = true
    • Default value includeWgs84: boolean = false

    Returns Promise<string>

getKMLString

  • getKMLString(): Promise<string>

  • Returns Promise<string>

getLabel

  • getLabel(id: string): string

  • Parameters

    • id: string

    Returns string

getPickMode

  • getPickMode(): PickMode

  • Returns PickMode

getProperties

  • getProperties(id: string): { bearingDegrees: any; color: any; distanceMeters: any; id: any; isCulledHorizontally: any; isCulledVertically: any; label: any; layerId: any; mode: any; notes: string; saved: any; type: any; width: any; firstPickedPoint: object; secondPickedPoint: object } | { calculatingMetrics: any; color: any; generatingMesh: any; gridSpacing: any; id: any; isCulledHorizontally: any; isCulledVertically: any; label: any; meshAsWireframe: any; meshDirty: any; meshHeight: any; meshOffset: any; metrics: any; metricsDirty: any; mode: any; notes: string; pickedPoints: any; referenceSurfaceMode: any; referenceSurfaceOptions: any; referenceSurfaceVisible: any; saved: any; topDown: any; type: any; width: any } | { color: any; id: any; label: string; layerId: any; notes: string; type: any; width: any }

  • Parameters

    • id: string

    Returns { bearingDegrees: any; color: any; distanceMeters: any; id: any; isCulledHorizontally: any; isCulledVertically: any; label: any; layerId: any; mode: any; notes: string; saved: any; type: any; width: any; firstPickedPoint: object; secondPickedPoint: object } | { calculatingMetrics: any; color: any; generatingMesh: any; gridSpacing: any; id: any; isCulledHorizontally: any; isCulledVertically: any; label: any; meshAsWireframe: any; meshDirty: any; meshHeight: any; meshOffset: any; metrics: any; metricsDirty: any; mode: any; notes: string; pickedPoints: any; referenceSurfaceMode: any; referenceSurfaceOptions: any; referenceSurfaceVisible: any; saved: any; topDown: any; type: any; width: any } | { color: any; id: any; label: string; layerId: any; notes: string; type: any; width: any }

getSelected

  • getSelected(): string | null

  • Returns string | null

    The ID of the currently selected measurement, or null if there is no selected measurement

hasSelection

  • hasSelection(): boolean

  • Returns boolean

isFiltered

  • isFiltered(id: string): boolean

  • Parameters

    • id: string

    Returns boolean

isSelected

  • isSelected(id: string): boolean

  • Parameters

    • id: string

    Returns boolean

isShowing

  • isShowing(): boolean

  • Returns boolean

    Whether measurements are currently showing in the viewer

reloadMeasurements

  • reloadMeasurements(page?: number): Promise<void>

  • Parameters

    • Default value page: number = 1

    Returns Promise<void>

setColor

  • setColor(cssHexString: string): void

  • Parameters

    • cssHexString: string

    Returns void

setCulledHorizontally

  • setCulledHorizontally(id: string, isCulled: boolean): void

  • Parameters

    • id: string
    • isCulled: boolean

    Returns void

setCulledVertically

  • setCulledVertically(id: string, isCulled: boolean): void

  • Parameters

    • id: string
    • isCulled: boolean

    Returns void

setHighlighted

  • setHighlighted(id: string, isHighlighted: any): any

  • Parameters

    • id: string
    • isHighlighted: any

    Returns any

setLabel

  • setLabel(id: string, label: string): void

  • Parameters

    • id: string
    • label: string

    Returns void

setPickMode

  • setPickMode(mode: PickMode): void

  • Parameters

    • mode: PickMode

    Returns void

setSelected

  • setSelected(id: string): void

  • Parameters

    • id: string

      the ID of the measurement to select

    Returns void

show

  • show(val: boolean): void

  • Parameters

    • val: boolean

      whether to show measurements in the viewer

    Returns void

Object literals

PickMode

PickMode: object

ALL

ALL: PickMode = Measurements.PickMode.ALL

POINTS

POINTS: PickMode = Measurements.PickMode.POINTS

POINTS_AND_TERRAIN

POINTS_AND_TERRAIN: PickMode = Measurements.PickMode.POINTS_AND_TERRAIN

events

events: object

distanceModeChanged

distanceModeChanged: EventEmitter = new EventEmitter()

labelChanged

labelChanged: EventEmitter = new EventEmitter()

measurementDeleted

measurementDeleted: EventEmitter = new EventEmitter()

selectedChanged

selectedChanged: EventEmitter = new EventEmitter()