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

Hierarchy

  • DrawingAPI

Index

Accessors

Methods

Object literals

Accessors

allowExport

  • get allowExport(): boolean

  • Returns boolean

Methods

clearAllLayers

  • clearAllLayers(): void

  • Returns void

createLayer

  • createLayer(name?: string, makeCurrent?: boolean, enabledClipping?: boolean): AnnotationLayer

  • Parameters

    • Default value name: string = null
    • Default value makeCurrent: boolean = false
    • Default value enabledClipping: boolean = false

    Returns AnnotationLayer

createPoint

  • createPoint(definition: PointDefinition, layer?: AnnotationLayer): Promise<PointAnnotation>

  • Parameters

    • definition: PointDefinition
    • Default value layer: AnnotationLayer = null

    Returns Promise<PointAnnotation>

createPolyline

  • createPolyline(definition: PolylineDefinition, layer?: AnnotationLayer): Promise<PolylineAnnotation>

  • Parameters

    • definition: PolylineDefinition
    • Default value layer: AnnotationLayer = null

    Returns Promise<PolylineAnnotation>

getAllLayers

  • getAllLayers(): AnnotationLayer[]

  • Returns AnnotationLayer[]

getCurrentLayer

  • getCurrentLayer(): AnnotationLayer

  • Returns AnnotationLayer

getDefaultLayer

  • getDefaultLayer(): AnnotationLayer

  • Returns AnnotationLayer

getDrawingObjectById

  • getDrawingObjectById(id: string): Annotation

  • Parameters

    • id: string

    Returns Annotation

getDrawingTool

  • getDrawingTool(): AnnotationTool

  • Returns AnnotationTool

getLayer

  • getLayer(layerId: any): AnnotationLayer

  • Parameters

    • layerId: any

    Returns AnnotationLayer

hideAllLayers

  • hideAllLayers(): void

  • Returns void

isShowingDrawings

  • isShowingDrawings(): boolean

  • Returns boolean

layerToGeojson

  • layerToGeojson(layerId: string, options?: Partial<IExportOptions>): Promise<{ features: undefined[]; type: string }>

  • Parameters

    Returns Promise<{ features: undefined[]; type: string }>

layersToGeojson

  • layersToGeojson(layerIds: string[], options?: Partial<IExportOptions>): Promise<any>

  • Parameters

    • layerIds: string[]
    • Default value options: Partial<IExportOptions> = {}

    Returns Promise<any>

reloadDrawings

  • reloadDrawings(): Promise<void>

  • Returns Promise<void>

removeAllLayers

  • removeAllLayers(): void

  • Returns void

removeLayer

  • removeLayer(layer: AnnotationLayer): void

  • Parameters

    • layer: AnnotationLayer

    Returns void

removePolyline

  • removePolyline(polyline: PolylineAnnotation): void

  • Parameters

    • polyline: PolylineAnnotation

    Returns void

saveLayers

  • saveLayers(): Promise<boolean>

  • Returns Promise<boolean>

setCurrentLayer

  • setCurrentLayer(layer: AnnotationLayer): void

  • Parameters

    • layer: AnnotationLayer

    Returns void

setShowDrawings

  • setShowDrawings(show: boolean): void

  • Parameters

    • show: boolean

    Returns void

showAllLayers

  • showAllLayers(): void

  • Returns void

view

  • view(drawingObject: any): void

  • Parameters

    • drawingObject: any

    Returns void

Object literals

events

events: object

annotationAdded

annotationAdded: EventEmitter = new EventEmitter()

annotationRemoved

annotationRemoved: EventEmitter = new EventEmitter()

annotationVisibilityChanged

annotationVisibilityChanged: EventEmitter = new EventEmitter()

currentLayerChanged

currentLayerChanged: EventEmitter = new EventEmitter()

drawModeChanged

drawModeChanged: EventEmitter = new EventEmitter()

layerCreated

layerCreated: EventEmitter = new EventEmitter()

layerRemoved

layerRemoved: EventEmitter = new EventEmitter()

layerVisibilityChanged

layerVisibilityChanged: EventEmitter = new EventEmitter()

loaded

loaded: EventEmitter = new EventEmitter()

loading

loading: EventEmitter = new EventEmitter()

pointAdded

pointAdded: EventEmitter = new EventEmitter()

pointRemoved

pointRemoved: EventEmitter = new EventEmitter()

pointUpdated

pointUpdated: EventEmitter = new EventEmitter()

polylineAdded

polylineAdded: EventEmitter = new EventEmitter()

polylineFinished

polylineFinished: EventEmitter = new EventEmitter()

polylinePointAdded

polylinePointAdded: EventEmitter = new EventEmitter()

polylinePointRemoved

polylinePointRemoved: EventEmitter = new EventEmitter()

polylineRemoved

polylineRemoved: EventEmitter = new EventEmitter()

polylineStarted

polylineStarted: EventEmitter = new EventEmitter()

polylineUpdated

polylineUpdated: EventEmitter = new EventEmitter()

saving

saving: EventEmitter = new EventEmitter()

savingComplete

savingComplete: EventEmitter = new EventEmitter()

selectedAnnotationChanged

selectedAnnotationChanged: EventEmitter = new EventEmitter()

sphereAdded

sphereAdded: EventEmitter = new EventEmitter()

sphereRemoved

sphereRemoved: EventEmitter = new EventEmitter()

sphereUpdated

sphereUpdated: EventEmitter = new EventEmitter()