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

api.poi

Points of Interest are annotations that can have a number of properties associated with them. They are associated with a point cloud and are automatically loaded when a point cloud is loaded into the viewer.

The poi namespace is where you interact with points of interest in the viewer. Most methods and events will require, or return, an ID for each POI. The ID is auto-generated when the POI is loaded into the viewer, and is only relevant for the session. POIs also have a more permanent database ID that can be stored as a key if required

Hierarchy

  • PointOfInterestAPI

Index

Methods

Object literals

Methods

activateTool

  • activateTool(): void

  • Returns void

add

  • add(coord: { x: any; y: any; z: any }, properties?: IPointOfInterestPropertiesBase, apiCreated?: boolean): Promise<string>

  • Parameters

    • coord: { x: any; y: any; z: any }
      • x: any
      • y: any
      • z: any
    • Optional properties: IPointOfInterestPropertiesBase
    • Default value apiCreated: boolean = true

    Returns Promise<string>

animatePoiTransitions

  • animatePoiTransitions(animate: boolean): void

  • Parameters

    • animate: boolean

    Returns void

deactivateTool

  • deactivateTool(): void

  • Returns void

delete

  • delete(id: string): boolean

  • Parameters

    • id: string

    Returns boolean

exportToCsv

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

  • Parameters

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

    Returns boolean

exportToKML

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

  • Parameters

    • Optional filename: string

    Returns Promise<boolean>

findPoiWithDatabaseId

  • findPoiWithDatabaseId(dbId: string): string

  • Parameters

    • dbId: string

    Returns string

findPoiWithLabel

  • findPoiWithLabel(label: string): string

  • Parameters

    • label: string

    Returns string

flyTo

  • flyTo(id: any): void

  • Parameters

    • id: any

    Returns void

getAll

  • getAll(): any

  • Returns any

getCount

  • getCount(): number

  • Returns number

getCsvString

  • getCsvString(includeHeader?: boolean, includeWgs84?: boolean): string

  • Parameters

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

    Returns string

getDisplayMode

  • getDisplayMode(): any

  • Returns any

getFiltered

  • getFiltered(includeSpatialFiltering?: boolean): any

  • Parameters

    • Default value includeSpatialFiltering: boolean = true

    Returns any

getFilteredCount

  • getFilteredCount(includeSpatialFiltering?: boolean): number

  • Parameters

    • Default value includeSpatialFiltering: boolean = true

    Returns number

getHighlighted

  • getHighlighted(): any

  • Returns any

getKMLString

  • getKMLString(): Promise<string>

  • Returns Promise<string>

getPoiLabelFilter

  • getPoiLabelFilter(): any

  • Returns any

getPoiNoTagFilter

  • getPoiNoTagFilter(): any

  • Returns any

getPoiTagFilter

  • getPoiTagFilter(): any

  • Returns any

getProperties

  • getProperties(id: string): { color: any; databaseId: any; ecefCoordinate: any; image_data: any; label: any; layerId: any; link: any; notes: any; tags: any; wgs84Coordinate: any; coordinate: object }

  • Parameters

    • id: string

    Returns { color: any; databaseId: any; ecefCoordinate: any; image_data: any; label: any; layerId: any; link: any; notes: any; tags: any; wgs84Coordinate: any; coordinate: object }

    • color: any
    • databaseId: any
    • ecefCoordinate: any
    • image_data: any
    • label: any
    • layerId: any
    • link: any
    • notes: any
    • tags: any
    • wgs84Coordinate: any
    • coordinate: object
      • x: any
      • y: any
      • z: any

getSelected

  • getSelected(): any

  • Returns any

getSortOrder

  • getSortOrder(): any

  • Returns any

getTagList

  • getTagList(): any

  • Returns any

getTags

  • getTags(id: any): any

  • Parameters

    • id: any

    Returns any

hideEditor

  • hideEditor(): void

  • Returns void

importFromCsvData

  • importFromCsvData(csvData: any, options?: { ensureUniqueLabelsOnAdd?: any }): Promise<{ added: any; dataRead: any; deleted: any; error: any; skipped: any; updated: any }>

  • Parameters

    • csvData: any
    • Optional options: { ensureUniqueLabelsOnAdd?: any }
      • Optional ensureUniqueLabelsOnAdd?: any

    Returns Promise<{ added: any; dataRead: any; deleted: any; error: any; skipped: any; updated: any }>

importFromExcelData

  • importFromExcelData(excelData: any, options?: { ensureUniqueLabelsOnAdd?: boolean; sheetName?: string }): Promise<{ added: any; dataRead: any; deleted: any; error: any; skipped: any; updated: any }>

  • Parameters

    • excelData: any
    • Optional options: { ensureUniqueLabelsOnAdd?: boolean; sheetName?: string }
      • Optional ensureUniqueLabelsOnAdd?: boolean
      • Optional sheetName?: string

    Returns Promise<{ added: any; dataRead: any; deleted: any; error: any; skipped: any; updated: any }>

isActive

  • isActive(): boolean

  • Returns boolean

isShowingPois

  • isShowingPois(): boolean

  • Returns boolean

isVisible

  • isVisible(id: any, includeSpatialFiltering?: boolean): boolean

  • Parameters

    • id: any
    • Default value includeSpatialFiltering: boolean = true

    Returns boolean

reloadPois

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

  • Parameters

    • Default value page: number = 1

    Returns Promise<void>

setColor

  • setColor(id: any, color: any): boolean

  • Parameters

    • id: any
    • color: any

    Returns boolean

setCoordinate

  • setCoordinate(id: any, coord: any): Promise<void>

  • Parameters

    • id: any
    • coord: any

    Returns Promise<void>

setDisplayMode

  • setDisplayMode(m: any): void

  • Parameters

    • m: any

    Returns void

setHighlighted

  • setHighlighted(id: any): void

  • Parameters

    • id: any

    Returns void

setLabel

  • setLabel(id: any, name: any): boolean

  • Parameters

    • id: any
    • name: any

    Returns boolean

setLink

  • setLink(id: any, link: any): boolean

  • Parameters

    • id: any
    • link: any

    Returns boolean

setNotes

  • setNotes(id: any, notes: any): boolean

  • Parameters

    • id: any
    • notes: any

    Returns boolean

setPoiLabelFilter

  • setPoiLabelFilter(filter: string): void

  • Parameters

    • filter: string

    Returns void

setPoiNoTagFilter

  • setPoiNoTagFilter(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

setPoiTagFilter

  • setPoiTagFilter(tags: string[]): void

  • Parameters

    • tags: string[]

    Returns void

setProperties

  • setProperties(id: any, props: any): boolean

  • Parameters

    • id: any
    • props: any

    Returns boolean

setSelected

  • setSelected(id: any): void

  • Parameters

    • id: any

    Returns void

setSortOrder

  • setSortOrder(o: any): void

  • Parameters

    • o: any

    Returns void

setTags

  • setTags(id: any, tags: string[]): boolean

  • Parameters

    • id: any
    • tags: string[]

    Returns boolean

showEditor

  • showEditor(id: any, displayAll?: boolean): void

  • Parameters

    • id: any
    • Default value displayAll: boolean = false

    Returns void

showPois

  • showPois(show: boolean): void

  • Parameters

    • show: boolean

    Returns void

showPropertiesPanel

  • showPropertiesPanel(id: any): void

  • Parameters

    • id: any

    Returns void

toggleShowPois

  • toggleShowPois(): void

  • Returns void

updateViewpoint

  • updateViewpoint(id: any): void

  • Parameters

    • id: any

    Returns void

Object literals

events

events: object

added

added: EventEmitter = new EventEmitter()

changed

changed: EventEmitter = new EventEmitter()

clicked

clicked: EventEmitter = new EventEmitter()

deleted

deleted: EventEmitter = new EventEmitter()

displayChanged

displayChanged: EventEmitter = new EventEmitter()

displayModeChanged

displayModeChanged: EventEmitter = new EventEmitter()

highlighted

highlighted: EventEmitter = new EventEmitter()

loading

loading: EventEmitter = new EventEmitter()

loadingComplete

loadingComplete: EventEmitter = new EventEmitter()

selected

selected: EventEmitter = new EventEmitter()

shiftClicked

shiftClicked: EventEmitter = new EventEmitter()